| { |
| "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" |
| } |
| } |
| }, |
| "Capabilities": { |
| "type": "object", |
| "required": [ |
| "core" |
| ], |
| "properties": { |
| "core": { |
| "type": "object", |
| "required": [ |
| "pollinterval", |
| "webdav-root", |
| "reference-api", |
| "reference-regex", |
| "mod-rewrite-working" |
| ], |
| "properties": { |
| "pollinterval": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "webdav-root": { |
| "type": "string" |
| }, |
| "reference-api": { |
| "type": "boolean" |
| }, |
| "reference-regex": { |
| "type": "string" |
| }, |
| "mod-rewrite-working": { |
| "type": "boolean" |
| }, |
| "user": { |
| "type": "object", |
| "required": [ |
| "language", |
| "locale", |
| "timezone" |
| ], |
| "properties": { |
| "language": { |
| "type": "string" |
| }, |
| "locale": { |
| "type": "string" |
| }, |
| "timezone": { |
| "type": "string" |
| } |
| } |
| }, |
| "can-create-app-token": { |
| "type": "boolean" |
| } |
| } |
| } |
| } |
| }, |
| "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", |
| "href", |
| "icon", |
| "type", |
| "name", |
| "active", |
| "classes", |
| "unread" |
| ], |
| "properties": { |
| "id": { |
| "type": "string" |
| }, |
| "order": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "href": { |
| "type": "string" |
| }, |
| "icon": { |
| "type": "string" |
| }, |
| "type": { |
| "type": "string" |
| }, |
| "name": { |
| "type": "string" |
| }, |
| "app": { |
| "type": "string" |
| }, |
| "default": { |
| "type": "boolean" |
| }, |
| "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" |
| } |
| } |
| }, |
| "ProfileAction": { |
| "type": "object", |
| "required": [ |
| "id", |
| "icon", |
| "title", |
| "target" |
| ], |
| "properties": { |
| "id": { |
| "type": "string" |
| }, |
| "icon": { |
| "type": "string" |
| }, |
| "title": { |
| "type": "string" |
| }, |
| "target": { |
| "type": "string", |
| "nullable": true |
| } |
| } |
| }, |
| "ProfileData": { |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/ProfileFields" |
| }, |
| { |
| "type": "object", |
| "required": [ |
| "timezone", |
| "timezoneOffset" |
| ], |
| "properties": { |
| "timezone": { |
| "type": "string", |
| "description": "Timezone identifier like Europe/Berlin or America/North_Dakota/Beulah" |
| }, |
| "timezoneOffset": { |
| "type": "integer", |
| "format": "int64", |
| "description": "Offset in seconds, negative when behind UTC, positive otherwise" |
| } |
| } |
| } |
| ] |
| }, |
| "ProfileFields": { |
| "type": "object", |
| "required": [ |
| "userId", |
| "actions" |
| ], |
| "properties": { |
| "userId": { |
| "type": "string" |
| }, |
| "address": { |
| "type": "string", |
| "nullable": true |
| }, |
| "biography": { |
| "type": "string", |
| "nullable": true |
| }, |
| "displayname": { |
| "type": "string", |
| "nullable": true |
| }, |
| "headline": { |
| "type": "string", |
| "nullable": true |
| }, |
| "isUserAvatarVisible": { |
| "type": "boolean" |
| }, |
| "organisation": { |
| "type": "string", |
| "nullable": true |
| }, |
| "pronouns": { |
| "type": "string", |
| "nullable": true |
| }, |
| "role": { |
| "type": "string", |
| "nullable": true |
| }, |
| "actions": { |
| "type": "array", |
| "items": { |
| "$ref": "#/components/schemas/ProfileAction" |
| } |
| } |
| } |
| }, |
| "PublicCapabilities": { |
| "type": "object", |
| "required": [ |
| "bruteforce" |
| ], |
| "properties": { |
| "bruteforce": { |
| "type": "object", |
| "required": [ |
| "delay", |
| "allow-listed" |
| ], |
| "properties": { |
| "delay": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "allow-listed": { |
| "type": "boolean" |
| } |
| } |
| } |
| } |
| }, |
| "Reference": { |
| "type": "object", |
| "required": [ |
| "richObjectType", |
| "richObject", |
| "openGraphObject", |
| "accessible" |
| ], |
| "properties": { |
| "richObjectType": { |
| "type": "string" |
| }, |
| "richObject": { |
| "type": "object", |
| "additionalProperties": { |
| "type": "object", |
| "nullable": true |
| } |
| }, |
| "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", |
| "nullable": true |
| } |
| }, |
| "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" |
| } |
| } |
| }, |
| "TaskProcessingIO": { |
| "type": "object", |
| "additionalProperties": { |
| "anyOf": [ |
| { |
| "type": "number" |
| }, |
| { |
| "type": "array", |
| "items": { |
| "type": "number" |
| } |
| }, |
| { |
| "type": "string" |
| }, |
| { |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| } |
| ] |
| } |
| }, |
| "TaskProcessingShape": { |
| "type": "object", |
| "required": [ |
| "name", |
| "description", |
| "type" |
| ], |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "description": { |
| "type": "string" |
| }, |
| "type": { |
| "type": "string", |
| "enum": [ |
| "Number", |
| "Text", |
| "Audio", |
| "Image", |
| "Video", |
| "File", |
| "Enum", |
| "ListOfNumbers", |
| "ListOfTexts", |
| "ListOfImages", |
| "ListOfAudios", |
| "ListOfVideos", |
| "ListOfFiles" |
| ] |
| } |
| } |
| }, |
| "TaskProcessingTask": { |
| "type": "object", |
| "required": [ |
| "id", |
| "lastUpdated", |
| "type", |
| "status", |
| "userId", |
| "appId", |
| "input", |
| "output", |
| "customId", |
| "completionExpectedAt", |
| "progress", |
| "scheduledAt", |
| "startedAt", |
| "endedAt", |
| "allowCleanup", |
| "includeWatermark", |
| "userFacingErrorMessage" |
| ], |
| "properties": { |
| "id": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "lastUpdated": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "type": { |
| "type": "string" |
| }, |
| "status": { |
| "type": "string", |
| "enum": [ |
| "STATUS_CANCELLED", |
| "STATUS_FAILED", |
| "STATUS_SUCCESSFUL", |
| "STATUS_RUNNING", |
| "STATUS_SCHEDULED", |
| "STATUS_UNKNOWN" |
| ] |
| }, |
| "userId": { |
| "type": "string", |
| "nullable": true |
| }, |
| "appId": { |
| "type": "string" |
| }, |
| "input": { |
| "$ref": "#/components/schemas/TaskProcessingIO" |
| }, |
| "output": { |
| "nullable": true, |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/TaskProcessingIO" |
| } |
| ] |
| }, |
| "customId": { |
| "type": "string", |
| "nullable": true |
| }, |
| "completionExpectedAt": { |
| "type": "integer", |
| "format": "int64", |
| "nullable": true |
| }, |
| "progress": { |
| "type": "number", |
| "format": "double", |
| "nullable": true |
| }, |
| "scheduledAt": { |
| "type": "integer", |
| "format": "int64", |
| "nullable": true |
| }, |
| "startedAt": { |
| "type": "integer", |
| "format": "int64", |
| "nullable": true |
| }, |
| "endedAt": { |
| "type": "integer", |
| "format": "int64", |
| "nullable": true |
| }, |
| "allowCleanup": { |
| "type": "boolean" |
| }, |
| "includeWatermark": { |
| "type": "boolean" |
| }, |
| "userFacingErrorMessage": { |
| "type": "string", |
| "nullable": true |
| } |
| } |
| }, |
| "TaskProcessingTaskType": { |
| "type": "object", |
| "required": [ |
| "name", |
| "description", |
| "inputShape", |
| "inputShapeEnumValues", |
| "inputShapeDefaults", |
| "optionalInputShape", |
| "optionalInputShapeEnumValues", |
| "optionalInputShapeDefaults", |
| "outputShape", |
| "outputShapeEnumValues", |
| "optionalOutputShape", |
| "optionalOutputShapeEnumValues" |
| ], |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "description": { |
| "type": "string" |
| }, |
| "inputShape": { |
| "type": "object", |
| "additionalProperties": { |
| "$ref": "#/components/schemas/TaskProcessingShape" |
| } |
| }, |
| "inputShapeEnumValues": { |
| "type": "object", |
| "additionalProperties": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "required": [ |
| "name", |
| "value" |
| ], |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "value": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| }, |
| "inputShapeDefaults": { |
| "type": "object", |
| "additionalProperties": { |
| "oneOf": [ |
| { |
| "type": "number" |
| }, |
| { |
| "type": "string" |
| } |
| ] |
| } |
| }, |
| "optionalInputShape": { |
| "type": "object", |
| "additionalProperties": { |
| "$ref": "#/components/schemas/TaskProcessingShape" |
| } |
| }, |
| "optionalInputShapeEnumValues": { |
| "type": "object", |
| "additionalProperties": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "required": [ |
| "name", |
| "value" |
| ], |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "value": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| }, |
| "optionalInputShapeDefaults": { |
| "type": "object", |
| "additionalProperties": { |
| "oneOf": [ |
| { |
| "type": "number" |
| }, |
| { |
| "type": "string" |
| } |
| ] |
| } |
| }, |
| "outputShape": { |
| "type": "object", |
| "additionalProperties": { |
| "$ref": "#/components/schemas/TaskProcessingShape" |
| } |
| }, |
| "outputShapeEnumValues": { |
| "type": "object", |
| "additionalProperties": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "required": [ |
| "name", |
| "value" |
| ], |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "value": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| }, |
| "optionalOutputShape": { |
| "type": "object", |
| "additionalProperties": { |
| "$ref": "#/components/schemas/TaskProcessingShape" |
| } |
| }, |
| "optionalOutputShapeEnumValues": { |
| "type": "object", |
| "additionalProperties": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "required": [ |
| "name", |
| "value" |
| ], |
| "properties": { |
| "name": { |
| "type": "string" |
| }, |
| "value": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "Team": { |
| "type": "object", |
| "required": [ |
| "teamId", |
| "displayName", |
| "link" |
| ], |
| "properties": { |
| "teamId": { |
| "type": "string" |
| }, |
| "displayName": { |
| "type": "string" |
| }, |
| "link": { |
| "type": "string", |
| "nullable": true |
| } |
| } |
| }, |
| "TeamResource": { |
| "type": "object", |
| "required": [ |
| "id", |
| "label", |
| "url", |
| "iconSvg", |
| "iconURL", |
| "iconEmoji", |
| "provider" |
| ], |
| "properties": { |
| "id": { |
| "type": "string" |
| }, |
| "label": { |
| "type": "string" |
| }, |
| "url": { |
| "type": "string" |
| }, |
| "iconSvg": { |
| "type": "string", |
| "nullable": true |
| }, |
| "iconURL": { |
| "type": "string", |
| "nullable": true |
| }, |
| "iconEmoji": { |
| "type": "string", |
| "nullable": true |
| }, |
| "provider": { |
| "type": "object", |
| "required": [ |
| "id", |
| "name", |
| "icon" |
| ], |
| "properties": { |
| "id": { |
| "type": "string" |
| }, |
| "name": { |
| "type": "string" |
| }, |
| "icon": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| }, |
| "TeamWithResources": { |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/Team" |
| }, |
| { |
| "type": "object", |
| "required": [ |
| "resources" |
| ], |
| "properties": { |
| "resources": { |
| "type": "array", |
| "items": { |
| "$ref": "#/components/schemas/TeamResource" |
| } |
| } |
| } |
| } |
| ] |
| }, |
| "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", |
| "enum": [ |
| 0, |
| 1, |
| 2, |
| 3, |
| 4 |
| ] |
| }, |
| "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", |
| "enum": [ |
| 0, |
| 1, |
| 2, |
| 3, |
| 4 |
| ] |
| }, |
| "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", |
| "isExternalProvider", |
| "triggers", |
| "filters", |
| "inAppSearch" |
| ], |
| "properties": { |
| "id": { |
| "type": "string" |
| }, |
| "appId": { |
| "type": "string" |
| }, |
| "name": { |
| "type": "string" |
| }, |
| "icon": { |
| "type": "string" |
| }, |
| "order": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "isExternalProvider": { |
| "type": "boolean" |
| }, |
| "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": { |
| "/ocs/v2.php/core/getapppassword": { |
| "get": { |
| "operationId": "app_password-get-app-password", |
| "summary": "Create app password", |
| "description": "This endpoint requires password confirmation", |
| "tags": [ |
| "app_password" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "user-agent", |
| "in": "header", |
| "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": "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": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/apppassword/confirm": { |
| "put": { |
| "operationId": "app_password-confirm-user-password", |
| "summary": "Confirm the user password", |
| "tags": [ |
| "app_password" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "password" |
| ], |
| "properties": { |
| "password": { |
| "type": "string", |
| "description": "The password of the user" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": "Password confirmation succeeded", |
| "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": [ |
| "lastLogin" |
| ], |
| "properties": { |
| "lastLogin": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "403": { |
| "description": "Password confirmation failed", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/getapppassword-onetime": { |
| "get": { |
| "operationId": "app_password-get-app-password-with-one-time-password", |
| "summary": "Get app password with one-time password", |
| "description": "This endpoint requires password confirmation", |
| "tags": [ |
| "app_password" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "user-agent", |
| "in": "header", |
| "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": "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": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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, |
| "default": null |
| } |
| }, |
| { |
| "name": "shareTypes[]", |
| "in": "query", |
| "description": "Types of shares to search for", |
| "schema": { |
| "type": "array", |
| "default": [], |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "resourceType", |
| "resourceId" |
| ], |
| "properties": { |
| "resourceType": { |
| "type": "string", |
| "description": "Name of the resource" |
| }, |
| "resourceId": { |
| "type": "string", |
| "description": "ID of the resource" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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 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": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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": "collectionId", |
| "in": "path", |
| "description": "ID of the collection", |
| "required": true, |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| }, |
| { |
| "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": "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": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "collectionName" |
| ], |
| "properties": { |
| "collectionName": { |
| "type": "string", |
| "description": "New name" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "name" |
| ], |
| "properties": { |
| "name": { |
| "type": "string", |
| "description": "Name of the collection" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "parameters": [ |
| { |
| "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": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/hovercard/v1/{userId}": { |
| "get": { |
| "operationId": "hover_card-get-user", |
| "summary": "Get the account 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": "Account 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": "Account not found", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": "boolean", |
| "default": false |
| } |
| }, |
| { |
| "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" |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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": "boolean", |
| "default": false |
| } |
| }, |
| { |
| "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" |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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/profile/{targetUserId}": { |
| "put": { |
| "operationId": "profile_api-set-visibility", |
| "summary": "Update the visibility of a parameter", |
| "description": "This endpoint requires password confirmation", |
| "tags": [ |
| "profile_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "paramId", |
| "visibility" |
| ], |
| "properties": { |
| "paramId": { |
| "type": "string", |
| "description": "ID of the parameter" |
| }, |
| "visibility": { |
| "type": "string", |
| "description": "New visibility" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "parameters": [ |
| { |
| "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": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "403": { |
| "description": "Not allowed to edit other users visibility", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "404": { |
| "description": "Account not found", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "get": { |
| "operationId": "profile_api-get-profile-fields", |
| "summary": "Get profile fields for another user", |
| "tags": [ |
| "profile_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "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": "Profile data returned successfully", |
| "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/ProfileData" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "400": { |
| "description": "Profile is disabled", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": { |
| "nullable": true |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "404": { |
| "description": "Account not found or disabled", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": { |
| "nullable": true |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/extract": { |
| "post": { |
| "operationId": "reference_api-extract", |
| "summary": "Extract references from a text", |
| "tags": [ |
| "reference_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "text" |
| ], |
| "properties": { |
| "text": { |
| "type": "string", |
| "description": "Text to extract from" |
| }, |
| "resolve": { |
| "type": "boolean", |
| "default": false, |
| "description": "Resolve the references" |
| }, |
| "limit": { |
| "type": "integer", |
| "format": "int64", |
| "default": 1, |
| "description": "Maximum amount of references to extract" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": "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": { |
| "nullable": true, |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/Reference" |
| } |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/extractPublic": { |
| "post": { |
| "operationId": "reference_api-extract-public", |
| "summary": "Extract references from a text", |
| "tags": [ |
| "reference_api" |
| ], |
| "security": [ |
| {}, |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "text", |
| "sharingToken" |
| ], |
| "properties": { |
| "text": { |
| "type": "string", |
| "description": "Text to extract from" |
| }, |
| "sharingToken": { |
| "type": "string", |
| "description": "Token of the public share" |
| }, |
| "resolve": { |
| "type": "boolean", |
| "default": false, |
| "description": "Resolve the references" |
| }, |
| "limit": { |
| "type": "integer", |
| "format": "int64", |
| "default": 1, |
| "description": "Maximum amount of references to extract, limited to 15" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": "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": { |
| "nullable": true, |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/Reference" |
| } |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/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": { |
| "nullable": true, |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/Reference" |
| } |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "post": { |
| "operationId": "reference_api-resolve", |
| "summary": "Resolve multiple references", |
| "tags": [ |
| "reference_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "references" |
| ], |
| "properties": { |
| "references": { |
| "type": "array", |
| "description": "References to resolve", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "limit": { |
| "type": "integer", |
| "format": "int64", |
| "default": 1, |
| "description": "Maximum amount of references to resolve" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": "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": { |
| "nullable": true, |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/Reference" |
| } |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/resolvePublic": { |
| "get": { |
| "operationId": "reference_api-resolve-one-public", |
| "summary": "Resolve from a public page", |
| "tags": [ |
| "reference_api" |
| ], |
| "security": [ |
| {}, |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "reference", |
| "in": "query", |
| "description": "Reference to resolve", |
| "required": true, |
| "schema": { |
| "type": "string" |
| } |
| }, |
| { |
| "name": "sharingToken", |
| "in": "query", |
| "description": "Token of the public share", |
| "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": { |
| "nullable": true, |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/Reference" |
| } |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "post": { |
| "operationId": "reference_api-resolve-public", |
| "summary": "Resolve multiple references from a public page", |
| "tags": [ |
| "reference_api" |
| ], |
| "security": [ |
| {}, |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "references", |
| "sharingToken" |
| ], |
| "properties": { |
| "references": { |
| "type": "array", |
| "description": "References to resolve", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "sharingToken": { |
| "type": "string", |
| "description": "Token of the public share" |
| }, |
| "limit": { |
| "type": "integer", |
| "format": "int64", |
| "default": 1, |
| "description": "Maximum amount of references to resolve, limited to 15" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": "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": { |
| "nullable": true, |
| "allOf": [ |
| { |
| "$ref": "#/components/schemas/Reference" |
| } |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/provider/{providerId}": { |
| "put": { |
| "operationId": "reference_api-touch-provider", |
| "summary": "Touch a provider", |
| "tags": [ |
| "reference_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": false, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "properties": { |
| "timestamp": { |
| "type": "integer", |
| "format": "int64", |
| "nullable": true, |
| "default": null, |
| "description": "Timestamp of the last usage" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "parameters": [ |
| { |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/taskprocessing/tasktypes": { |
| "get": { |
| "operationId": "task_processing_api-task-types", |
| "summary": "Returns all available TaskProcessing task types", |
| "tags": [ |
| "task_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": "object", |
| "additionalProperties": { |
| "$ref": "#/components/schemas/TaskProcessingTaskType" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/taskprocessing/schedule": { |
| "post": { |
| "operationId": "task_processing_api-schedule", |
| "summary": "Schedules a task", |
| "tags": [ |
| "task_processing_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "input", |
| "type", |
| "appId" |
| ], |
| "properties": { |
| "input": { |
| "type": "object", |
| "description": "Task's input parameters", |
| "additionalProperties": { |
| "type": "object" |
| } |
| }, |
| "type": { |
| "type": "string", |
| "description": "Type of the task" |
| }, |
| "appId": { |
| "type": "string", |
| "description": "ID of the app that will execute the task" |
| }, |
| "customId": { |
| "type": "string", |
| "default": "", |
| "description": "An arbitrary identifier for the task" |
| }, |
| "webhookUri": { |
| "type": "string", |
| "nullable": true, |
| "default": null, |
| "description": "URI to be requested when the task finishes" |
| }, |
| "webhookMethod": { |
| "type": "string", |
| "nullable": true, |
| "default": null, |
| "description": "Method used for the webhook request (HTTP:GET, HTTP:POST, HTTP:PUT, HTTP:DELETE or AppAPI:APP_ID:GET, AppAPI:APP_ID:POST...)" |
| }, |
| "includeWatermark": { |
| "type": "boolean", |
| "default": true, |
| "description": "Whether to include a watermark in the output file or not" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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 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/TaskProcessingTask" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Cannot schedule task because it references files in its input that the user doesn't have access to", |
| "content": { |
| "application/json": { |
| "schema": { |
| "anyOf": [ |
| { |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/ocs/v2.php/taskprocessing/task/{id}": { |
| "get": { |
| "operationId": "task_processing_api-get-task", |
| "summary": "Gets a task including status and result", |
| "description": "Tasks are removed 1 week after receiving their last update", |
| "tags": [ |
| "task_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/TaskProcessingTask" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "delete": { |
| "operationId": "task_processing_api-delete-task", |
| "summary": "Deletes a task", |
| "tags": [ |
| "task_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 deleted", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": { |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/taskprocessing/tasks/app/{appId}": { |
| "get": { |
| "operationId": "task_processing_api-list-tasks-by-app", |
| "summary": "Returns tasks for the current user filtered by the appId and optional customId", |
| "tags": [ |
| "task_processing_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "appId", |
| "in": "path", |
| "description": "ID of the app", |
| "required": true, |
| "schema": { |
| "type": "string" |
| } |
| }, |
| { |
| "name": "customId", |
| "in": "query", |
| "description": "An arbitrary identifier for the task", |
| "schema": { |
| "type": "string", |
| "nullable": true, |
| "default": null |
| } |
| }, |
| { |
| "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": "Tasks 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/TaskProcessingTask" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/taskprocessing/tasks": { |
| "get": { |
| "operationId": "task_processing_api-list-tasks", |
| "summary": "Returns tasks for the current user filtered by the optional taskType and optional customId", |
| "tags": [ |
| "task_processing_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "taskType", |
| "in": "query", |
| "description": "The task type to filter by", |
| "schema": { |
| "type": "string", |
| "nullable": true |
| } |
| }, |
| { |
| "name": "customId", |
| "in": "query", |
| "description": "An arbitrary identifier for the task", |
| "schema": { |
| "type": "string", |
| "nullable": true, |
| "default": null |
| } |
| }, |
| { |
| "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": "Tasks 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/TaskProcessingTask" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/taskprocessing/tasks/{taskId}/file/{fileId}": { |
| "get": { |
| "operationId": "task_processing_api-get-file-contents", |
| "summary": "Returns the contents of a file referenced in a task", |
| "tags": [ |
| "task_processing_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "taskId", |
| "in": "path", |
| "description": "The id of the task", |
| "required": true, |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| }, |
| { |
| "name": "fileId", |
| "in": "path", |
| "description": "The file id of the file 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": "File content returned", |
| "content": { |
| "*/*": { |
| "schema": { |
| "type": "string", |
| "format": "binary" |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "404": { |
| "description": "Task or file 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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/taskprocessing/tasks/{taskId}/cancel": { |
| "post": { |
| "operationId": "task_processing_api-cancel-task", |
| "summary": "Cancels a task", |
| "tags": [ |
| "task_processing_api" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "taskId", |
| "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 canceled 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/TaskProcessingTask" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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/TeamWithResources" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "input", |
| "type", |
| "appId" |
| ], |
| "properties": { |
| "input": { |
| "type": "string", |
| "description": "Input text" |
| }, |
| "type": { |
| "type": "string", |
| "description": "Type of the task" |
| }, |
| "appId": { |
| "type": "string", |
| "description": "ID of the app that will execute the task" |
| }, |
| "identifier": { |
| "type": "string", |
| "default": "", |
| "description": "An arbitrary identifier for the task" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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 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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": "appId", |
| "in": "path", |
| "description": "ID of the app", |
| "required": true, |
| "schema": { |
| "type": "string" |
| } |
| }, |
| { |
| "name": "identifier", |
| "in": "query", |
| "description": "An arbitrary identifier for the task", |
| "schema": { |
| "type": "string", |
| "nullable": true, |
| "default": null |
| } |
| }, |
| { |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "input", |
| "appId" |
| ], |
| "properties": { |
| "input": { |
| "type": "string", |
| "description": "Input text" |
| }, |
| "appId": { |
| "type": "string", |
| "description": "ID of the app that will execute the task" |
| }, |
| "identifier": { |
| "type": "string", |
| "default": "", |
| "description": "An arbitrary identifier for the task" |
| }, |
| "numberOfImages": { |
| "type": "integer", |
| "format": "int64", |
| "default": 8, |
| "description": "The number of images to generate" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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 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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": "appId", |
| "in": "path", |
| "description": "ID of the app", |
| "required": true, |
| "schema": { |
| "type": "string" |
| } |
| }, |
| { |
| "name": "identifier", |
| "in": "query", |
| "description": "An arbitrary identifier for the task", |
| "schema": { |
| "type": "string", |
| "nullable": true, |
| "default": null |
| } |
| }, |
| { |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "text", |
| "toLanguage" |
| ], |
| "properties": { |
| "text": { |
| "type": "string", |
| "description": "Text to be translated" |
| }, |
| "fromLanguage": { |
| "type": "string", |
| "nullable": true, |
| "description": "Language to translate from" |
| }, |
| "toLanguage": { |
| "type": "string", |
| "description": "Language to translate to" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": "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/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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "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/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": "providerId", |
| "in": "path", |
| "description": "ID of the provider", |
| "required": true, |
| "schema": { |
| "type": "string" |
| } |
| }, |
| { |
| "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, |
| "default": null |
| } |
| }, |
| { |
| "name": "limit", |
| "in": "query", |
| "description": "Maximum amount of entries (capped by configurable unified-search.max-results-per-request, default: 25)", |
| "schema": { |
| "type": "integer", |
| "format": "int64", |
| "nullable": true, |
| "default": null |
| } |
| }, |
| { |
| "name": "cursor", |
| "in": "query", |
| "description": "Offset for searching", |
| "schema": { |
| "nullable": true, |
| "default": null, |
| "oneOf": [ |
| { |
| "type": "integer", |
| "format": "int64" |
| }, |
| { |
| "type": "string" |
| } |
| ] |
| } |
| }, |
| { |
| "name": "from", |
| "in": "query", |
| "description": "The current user URL", |
| "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": "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "ocs" |
| ], |
| "properties": { |
| "ocs": { |
| "type": "object", |
| "required": [ |
| "meta", |
| "data" |
| ], |
| "properties": { |
| "meta": { |
| "$ref": "#/components/schemas/OCSMeta" |
| }, |
| "data": {} |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/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", |
| "enum": [ |
| 64, |
| 512 |
| ] |
| } |
| }, |
| { |
| "name": "guestFallback", |
| "in": "query", |
| "description": "Fallback to guest avatar if not found", |
| "schema": { |
| "type": "boolean", |
| "default": false |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Avatar returned", |
| "headers": { |
| "X-NC-IsCustomAvatar": { |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| }, |
| "content": { |
| "*/*": { |
| "schema": { |
| "type": "string", |
| "format": "binary" |
| } |
| } |
| } |
| }, |
| "201": { |
| "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": {} |
| } |
| } |
| }, |
| "500": { |
| "description": "" |
| } |
| } |
| } |
| }, |
| "/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", |
| "enum": [ |
| 64, |
| 512 |
| ] |
| } |
| }, |
| { |
| "name": "guestFallback", |
| "in": "query", |
| "description": "Fallback to guest avatar if not found", |
| "schema": { |
| "type": "boolean", |
| "default": false |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Avatar returned", |
| "headers": { |
| "X-NC-IsCustomAvatar": { |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| }, |
| "content": { |
| "*/*": { |
| "schema": { |
| "type": "string", |
| "format": "binary" |
| } |
| } |
| } |
| }, |
| "201": { |
| "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": {} |
| } |
| } |
| }, |
| "500": { |
| "description": "" |
| } |
| } |
| } |
| }, |
| "/index.php/csrftoken": { |
| "get": { |
| "operationId": "csrf_token-index", |
| "summary": "Returns a new CSRF token.", |
| "tags": [ |
| "csrf_token" |
| ], |
| "security": [ |
| {}, |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "CSRF token returned", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "token" |
| ], |
| "properties": { |
| "token": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "403": { |
| "description": "Strict cookie check failed", |
| "content": { |
| "application/json": { |
| "schema": {} |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "token" |
| ], |
| "properties": { |
| "token": { |
| "type": "string", |
| "description": "Token of the flow" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "user-agent", |
| "in": "header", |
| "schema": { |
| "type": "string" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Login flow init returned", |
| "content": { |
| "application/json": { |
| "schema": { |
| "$ref": "#/components/schemas/LoginFlowV2" |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/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": "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": "integer", |
| "format": "int64", |
| "enum": [ |
| 64, |
| 512 |
| ] |
| } |
| }, |
| { |
| "name": "darkTheme", |
| "in": "query", |
| "description": "Return dark avatar", |
| "schema": { |
| "type": "boolean", |
| "nullable": true, |
| "default": false |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Custom avatar returned", |
| "headers": { |
| "X-NC-IsCustomAvatar": { |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| }, |
| "content": { |
| "*/*": { |
| "schema": { |
| "type": "string", |
| "format": "binary" |
| } |
| } |
| } |
| }, |
| "201": { |
| "description": "Avatar returned", |
| "headers": { |
| "X-NC-IsCustomAvatar": { |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| }, |
| "content": { |
| "*/*": { |
| "schema": { |
| "type": "string", |
| "format": "binary" |
| } |
| } |
| } |
| }, |
| "500": { |
| "description": "" |
| } |
| } |
| } |
| }, |
| "/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": "integer", |
| "format": "int64", |
| "enum": [ |
| 64, |
| 512 |
| ] |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Custom avatar returned", |
| "headers": { |
| "X-NC-IsCustomAvatar": { |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| }, |
| "content": { |
| "*/*": { |
| "schema": { |
| "type": "string", |
| "format": "binary" |
| } |
| } |
| } |
| }, |
| "201": { |
| "description": "Avatar returned", |
| "headers": { |
| "X-NC-IsCustomAvatar": { |
| "schema": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| }, |
| "content": { |
| "*/*": { |
| "schema": { |
| "type": "string", |
| "format": "binary" |
| } |
| } |
| } |
| }, |
| "500": { |
| "description": "" |
| } |
| } |
| } |
| }, |
| "/index.php/login/confirm": { |
| "post": { |
| "operationId": "login-confirm-password", |
| "summary": "Confirm the user password", |
| "tags": [ |
| "login" |
| ], |
| "security": [ |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "password" |
| ], |
| "properties": { |
| "password": { |
| "type": "string", |
| "description": "The password of the user" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "responses": { |
| "200": { |
| "description": "Password confirmation succeeded", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "lastLogin" |
| ], |
| "properties": { |
| "lastLogin": { |
| "type": "integer", |
| "format": "int64" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "403": { |
| "description": "Password confirmation failed", |
| "content": { |
| "application/json": { |
| "schema": {} |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "message" |
| ], |
| "properties": { |
| "message": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/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", |
| "enum": [ |
| true |
| ] |
| } |
| } |
| }, |
| "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" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/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. A width of -1 will use the original image width.", |
| "schema": { |
| "type": "integer", |
| "format": "int64", |
| "default": 32 |
| } |
| }, |
| { |
| "name": "y", |
| "in": "query", |
| "description": "Height of the preview. A height of -1 will use the original image height.", |
| "schema": { |
| "type": "integer", |
| "format": "int64", |
| "default": 32 |
| } |
| }, |
| { |
| "name": "a", |
| "in": "query", |
| "description": "Preserve the aspect ratio", |
| "schema": { |
| "type": "boolean", |
| "default": false |
| } |
| }, |
| { |
| "name": "forceIcon", |
| "in": "query", |
| "description": "Force returning an icon", |
| "schema": { |
| "type": "boolean", |
| "default": true |
| } |
| }, |
| { |
| "name": "mode", |
| "in": "query", |
| "description": "How to crop the image", |
| "schema": { |
| "type": "string", |
| "default": "fill", |
| "enum": [ |
| "fill", |
| "cover" |
| ] |
| } |
| }, |
| { |
| "name": "mimeFallback", |
| "in": "query", |
| "description": "Whether to fallback to the mime icon if no preview is available", |
| "schema": { |
| "type": "boolean", |
| "default": false |
| } |
| } |
| ], |
| "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" |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "message" |
| ], |
| "properties": { |
| "message": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/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. A width of -1 will use the original image width.", |
| "schema": { |
| "type": "integer", |
| "format": "int64", |
| "default": 32 |
| } |
| }, |
| { |
| "name": "y", |
| "in": "query", |
| "description": "Height of the preview. A height of -1 will use the original image height.", |
| "schema": { |
| "type": "integer", |
| "format": "int64", |
| "default": 32 |
| } |
| }, |
| { |
| "name": "a", |
| "in": "query", |
| "description": "Preserve the aspect ratio", |
| "schema": { |
| "type": "boolean", |
| "default": false |
| } |
| }, |
| { |
| "name": "forceIcon", |
| "in": "query", |
| "description": "Force returning an icon", |
| "schema": { |
| "type": "boolean", |
| "default": true |
| } |
| }, |
| { |
| "name": "mode", |
| "in": "query", |
| "description": "How to crop the image", |
| "schema": { |
| "type": "string", |
| "default": "fill", |
| "enum": [ |
| "fill", |
| "cover" |
| ] |
| } |
| }, |
| { |
| "name": "mimeFallback", |
| "in": "query", |
| "description": "Whether to fallback to the mime icon if no preview is available", |
| "schema": { |
| "type": "boolean", |
| "default": false |
| } |
| } |
| ], |
| "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" |
| } |
| } |
| } |
| }, |
| "401": { |
| "description": "Current user is not logged in", |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "message" |
| ], |
| "properties": { |
| "message": { |
| "type": "string" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/index.php/core/mimeicon": { |
| "get": { |
| "operationId": "preview-get-mime-icon-url", |
| "summary": "Get a preview by mime", |
| "tags": [ |
| "preview" |
| ], |
| "security": [ |
| {}, |
| { |
| "bearer_auth": [] |
| }, |
| { |
| "basic_auth": [] |
| } |
| ], |
| "parameters": [ |
| { |
| "name": "mime", |
| "in": "query", |
| "description": "Mime type", |
| "schema": { |
| "type": "string", |
| "default": "application/octet-stream" |
| } |
| } |
| ], |
| "responses": { |
| "303": { |
| "description": "The mime icon url", |
| "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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "token" |
| ], |
| "properties": { |
| "token": { |
| "type": "string", |
| "description": "App password" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "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": [] |
| } |
| ], |
| "requestBody": { |
| "required": true, |
| "content": { |
| "application/json": { |
| "schema": { |
| "type": "object", |
| "required": [ |
| "token" |
| ], |
| "properties": { |
| "token": { |
| "type": "string", |
| "description": "App password" |
| } |
| } |
| } |
| } |
| } |
| }, |
| "responses": { |
| "200": { |
| "description": "Wipe finished successfully", |
| "content": { |
| "application/json": { |
| "schema": {} |
| } |
| } |
| }, |
| "404": { |
| "description": "Device should not be wiped", |
| "content": { |
| "application/json": { |
| "schema": {} |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/status.php": { |
| "get": { |
| "operationId": "get-status", |
| "responses": { |
| "200": { |
| "description": "Status returned", |
| "content": { |
| "application/json": { |
| "schema": { |
| "$ref": "#/components/schemas/Status" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "tags": [ |
| { |
| "name": "ocs", |
| "description": "If you are here because you can't extend the OCSController class, you got the wrong one. Please use {@see \\OCP\\AppFramework\\OCSController}!" |
| }, |
| { |
| "name": "avatar", |
| "description": "Class AvatarController" |
| }, |
| { |
| "name": "guest_avatar", |
| "description": "This controller handles guest avatar requests." |
| }, |
| { |
| "name": "ocm", |
| "description": "Controller about the endpoint /ocm-provider/" |
| }, |
| { |
| "name": "open_metrics", |
| "description": "OpenMetrics controller Gather and display metrics" |
| } |
| ] |
| } |
|
|
