Merge pull request #40257 from nextcloud/fix/openapi/comments/ignore

comments: Ignore endpoints in OpenAPI
nextcloud · Sep 5, 2023 · eb1b09d · eb1b09d
2 parents f331d86 + 8f0a35e
commit eb1b09d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 53 deletions.
diff --git a/apps/comments/lib/Controller/NotificationsController.php b/apps/comments/lib/Controller/NotificationsController.php
@@ -25,6 +25,7 @@
 namespace OCA\Comments\Controller;
 
 use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI;
 use OCP\AppFramework\Http\NotFoundResponse;
 use OCP\AppFramework\Http\RedirectResponse;
 use OCP\AppFramework\Http;
@@ -40,6 +41,7 @@
 /**
  * @package OCA\Comments\Controller
  */
+#[IgnoreOpenAPI]
 class NotificationsController extends Controller {
 
 	protected IRootFolder $rootFolder;

diff --git a/apps/comments/openapi.json b/apps/comments/openapi.json
@@ -41,58 +41,6 @@
             }
         }
     },
-    "paths": {
-        "/index.php/apps/comments/notifications/view/{id}": {
-            "get": {
-                "operationId": "notifications-view",
-                "summary": "View a notification",
-                "tags": [
-                    "notifications"
-                ],
-                "security": [
-                    {},
-                    {
-                        "bearer_auth": []
-                    },
-                    {
-                        "basic_auth": []
-                    }
-                ],
-                "parameters": [
-                    {
-                        "name": "id",
-                        "in": "path",
-                        "description": "ID of the notification",
-                        "required": true,
-                        "schema": {
-                            "type": "string"
-                        }
-                    }
-                ],
-                "responses": {
-                    "303": {
-                        "description": "Redirected to notification",
-                        "headers": {
-                            "Location": {
-                                "schema": {
-                                    "type": "string"
-                                }
-                            }
-                        }
-                    },
-                    "404": {
-                        "description": "Notification not found",
-                        "content": {
-                            "text/html": {
-                                "schema": {
-                                    "type": "string"
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    },
+    "paths": {},
     "tags": []
 }