diff options
| author | jld3103 <jld3103yt@gmail.com> | 2023-06-29 07:48:16 +0200 |
|---|---|---|
| committer | jld3103 <jld3103yt@gmail.com> | 2023-07-10 09:20:14 +0200 |
| commit | 58746575dceabd0e7f19fae5ab862203a9bb4df2 (patch) | |
| tree | 931dc185d6e11ec779d5e4e6b197cde3853665d5 /apps/comments/openapi.json | |
| parent | 3fb8aad35bcaff25df7fbd521d4f7fd1f15fdf9e (diff) | |
| download | nextcloud-server-58746575dceabd0e7f19fae5ab862203a9bb4df2.tar.gz nextcloud-server-58746575dceabd0e7f19fae5ab862203a9bb4df2.zip | |
comments: Add OpenAPI spec
Signed-off-by: jld3103 <jld3103yt@gmail.com>
Diffstat (limited to 'apps/comments/openapi.json')
| -rw-r--r-- | apps/comments/openapi.json | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/apps/comments/openapi.json b/apps/comments/openapi.json new file mode 100644 index 00000000000..fcb370bbd4e --- /dev/null +++ b/apps/comments/openapi.json @@ -0,0 +1,98 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "comments", + "version": "0.0.1", + "description": "Files app plugin to add comments to files", + "license": { + "name": "agpl" + } + }, + "components": { + "securitySchemes": { + "basic_auth": { + "type": "http", + "scheme": "basic" + }, + "bearer_auth": { + "type": "http", + "scheme": "bearer" + } + }, + "schemas": { + "Capabilities": { + "type": "object", + "required": [ + "files" + ], + "properties": { + "files": { + "type": "object", + "required": [ + "comments" + ], + "properties": { + "comments": { + "type": "boolean" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + } + }, + "tags": [] +}
\ No newline at end of file |