diff options
| author | Julius Härtl <jus@bitgrid.net> | 2024-02-26 16:30:16 +0100 |
|---|---|---|
| committer | Julius Härtl <jus@bitgrid.net> | 2024-03-05 08:13:58 +0100 |
| commit | c7813bfdaf09626dfed13c63b28a3919018d4403 (patch) | |
| tree | 07d8c13bd7b3628e88f606bbf56db40bfc96e227 /core/openapi.json | |
| parent | 2c9761c73ad1ea51f13103819637fbd315806761 (diff) | |
| download | nextcloud-server-c7813bfdaf09626dfed13c63b28a3919018d4403.tar.gz nextcloud-server-c7813bfdaf09626dfed13c63b28a3919018d4403.zip | |
feat: Implement team provider api
Signed-off-by: Julius Härtl <jus@bitgrid.net>
Diffstat (limited to 'core/openapi.json')
| -rw-r--r-- | core/openapi.json | 225 |
1 files changed, 225 insertions, 0 deletions
diff --git a/core/openapi.json b/core/openapi.json index 2c6b5f28ef2..8bb7beca406 100644 --- a/core/openapi.json +++ b/core/openapi.json @@ -406,6 +406,60 @@ } } }, + "Team": { + "type": "object", + "required": [ + "id", + "name", + "icon" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "icon": { + "type": "string" + } + } + }, + "TeamResource": { + "type": "object", + "required": [ + "id", + "label", + "url", + "iconSvg", + "iconURL", + "iconEmoji" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "label": { + "type": "string" + }, + "url": { + "type": "string" + }, + "iconSvg": { + "type": "string", + "nullable": true + }, + "iconURL": { + "type": "string", + "nullable": true + }, + "iconEmoji": { + "type": "string", + "nullable": true + } + } + }, "TextProcessingTask": { "type": "object", "required": [ @@ -3009,6 +3063,177 @@ } } }, + "/ocs/v2.php/teams/{teamId}/resources": { + "get": { + "operationId": "teams_api-resolve-one", + "summary": "Get all resources of a team", + "tags": [ + "teams_api" + ], + "security": [ + { + "bearer_auth": [] + }, + { + "basic_auth": [] + } + ], + "parameters": [ + { + "name": "teamId", + "in": "path", + "description": "Unique id of the team", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "OCS-APIRequest", + "in": "header", + "description": "Required to be true for the API request to pass", + "required": true, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Resources returned", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "resources" + ], + "properties": { + "resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TeamResource" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "/ocs/v2.php/teams/resources/{providerId}/{resourceId}": { + "get": { + "operationId": "teams_api-list-teams", + "summary": "Get all teams of a resource", + "tags": [ + "teams_api" + ], + "security": [ + { + "bearer_auth": [] + }, + { + "basic_auth": [] + } + ], + "parameters": [ + { + "name": "providerId", + "in": "path", + "description": "Identifier of the provider (e.g. deck, talk, collectives)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceId", + "in": "path", + "description": "Unique id of the resource to list teams for (e.g. deck board id)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "OCS-APIRequest", + "in": "header", + "description": "Required to be true for the API request to pass", + "required": true, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Teams returned", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "ocs" + ], + "properties": { + "ocs": { + "type": "object", + "required": [ + "meta", + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/OCSMeta" + }, + "data": { + "type": "object", + "required": [ + "teams" + ], + "properties": { + "teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Team" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, "/ocs/v2.php/textprocessing/tasktypes": { "get": { "operationId": "text_processing_api-task-types", |