-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #38438 from nextcloud/feature/openapi/specs
Add OpenAPI specs
- Loading branch information
Showing
11 changed files
with
17,011 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,293 @@ | ||
| { | ||
| "openapi": "3.0.3", | ||
| "info": { | ||
| "title": "dashboard", | ||
| "version": "0.0.1", | ||
| "description": "Dashboard app", | ||
| "license": { | ||
| "name": "agpl" | ||
| } | ||
| }, | ||
| "components": { | ||
| "securitySchemes": { | ||
| "basic_auth": { | ||
| "type": "http", | ||
| "scheme": "basic" | ||
| }, | ||
| "bearer_auth": { | ||
| "type": "http", | ||
| "scheme": "bearer" | ||
| } | ||
| }, | ||
| "schemas": { | ||
| "OCSMeta": { | ||
| "type": "object", | ||
| "required": [ | ||
| "status", | ||
| "statuscode" | ||
| ], | ||
| "properties": { | ||
| "status": { | ||
| "type": "string" | ||
| }, | ||
| "statuscode": { | ||
| "type": "integer" | ||
| }, | ||
| "message": { | ||
| "type": "string" | ||
| }, | ||
| "totalitems": { | ||
| "type": "string" | ||
| }, | ||
| "itemsperpage": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "Widget": { | ||
| "type": "object", | ||
| "required": [ | ||
| "id", | ||
| "title", | ||
| "order", | ||
| "icon_class", | ||
| "icon_url", | ||
| "widget_url", | ||
| "item_icons_round" | ||
| ], | ||
| "properties": { | ||
| "id": { | ||
| "type": "string" | ||
| }, | ||
| "title": { | ||
| "type": "string" | ||
| }, | ||
| "order": { | ||
| "type": "integer", | ||
| "format": "int64" | ||
| }, | ||
| "icon_class": { | ||
| "type": "string" | ||
| }, | ||
| "icon_url": { | ||
| "type": "string" | ||
| }, | ||
| "widget_url": { | ||
| "type": "string", | ||
| "nullable": true | ||
| }, | ||
| "item_icons_round": { | ||
| "type": "boolean" | ||
| }, | ||
| "buttons": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "required": [ | ||
| "type", | ||
| "text", | ||
| "link" | ||
| ], | ||
| "properties": { | ||
| "type": { | ||
| "type": "string" | ||
| }, | ||
| "text": { | ||
| "type": "string" | ||
| }, | ||
| "link": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "WidgetItem": { | ||
| "type": "object", | ||
| "required": [ | ||
| "subtitle", | ||
| "title", | ||
| "link", | ||
| "iconUrl", | ||
| "sinceId" | ||
| ], | ||
| "properties": { | ||
| "subtitle": { | ||
| "type": "string" | ||
| }, | ||
| "title": { | ||
| "type": "string" | ||
| }, | ||
| "link": { | ||
| "type": "string" | ||
| }, | ||
| "iconUrl": { | ||
| "type": "string" | ||
| }, | ||
| "sinceId": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "paths": { | ||
| "/ocs/v2.php/apps/dashboard/api/v1/widgets": { | ||
| "get": { | ||
| "operationId": "dashboard_api-get-widgets", | ||
| "summary": "Get the widgets", | ||
| "tags": [ | ||
| "dashboard_api" | ||
| ], | ||
| "security": [ | ||
| { | ||
| "bearer_auth": [] | ||
| }, | ||
| { | ||
| "basic_auth": [] | ||
| } | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "OCS-APIRequest", | ||
| "in": "header", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "string", | ||
| "default": "true" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "type": "object", | ||
| "required": [ | ||
| "ocs" | ||
| ], | ||
| "properties": { | ||
| "ocs": { | ||
| "type": "object", | ||
| "required": [ | ||
| "meta", | ||
| "data" | ||
| ], | ||
| "properties": { | ||
| "meta": { | ||
| "$ref": "#/components/schemas/OCSMeta" | ||
| }, | ||
| "data": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/Widget" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/ocs/v2.php/apps/dashboard/api/v1/widget-items": { | ||
| "get": { | ||
| "operationId": "dashboard_api-get-widget-items", | ||
| "summary": "Get the items for the widgets", | ||
| "tags": [ | ||
| "dashboard_api" | ||
| ], | ||
| "security": [ | ||
| { | ||
| "bearer_auth": [] | ||
| }, | ||
| { | ||
| "basic_auth": [] | ||
| } | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "sinceIds", | ||
| "in": "query", | ||
| "description": "Array indexed by widget Ids, contains date/id from which we want the new items", | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| { | ||
| "name": "limit", | ||
| "in": "query", | ||
| "description": "Limit number of result items per widget", | ||
| "schema": { | ||
| "type": "integer", | ||
| "format": "int64", | ||
| "default": 7 | ||
| } | ||
| }, | ||
| { | ||
| "name": "widgets", | ||
| "in": "query", | ||
| "description": "Limit results to specific widgets", | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| { | ||
| "name": "OCS-APIRequest", | ||
| "in": "header", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "string", | ||
| "default": "true" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "type": "object", | ||
| "required": [ | ||
| "ocs" | ||
| ], | ||
| "properties": { | ||
| "ocs": { | ||
| "type": "object", | ||
| "required": [ | ||
| "meta", | ||
| "data" | ||
| ], | ||
| "properties": { | ||
| "meta": { | ||
| "$ref": "#/components/schemas/OCSMeta" | ||
| }, | ||
| "data": { | ||
| "type": "object", | ||
| "additionalProperties": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/WidgetItem" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "tags": [] | ||
| } |
Oops, something went wrong.