{ "openapi": "3.0.3", "info": { "title": "core", "version": "0.0.1", "description": "Core functionality of Nextcloud", "license": { "name": "agpl" } }, "components": { "securitySchemes": { "basic_auth": { "type": "http", "scheme": "basic" }, "bearer_auth": { "type": "http", "scheme": "bearer" } }, "schemas": { "AutocompleteResult": { "type": "object", "required": [ "id", "label", "icon", "source", "status", "subline", "shareWithDisplayNameUnique" ], "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "icon": { "type": "string" }, "source": { "type": "string" }, "status": { "oneOf": [ { "type": "object", "required": [ "status", "message", "icon", "clearAt" ], "properties": { "status": { "type": "string" }, "message": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "clearAt": { "type": "integer", "format": "int64", "nullable": true } } }, { "type": "string" } ] }, "subline": { "type": "string" }, "shareWithDisplayNameUnique": { "type": "string" } } }, "Collection": { "type": "object", "required": [ "id", "name", "resources" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } } } }, "ContactsAction": { "type": "object", "required": [ "title", "icon", "hyperlink", "appId" ], "properties": { "title": { "type": "string" }, "icon": { "type": "string" }, "hyperlink": { "type": "string" }, "appId": { "type": "string" } } }, "LoginFlowV2": { "type": "object", "required": [ "poll", "login" ], "properties": { "poll": { "type": "object", "required": [ "token", "endpoint" ], "properties": { "token": { "type": "string" }, "endpoint": { "type": "string" } } }, "login": { "type": "string" } } }, "LoginFlowV2Credentials": { "type": "object", "required": [ "server", "loginName", "appPassword" ], "properties": { "server": { "type": "string" }, "loginName": { "type": "string" }, "appPassword": { "type": "string" } } }, "NavigationEntry": { "type": "object", "required": [ "id", "order", "href", "icon", "type", "name", "active", "classes", "unread" ], "properties": { "id": { "type": "string" }, "order": { "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ] }, "href": { "type": "string" }, "icon": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "classes": { "type": "string" }, "unread": { "type": "integer", "format": "int64" } } }, "OCSMeta": { "type": "object", "required": [ "status", "statuscode" ], "properties": { "status": { "type": "string" }, "statuscode": { "type": "integer" }, "message": { "type": "string" }, "totalitems": { "type": "string" }, "itemsperpage": { "type": "string" } } }, "OpenGraphObject": { "type": "object", "required": [ "id", "name", "description", "thumb", "link" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "thumb": { "type": "string", "nullable": true }, "link": { "type": "string" } } }, "Reference": { "type": "object", "required": [ "richObjectType", "richObject", "openGraphObject", "accessible" ], "properties": { "richObjectType": { "type": "string" }, "richObject": { "type": "object", "additionalProperties": { "type": "object" } }, "openGraphObject": { "$ref": "#/components/schemas/OpenGraphObject" }, "accessible": { "type": "boolean" } } }, "ReferenceProvider": { "type": "object", "required": [ "id", "title", "icon_url", "order", "search_providers_ids" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "icon_url": { "type": "string" }, "order": { "type": "integer", "format": "int64" }, "search_providers_ids": { "type": "array", "nullable": true, "items": { "type": "string" } } } }, "Resource": { "type": "object", "required": [ "richObjectType", "richObject", "openGraphObject", "accessible" ], "properties": { "richObjectType": { "type": "string" }, "richObject": { "type": "object", "additionalProperties": { "type": "object" } }, "openGraphObject": { "$ref": "#/components/schemas/OpenGraphObject" }, "accessible": { "type": "boolean" } } }, "Status": { "type": "object", "required": [ "installed", "maintenance", "needsDbUpgrade", "version", "versionstring", "edition", "productname", "extendedSupport" ], "properties": { "installed": { "type": "boolean" }, "maintenance": { "type": "boolean" }, "needsDbUpgrade": { "type": "boolean" }, "version": { "type": "string" }, "versionstring": { "type": "string" }, "edition": { "type": "string" }, "productname": { "type": "string" }, "extendedSupport": { "type": "boolean" } } }, "TextProcessingTask": { "type": "object", "required": [ "id", "type", "status", "userId", "appId", "input", "output", "identifier", "completionExpectedAt" ], "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "type": { "type": "string" }, "status": { "type": "integer", "format": "int64" }, "userId": { "type": "string", "nullable": true }, "appId": { "type": "string" }, "input": { "type": "string" }, "output": { "type": "string", "nullable": true }, "identifier": { "type": "string" }, "completionExpectedAt": { "type": "integer", "format": "int64", "nullable": true } } }, "TextToImageTask": { "type": "object", "required": [ "id", "status", "userId", "appId", "input", "identifier", "numberOfImages", "completionExpectedAt" ], "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "status": { "type": "integer", "format": "int64" }, "userId": { "type": "string", "nullable": true }, "appId": { "type": "string" }, "input": { "type": "string" }, "identifier": { "type": "string", "nullable": true }, "numberOfImages": { "type": "integer", "format": "int64" }, "completionExpectedAt": { "type": "integer", "format": "int64", "nullable": true } } }, "UnifiedSearchProvider": { "type": "object", "required": [ "id", "appId", "name", "icon", "order", "triggers", "filters", "inAppSearch" ], "properties": { "id": { "type": "string" }, "appId": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string" }, "order": { "type": "integer", "format": "int64" }, "triggers": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "inAppSearch": { "type": "boolean" } } }, "UnifiedSearchResult": { "type": "object", "required": [ "name", "isPaginated", "entries", "cursor" ], "properties": { "name": { "type": "string" }, "isPaginated": { "type": "boolean" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/UnifiedSearchResultEntry" } }, "cursor": { "nullable": true, "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ] } } }, "UnifiedSearchResultEntry": { "type": "object", "required": [ "thumbnailUrl", "title", "subline", "resourceUrl", "icon", "rounded", "attributes" ], "properties": { "thumbnailUrl": { "type": "string" }, "title": { "type": "string" }, "subline": { "type": "string" }, "resourceUrl": { "type": "string" }, "icon": { "type": "string" }, "rounded": { "type": "boolean" }, "attributes": { "type": "array", "items": { "type": "string" } } } } } }, "paths": { "/index.php/avatar/{userId}/{size}/dark": { "get": { "operationId": "avatar-get-avatar-dark", "summary": "Get the dark avatar", "tags": [ "avatar" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "userId", "in": "path", "description": "ID of the user", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "path", "description": "Size of the avatar", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Avatar returned", "headers": { "X-NC-IsCustomAvatar": { "schema": { "type": "integer", "format": "int64" } } }, "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Avatar not found", "content": { "application/json": { "schema": {} } } } } } }, "/index.php/avatar/{userId}/{size}": { "get": { "operationId": "avatar-get-avatar", "summary": "Get the avatar", "tags": [ "avatar" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "userId", "in": "path", "description": "ID of the user", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "path", "description": "Size of the avatar", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Avatar returned", "headers": { "X-NC-IsCustomAvatar": { "schema": { "type": "integer", "format": "int64" } } }, "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Avatar not found", "content": { "application/json": { "schema": {} } } } } } }, "/index.php/avatar/guest/{guestName}/{size}/dark": { "get": { "operationId": "guest_avatar-get-avatar-dark", "summary": "Returns a dark guest avatar image response", "tags": [ "guest_avatar" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "guestName", "in": "path", "description": "The guest name, e.g. \"Albert\"", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "path", "description": "The desired avatar size, e.g. 64 for 64x64px", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Custom avatar returned", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "201": { "description": "Avatar returned", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "" } } } }, "/index.php/avatar/guest/{guestName}/{size}": { "get": { "operationId": "guest_avatar-get-avatar", "summary": "Returns a guest avatar image response", "tags": [ "guest_avatar" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "darkTheme", "in": "query", "description": "Return dark avatar", "schema": { "type": "integer", "nullable": true, "default": 0 } }, { "name": "guestName", "in": "path", "description": "The guest name, e.g. \"Albert\"", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "path", "description": "The desired avatar size, e.g. 64 for 64x64px", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Custom avatar returned", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "201": { "description": "Avatar returned", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "" } } } }, "/index.php/login/v2/poll": { "post": { "operationId": "client_flow_login_v2-poll", "summary": "Poll the login flow credentials", "tags": [ "client_flow_login_v2" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "token", "in": "query", "description": "Token of the flow", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Login flow credentials returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginFlowV2Credentials" } } } }, "404": { "description": "Login flow not found or completed", "content": { "application/json": { "schema": {} } } } } } }, "/index.php/login/v2": { "post": { "operationId": "client_flow_login_v2-init", "summary": "Init a login flow", "tags": [ "client_flow_login_v2" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "responses": { "200": { "description": "Login flow init returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginFlowV2" } } } } } } }, "/index.php/core/preview": { "get": { "operationId": "preview-get-preview-by-file-id", "summary": "Get a preview by file ID", "tags": [ "preview" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "fileId", "in": "query", "description": "ID of the file", "schema": { "type": "integer", "format": "int64", "default": -1 } }, { "name": "x", "in": "query", "description": "Width of the preview", "schema": { "type": "integer", "format": "int64", "default": 32 } }, { "name": "y", "in": "query", "description": "Height of the preview", "schema": { "type": "integer", "format": "int64", "default": 32 } }, { "name": "a", "in": "query", "description": "Whether to not crop the preview", "schema": { "type": "integer", "default": 0 } }, { "name": "forceIcon", "in": "query", "description": "Force returning an icon", "schema": { "type": "integer", "default": 1 } }, { "name": "mode", "in": "query", "description": "How to crop the image", "schema": { "type": "string", "default": "fill" } }, { "name": "mimeFallback", "in": "query", "description": "Whether to fallback to the mime icon if no preview is available", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "Preview returned", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Getting preview is not possible", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Getting preview is not allowed", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Preview not found", "content": { "application/json": { "schema": {} } } }, "303": { "description": "Redirect to the mime icon url if mimeFallback is true", "headers": { "Location": { "schema": { "type": "string" } } } } } } }, "/index.php/core/preview.png": { "get": { "operationId": "preview-get-preview", "summary": "Get a preview by file path", "tags": [ "preview" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "file", "in": "query", "description": "Path of the file", "schema": { "type": "string", "default": "" } }, { "name": "x", "in": "query", "description": "Width of the preview", "schema": { "type": "integer", "format": "int64", "default": 32 } }, { "name": "y", "in": "query", "description": "Height of the preview", "schema": { "type": "integer", "format": "int64", "default": 32 } }, { "name": "a", "in": "query", "description": "Whether to not crop the preview", "schema": { "type": "integer", "default": 0 } }, { "name": "forceIcon", "in": "query", "description": "Force returning an icon", "schema": { "type": "integer", "default": 1 } }, { "name": "mode", "in": "query", "description": "How to crop the image", "schema": { "type": "string", "default": "fill" } }, { "name": "mimeFallback", "in": "query", "description": "Whether to fallback to the mime icon if no preview is available", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "Preview returned", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Getting preview is not possible", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Getting preview is not allowed", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Preview not found", "content": { "application/json": { "schema": {} } } }, "303": { "description": "Redirect to the mime icon url if mimeFallback is true", "headers": { "Location": { "schema": { "type": "string" } } } } } } }, "/index.php/core/references/preview/{referenceId}": { "get": { "operationId": "reference-preview", "summary": "Get a preview for a reference", "tags": [ "reference" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "referenceId", "in": "path", "description": "the reference cache key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Preview returned", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Reference not found", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/index.php/core/wipe/check": { "post": { "operationId": "wipe-check-wipe", "summary": "Check if the device should be wiped", "tags": [ "wipe" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "token", "in": "query", "description": "App password", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Device should be wiped", "content": { "application/json": { "schema": { "type": "object", "required": [ "wipe" ], "properties": { "wipe": { "type": "boolean" } } } } } }, "404": { "description": "Device should not be wiped", "content": { "application/json": { "schema": {} } } } } } }, "/index.php/core/wipe/success": { "post": { "operationId": "wipe-wipe-done", "summary": "Finish the wipe", "tags": [ "wipe" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "token", "in": "query", "description": "App password", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Wipe finished successfully", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Device should not be wiped", "content": { "application/json": { "schema": {} } } } } } }, "/index.php/ocm-provider": { "get": { "operationId": "ocm-discovery", "summary": "generate a OCMProvider with local data and send it as DataResponse. This replaces the old PHP file ocm-provider/index.php", "tags": [ "ocm" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "responses": { "200": { "description": "OCM Provider details returned", "headers": { "X-NEXTCLOUD-OCM-PROVIDERS": { "schema": { "type": "boolean" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled", "apiVersion", "endPoint", "resourceTypes" ], "properties": { "enabled": { "type": "boolean" }, "apiVersion": { "type": "string" }, "endPoint": { "type": "string" }, "resourceTypes": { "type": "array", "items": { "type": "object", "required": [ "name", "shareTypes", "protocols" ], "properties": { "name": { "type": "string" }, "shareTypes": { "type": "array", "items": { "type": "string" } }, "protocols": { "type": "object", "required": [ "webdav" ], "properties": { "webdav": { "type": "string" } } } } } } } } } } }, "500": { "description": "OCM not supported", "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } }, "/ocs/v2.php/cloud/capabilities": { "get": { "operationId": "ocs-get-capabilities", "summary": "Get the capabilities", "tags": [ "ocs" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "Capabilities 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": [ "version", "capabilities" ], "properties": { "version": { "type": "object", "required": [ "major", "minor", "micro", "string", "edition", "extendedSupport" ], "properties": { "major": { "type": "integer", "format": "int64" }, "minor": { "type": "integer", "format": "int64" }, "micro": { "type": "integer", "format": "int64" }, "string": { "type": "string" }, "edition": { "type": "string" }, "extendedSupport": { "type": "boolean" } } }, "capabilities": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } } } } } } } }, "/ocs/v2.php/core/navigation/apps": { "get": { "operationId": "navigation-get-apps-navigation", "summary": "Get the apps navigation", "tags": [ "navigation" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "absolute", "in": "query", "description": "Rewrite URLs to absolute ones", "schema": { "type": "integer", "default": 0 } }, { "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": "Apps navigation returned", "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/NavigationEntry" } } } } } } } } }, "304": { "description": "No apps navigation changed", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/core/navigation/settings": { "get": { "operationId": "navigation-get-settings-navigation", "summary": "Get the settings navigation", "tags": [ "navigation" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "absolute", "in": "query", "description": "Rewrite URLs to absolute ones", "schema": { "type": "integer", "default": 0 } }, { "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": "Apps navigation returned", "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/NavigationEntry" } } } } } } } } }, "304": { "description": "No apps navigation changed", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/core/autocomplete/get": { "get": { "operationId": "auto_complete-get", "summary": "Autocomplete a query", "tags": [ "auto_complete" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "search", "in": "query", "description": "Text to search for", "required": true, "schema": { "type": "string" } }, { "name": "itemType", "in": "query", "description": "Type of the items to search for", "schema": { "type": "string", "nullable": true } }, { "name": "itemId", "in": "query", "description": "ID of the items to search for", "schema": { "type": "string", "nullable": true } }, { "name": "sorter", "in": "query", "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"", "schema": { "type": "string", "nullable": true } }, { "name": "shareTypes[]", "in": "query", "description": "Types of shares to search for", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return", "schema": { "type": "integer", "format": "int64", "default": 10 } }, { "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": "Autocomplete results returned", "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/AutocompleteResult" } } } } } } } } } } } }, "/ocs/v2.php/core/whatsnew": { "get": { "operationId": "whats_new-get", "summary": "Get the changes", "tags": [ "whats_new" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "Changes 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": [ "changelogURL", "product", "version" ], "properties": { "changelogURL": { "type": "string" }, "product": { "type": "string" }, "version": { "type": "string" }, "whatsNew": { "type": "object", "required": [ "regular", "admin" ], "properties": { "regular": { "type": "array", "items": { "type": "string" } }, "admin": { "type": "array", "items": { "type": "string" } } } } } } } } } } } } }, "204": { "description": "No changes", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "post": { "operationId": "whats_new-dismiss", "summary": "Dismiss the changes", "tags": [ "whats_new" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "version", "in": "query", "description": "Version to dismiss the changes for", "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": "Changes dismissed", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "500": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/ocs/v2.php/core/getapppassword": { "get": { "operationId": "app_password-get-app-password", "summary": "Create app password", "tags": [ "app_password" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "App password 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": [ "apppassword" ], "properties": { "apppassword": { "type": "string" } } } } } } } } } }, "403": { "description": "Creating app password is not allowed", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/ocs/v2.php/core/apppassword/rotate": { "post": { "operationId": "app_password-rotate-app-password", "summary": "Rotate app password", "tags": [ "app_password" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "App password 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": [ "apppassword" ], "properties": { "apppassword": { "type": "string" } } } } } } } } } }, "403": { "description": "Rotating app password is not allowed", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/ocs/v2.php/core/apppassword": { "delete": { "operationId": "app_password-delete-app-password", "summary": "Delete app password", "tags": [ "app_password" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "App password deleted successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "403": { "description": "Deleting app password is not allowed", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/ocs/v2.php/hovercard/v1/{userId}": { "get": { "operationId": "hover_card-get-user", "summary": "Get the user details for a hovercard", "tags": [ "hover_card" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "userId", "in": "path", "description": "ID of the user", "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": "User details 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": [ "userId", "displayName", "actions" ], "properties": { "userId": { "type": "string" }, "displayName": { "type": "string" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ContactsAction" } } } } } } } } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/collaboration/resources/collections/search/{filter}": { "get": { "operationId": "collaboration_resources-search-collections", "summary": "Search for collections", "tags": [ "collaboration_resources" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "filter", "in": "path", "description": "Filter collections", "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": "Collections returned", "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/Collection" } } } } } } } } }, "404": { "description": "Collection not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/collaboration/resources/collections/{collectionId}": { "get": { "operationId": "collaboration_resources-list-collection", "summary": "Get a collection", "tags": [ "collaboration_resources" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "collectionId", "in": "path", "description": "ID of the collection", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Collection returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Collection" } } } } } } } }, "404": { "description": "Collection not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "put": { "operationId": "collaboration_resources-rename-collection", "summary": "Rename a collection", "tags": [ "collaboration_resources" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "collectionName", "in": "query", "description": "New name", "required": true, "schema": { "type": "string" } }, { "name": "collectionId", "in": "path", "description": "ID of the collection", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Collection returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Collection" } } } } } } } }, "404": { "description": "Collection not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "post": { "operationId": "collaboration_resources-add-resource", "summary": "Add a resource to a collection", "tags": [ "collaboration_resources" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "resourceType", "in": "query", "description": "Name of the resource", "required": true, "schema": { "type": "string" } }, { "name": "resourceId", "in": "query", "description": "ID of the resource", "required": true, "schema": { "type": "string" } }, { "name": "collectionId", "in": "path", "description": "ID of the collection", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Collection returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Collection" } } } } } } } }, "404": { "description": "Collection not found or resource inaccessible", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "collaboration_resources-remove-resource", "summary": "Remove a resource from a collection", "tags": [ "collaboration_resources" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "resourceType", "in": "query", "description": "Name of the resource", "required": true, "schema": { "type": "string" } }, { "name": "resourceId", "in": "query", "description": "ID of the resource", "required": true, "schema": { "type": "string" } }, { "name": "collectionId", "in": "path", "description": "ID of the collection", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Collection returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Collection" } } } } } } } }, "404": { "description": "Collection or resource not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/collaboration/resources/{resourceType}/{resourceId}": { "get": { "operationId": "collaboration_resources-get-collections-by-resource", "summary": "Get collections by resource", "tags": [ "collaboration_resources" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "resourceType", "in": "path", "description": "Type of the resource", "required": true, "schema": { "type": "string" } }, { "name": "resourceId", "in": "path", "description": "ID of the resource", "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": "Collections returned", "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/Collection" } } } } } } } } }, "404": { "description": "Resource not accessible", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/collaboration/resources/{baseResourceType}/{baseResourceId}": { "post": { "operationId": "collaboration_resources-create-collection-on-resource", "summary": "Create a collection for a resource", "tags": [ "collaboration_resources" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the collection", "required": true, "schema": { "type": "string" } }, { "name": "baseResourceType", "in": "path", "description": "Type of the base resource", "required": true, "schema": { "type": "string" } }, { "name": "baseResourceId", "in": "path", "description": "ID of the base resource", "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": "Collection returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/Collection" } } } } } } } }, "400": { "description": "Creating collection is not possible", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Resource inaccessible", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/references/resolve": { "get": { "operationId": "reference_api-resolve-one", "summary": "Resolve a reference", "tags": [ "reference_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "reference", "in": "query", "description": "Reference to resolve", "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": "Reference 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": [ "references" ], "properties": { "references": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Reference", "nullable": true } } } } } } } } } } } } }, "post": { "operationId": "reference_api-resolve", "summary": "Resolve multiple references", "tags": [ "reference_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "references[]", "in": "query", "description": "References to resolve", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "description": "Maximum amount of references to resolve", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "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": "References 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": [ "references" ], "properties": { "references": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Reference", "nullable": true } } } } } } } } } } } } } }, "/ocs/v2.php/references/extract": { "post": { "operationId": "reference_api-extract", "summary": "Extract references from a text", "tags": [ "reference_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "text", "in": "query", "description": "Text to extract from", "required": true, "schema": { "type": "string" } }, { "name": "resolve", "in": "query", "description": "Resolve the references", "schema": { "type": "integer", "default": 0 } }, { "name": "limit", "in": "query", "description": "Maximum amount of references to extract", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "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": "References 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": [ "references" ], "properties": { "references": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Reference", "nullable": true } } } } } } } } } } } } } }, "/ocs/v2.php/references/providers": { "get": { "operationId": "reference_api-get-providers-info", "summary": "Get the providers", "tags": [ "reference_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "Providers returned", "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/ReferenceProvider" } } } } } } } } } } } }, "/ocs/v2.php/references/provider/{providerId}": { "put": { "operationId": "reference_api-touch-provider", "summary": "Touch a provider", "tags": [ "reference_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "timestamp", "in": "query", "description": "Timestamp of the last usage", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "providerId", "in": "path", "description": "ID of the provider", "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": "Provider touched", "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": [ "success" ], "properties": { "success": { "type": "boolean" } } } } } } } } } } } } }, "/ocs/v2.php/profile/{targetUserId}": { "put": { "operationId": "profile_api-set-visibility", "summary": "Update the visibility of a parameter", "tags": [ "profile_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "paramId", "in": "query", "description": "ID of the parameter", "required": true, "schema": { "type": "string" } }, { "name": "visibility", "in": "query", "description": "New visibility", "required": true, "schema": { "type": "string" } }, { "name": "targetUserId", "in": "path", "description": "ID of the user", "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": "Visibility updated successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "Updating visibility is not possible", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Not allowed to edit other users visibility", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "User not found", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/ocs/v2.php/search/providers": { "get": { "operationId": "unified_search-get-providers", "summary": "Get the providers for unified search", "tags": [ "unified_search" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "from", "in": "query", "description": "the url the user is currently at", "schema": { "type": "string", "default": "" } }, { "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": "Providers returned", "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/UnifiedSearchProvider" } } } } } } } } } } } }, "/ocs/v2.php/search/providers/{providerId}/search": { "get": { "operationId": "unified_search-search", "summary": "Launch a search for a specific search provider.", "description": "Additional filters are available for each provider. Send a request to /providers endpoint to list providers with their available filters.", "tags": [ "unified_search" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "term", "in": "query", "description": "Term to search", "schema": { "type": "string", "default": "" } }, { "name": "sortOrder", "in": "query", "description": "Order of entries", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "limit", "in": "query", "description": "Maximum amount of entries", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "cursor", "in": "query", "description": "Offset for searching", "schema": { "type": "string", "nullable": true } }, { "name": "from", "in": "query", "description": "The current user URL", "schema": { "type": "string", "default": "" } }, { "name": "providerId", "in": "path", "description": "ID of the provider", "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": "Search entries returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "$ref": "#/components/schemas/UnifiedSearchResult" } } } } } } } }, "400": { "description": "Searching is not possible", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "string" } } } } } } } } } } }, "/ocs/v2.php/translation/languages": { "get": { "operationId": "translation_api-languages", "summary": "Get the list of supported languages", "tags": [ "translation_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "Supported languages 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": [ "languages", "languageDetection" ], "properties": { "languages": { "type": "array", "items": { "type": "object", "required": [ "from", "fromLabel", "to", "toLabel" ], "properties": { "from": { "type": "string" }, "fromLabel": { "type": "string" }, "to": { "type": "string" }, "toLabel": { "type": "string" } } } }, "languageDetection": { "type": "boolean" } } } } } } } } } } } } }, "/ocs/v2.php/translation/translate": { "post": { "operationId": "translation_api-translate", "summary": "Translate a text", "tags": [ "translation_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "text", "in": "query", "description": "Text to be translated", "required": true, "schema": { "type": "string" } }, { "name": "fromLanguage", "in": "query", "description": "Language to translate from", "schema": { "type": "string", "nullable": true } }, { "name": "toLanguage", "in": "query", "description": "Language to translate to", "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": "Translated text 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": [ "text", "from" ], "properties": { "text": { "type": "string" }, "from": { "type": "string", "nullable": true } } } } } } } } } }, "400": { "description": "Language not detected or unable to translate", "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": [ "message" ], "properties": { "message": { "type": "string" }, "from": { "type": "string", "nullable": true } } } } } } } } } }, "412": { "description": "Translating is not possible", "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": [ "message" ], "properties": { "message": { "type": "string" }, "from": { "type": "string", "nullable": true } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" }, "from": { "type": "string", "nullable": true } } } } } } } } } } } } }, "/ocs/v2.php/textprocessing/tasktypes": { "get": { "operationId": "text_processing_api-task-types", "summary": "This endpoint returns all available LanguageModel task types", "tags": [ "text_processing_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "Task types 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": [ "types" ], "properties": { "types": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "description" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } } } } } } } } } } } } } } }, "/ocs/v2.php/textprocessing/schedule": { "post": { "operationId": "text_processing_api-schedule", "summary": "This endpoint allows scheduling a language model task", "tags": [ "text_processing_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "input", "in": "query", "description": "Input text", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of the task", "required": true, "schema": { "type": "string" } }, { "name": "appId", "in": "query", "description": "ID of the app that will execute the task", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "An arbitrary identifier for the task", "schema": { "type": "string", "default": "" } }, { "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": "Task scheduled successfully", "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": [ "task" ], "properties": { "task": { "$ref": "#/components/schemas/TextProcessingTask" } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "400": { "description": "Scheduling task is not possible", "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": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "412": { "description": "Scheduling task is not possible", "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": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } } }, "/ocs/v2.php/textprocessing/task/{id}": { "get": { "operationId": "text_processing_api-get-task", "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.", "tags": [ "text_processing_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the task", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Task 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": [ "task" ], "properties": { "task": { "$ref": "#/components/schemas/TextProcessingTask" } } } } } } } } } }, "404": { "description": "Task not found", "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": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } }, "delete": { "operationId": "text_processing_api-delete-task", "summary": "This endpoint allows to delete a scheduled task for a user", "tags": [ "text_processing_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the task", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Task 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": [ "task" ], "properties": { "task": { "$ref": "#/components/schemas/TextProcessingTask" } } } } } } } } } }, "404": { "description": "Task not found", "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": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } } }, "/ocs/v2.php/textprocessing/tasks/app/{appId}": { "get": { "operationId": "text_processing_api-list-tasks-by-app", "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier", "tags": [ "text_processing_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "identifier", "in": "query", "description": "An arbitrary identifier for the task", "schema": { "type": "string", "nullable": true } }, { "name": "appId", "in": "path", "description": "ID of the app", "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": "Task list 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": [ "tasks" ], "properties": { "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TextProcessingTask" } } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } } }, "/ocs/v2.php/text2image/is_available": { "get": { "operationId": "text_to_image_api-is-available", "summary": "Check whether this feature is available", "tags": [ "text_to_image_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "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": "Returns availability status", "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": [ "isAvailable" ], "properties": { "isAvailable": { "type": "boolean" } } } } } } } } } } } } }, "/ocs/v2.php/text2image/schedule": { "post": { "operationId": "text_to_image_api-schedule", "summary": "This endpoint allows scheduling a text to image task", "tags": [ "text_to_image_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "input", "in": "query", "description": "Input text", "required": true, "schema": { "type": "string" } }, { "name": "appId", "in": "query", "description": "ID of the app that will execute the task", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "An arbitrary identifier for the task", "schema": { "type": "string", "default": "" } }, { "name": "numberOfImages", "in": "query", "description": "The number of images to generate", "schema": { "type": "integer", "format": "int64", "default": 8 } }, { "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": "Task scheduled successfully", "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": [ "task" ], "properties": { "task": { "$ref": "#/components/schemas/TextToImageTask" } } } } } } } } } }, "412": { "description": "Scheduling task is not possible", "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": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } } }, "/ocs/v2.php/text2image/task/{id}": { "get": { "operationId": "text_to_image_api-get-task", "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.", "tags": [ "text_to_image_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the task", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Task 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": [ "task" ], "properties": { "task": { "$ref": "#/components/schemas/TextToImageTask" } } } } } } } } } }, "404": { "description": "Task not found", "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": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } }, "delete": { "operationId": "text_to_image_api-delete-task", "summary": "This endpoint allows to delete a scheduled task for a user", "tags": [ "text_to_image_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the task", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Task 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": [ "task" ], "properties": { "task": { "$ref": "#/components/schemas/TextToImageTask" } } } } } } } } } }, "404": { "description": "Task not found", "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": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } } }, "/ocs/v2.php/text2image/task/{id}/image/{index}": { "get": { "operationId": "text_to_image_api-get-image", "summary": "This endpoint allows downloading the resulting image of a task", "tags": [ "text_to_image_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the task", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "index", "in": "path", "description": "The index of the image to retrieve", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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": "Image returned", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Task or image not found", "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": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } } }, "/ocs/v2.php/text2image/tasks/app/{appId}": { "get": { "operationId": "text_to_image_api-list-tasks-by-app", "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier", "tags": [ "text_to_image_api" ], "security": [ { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "identifier", "in": "query", "description": "An arbitrary identifier for the task", "schema": { "type": "string", "nullable": true } }, { "name": "appId", "in": "path", "description": "ID of the app", "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": "Task list 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": [ "tasks" ], "properties": { "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TextToImageTask" } } } } } } } } } } }, "500": { "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", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } } } } } } } } } }, "/status.php": { "get": { "operationId": "get-status", "responses": { "200": { "description": "Status returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } } } } } }, "tags": [ { "name": "avatar", "description": "Class AvatarController" }, { "name": "guest_avatar", "description": "This controller handles guest avatar requests." }, { "name": "ocm", "description": "Controller about the endpoint /ocm-provider/" } ] }