{ "openapi": "3.0.3", "info": { "title": "app_api", "version": "0.0.1", "description": "Nextcloud AppAPI", "license": { "name": "AGPL-3.0-or-later" } }, "components": { "securitySchemes": { "basic_auth": { "type": "http", "scheme": "basic" }, "bearer_auth": { "type": "http", "scheme": "bearer" } }, "schemas": { "Capabilities": { "type": "object", "required": [ "app_api" ], "properties": { "app_api": { "type": "object", "required": [ "loglevel", "version" ], "properties": { "loglevel": { "type": "integer", "format": "int64" }, "version": { "type": "string" } } } } }, "ExAppConfig": { "type": "object", "required": [ "id", "appid", "configkey", "configvalue", "sensitive" ], "properties": { "id": { "type": "integer", "format": "int64" }, "appid": { "type": "string" }, "configkey": { "type": "string" }, "configvalue": { "type": "string" }, "sensitive": { "type": "integer", "format": "int64" } } }, "ExAppConfigValue": { "type": "object", "required": [ "configkey", "configvalue" ], "properties": { "configkey": { "type": "string" }, "configvalue": { "type": "string" } } }, "ExAppPreference": { "type": "object", "required": [ "id", "user_id", "appid", "configkey", "configvalue", "sensitive" ], "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "string" }, "appid": { "type": "string" }, "configkey": { "type": "string" }, "configvalue": { "type": "string" }, "sensitive": { "type": "integer", "format": "int64" } } }, "FileAction": { "type": "object", "required": [ "id", "appid", "name", "display_name", "mime", "permissions", "order", "icon", "action_handler", "version", "default_action" ], "properties": { "id": { "type": "integer", "format": "int64" }, "appid": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "mime": { "type": "string" }, "permissions": { "type": "string" }, "order": { "type": "integer", "format": "int64" }, "icon": { "type": "string" }, "action_handler": { "type": "string" }, "version": { "type": "string" }, "default_action": { "type": "string", "nullable": true } } }, "InitialState": { "type": "object", "required": [ "id", "appid", "type", "name", "key", "value" ], "properties": { "id": { "type": "integer", "format": "int64" }, "appid": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "object" } } }, "Notification": { "type": "object", "required": [ "app", "user", "datetime", "object_type", "object_id", "subject", "message", "link", "icon" ], "properties": { "app": { "type": "string" }, "user": { "type": "string" }, "datetime": { "type": "string" }, "object_type": { "type": "string" }, "object_id": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "link": { "type": "string" }, "icon": { "type": "string" } } }, "OCSMeta": { "type": "object", "required": [ "status", "statuscode" ], "properties": { "status": { "type": "string" }, "statuscode": { "type": "integer" }, "message": { "type": "string" }, "totalitems": { "type": "string" }, "itemsperpage": { "type": "string" } } }, "OccCommand": { "type": "object", "required": [ "id", "appid", "name", "description", "hidden", "arguments", "options", "usages", "execute_handler" ], "properties": { "id": { "type": "integer", "format": "int64" }, "appid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "hidden": { "type": "integer", "format": "int64" }, "arguments": { "type": "array", "items": { "type": "object" } }, "options": { "type": "array", "items": { "type": "object" } }, "usages": { "type": "array", "items": { "type": "object" } }, "execute_handler": { "type": "string" } } }, "PublicCapabilities": { "type": "object", "required": [ "app_api" ], "properties": { "app_api": { "type": "object", "required": [ "version" ], "properties": { "version": { "type": "string" } } } } }, "Script": { "type": "object", "required": [ "id", "appid", "type", "name", "path", "after_app_id" ], "properties": { "id": { "type": "integer", "format": "int64" }, "appid": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "after_app_id": { "type": "string" } } }, "Style": { "type": "object", "required": [ "id", "appid", "type", "name", "path" ], "properties": { "id": { "type": "integer", "format": "int64" }, "appid": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" } } }, "TalkBot": { "type": "object", "required": [ "id", "secret" ], "properties": { "id": { "type": "string" }, "secret": { "type": "string" } } }, "TaskProcessingProvider": { "type": "object", "required": [ "id", "app_id", "name", "display_name", "task_type", "provider", "custom_task_type" ], "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "app_id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "task_type": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "custom_task_type": { "type": "string", "nullable": true } } }, "TopMenu": { "type": "object", "required": [ "id", "appid", "name", "display_name", "icon", "admin_required" ], "properties": { "id": { "type": "integer", "format": "int64" }, "appid": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "icon": { "type": "string" }, "admin_required": { "type": "integer", "format": "int64" } } } } }, "paths": { "/ocs/v2.php/apps/app_api/api/v1/log": { "post": { "operationId": "ocs_api-log", "summary": "Log a message to the Nextcloud log on behalf of an ExApp", "tags": [ "ocs_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "level", "message" ], "properties": { "level": { "type": "integer", "format": "int64", "description": "Log level (0 - debug, 1 - info, 2 - warning, 3 - error, 4 - fatal)" }, "message": { "type": "string", "description": "Message to log" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Message logged 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": "Invalid log level", "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/apps/app_api/api/v1/users": { "get": { "operationId": "ocs_api-getnc-users-list", "summary": "Get a list of all Nextcloud user IDs", "tags": [ "ocs_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": "Users 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": "array", "items": { "type": "string" } } } } } } } } } } } }, "/ocs/v2.php/apps/app_api/apps/status/{appId}": { "put": { "operationId": "ocs_api-set-app-init-progress-deprecated", "summary": "Update the initialization progress of an ExApp by its appid", "deprecated": true, "tags": [ "ocs_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "progress" ], "properties": { "progress": { "type": "integer", "format": "int64", "description": "Initialization progress in percent (0-100)" }, "error": { "type": "string", "default": "", "description": "Error message in case the initialization failed" } } } } } }, "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp", "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": "Initialization progress updated", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "ExApp not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/ex-app/status": { "put": { "operationId": "ocs_api-set-app-init-progress", "summary": "Update the initialization progress of the calling ExApp", "tags": [ "ocs_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "progress" ], "properties": { "progress": { "type": "integer", "format": "int64", "description": "Initialization progress in percent (0-100)" }, "error": { "type": "string", "default": "", "description": "Error message in case the initialization failed" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Initialization progress updated", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "ExApp not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/ex-app/state": { "get": { "operationId": "ocs_api-get-enabled-state", "summary": "Get the enabled state of the calling ExApp (0 for disabled, 1 for enabled)", "description": "Note: This endpoint is accessible even if the ExApp itself is disabled.", "tags": [ "ocs_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "ex-app-id", "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": "Enabled state returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "integer", "format": "int64" } } } } } } } }, "404": { "description": "ExApp not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/info/nextcloud_url/absolute": { "get": { "operationId": "ocs_api-get-nextcloud-absolute-url", "summary": "Build an absolute URL from a Nextcloud-relative URL", "tags": [ "ocs_api" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "url", "in": "query", "description": "Relative URL to convert into an absolute one", "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": "Absolute URL 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": [ "absolute_url" ], "properties": { "absolute_url": { "type": "string" } } } } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/config": { "post": { "operationId": "app_config-set-app-config-value", "summary": "Set a configuration value for the calling ExApp", "tags": [ "app_config" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "configKey", "configValue" ], "properties": { "configKey": { "type": "string", "description": "Configuration key" }, "configValue": { "type": "object", "description": "Configuration value" }, "sensitive": { "type": "integer", "format": "int64", "nullable": true, "default": null, "description": "Whether the value is sensitive and should be stored encrypted (1) or not (0)" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Config value set", "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/ExAppConfig" } } } } } } } }, "400": { "description": "Config key is empty or the value could not be set", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "app_config-delete-app-config-values", "summary": "Delete configuration values of the calling ExApp", "tags": [ "app_config" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "configKeys[]", "in": "query", "description": "Configuration keys to delete", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ex-app-id", "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": "Number of deleted config values returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "integer", "format": "int64" } } } } } } } }, "400": { "description": "Failed to delete the config values", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "No matching config values were found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/config/get-values": { "post": { "operationId": "app_config-get-app-config-values", "summary": "Get configuration values of the calling ExApp", "tags": [ "app_config" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "configKeys" ], "properties": { "configKeys": { "type": "array", "description": "Configuration keys to retrieve", "items": { "type": "string" } } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Config values 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/ExAppConfigValue" } } } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/preference": { "post": { "operationId": "preferences-set-user-config-value", "summary": "Set a preference value for the current user and the calling ExApp", "tags": [ "preferences" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "configKey", "configValue" ], "properties": { "configKey": { "type": "string", "description": "Preference key" }, "configValue": { "type": "object", "description": "Preference value" }, "sensitive": { "type": "integer", "format": "int64", "nullable": true, "default": null, "description": "Whether the value is sensitive and should be stored encrypted (1) or not (0)" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Preference value set", "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/ExAppPreference" } } } } } } } }, "400": { "description": "Config key is empty or the value could not be set", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "preferences-delete-user-config-values", "summary": "Delete preference values of the current user for the calling ExApp", "tags": [ "preferences" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "configKeys[]", "in": "query", "description": "Preference keys to delete", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ex-app-id", "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": "Number of deleted preference values returned", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "integer", "format": "int64" } } } } } } } }, "400": { "description": "Failed to delete the preference values", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "No matching preference values were found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ex-app/preference/get-values": { "post": { "operationId": "preferences-get-user-config-values", "summary": "Get preference values of the current user for the calling ExApp", "tags": [ "preferences" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "configKeys" ], "properties": { "configKeys": { "type": "array", "description": "Preference keys to retrieve", "items": { "type": "string" } } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Preference values 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/ExAppConfigValue" } } } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/notification": { "post": { "operationId": "notifications-send-notification", "summary": "Send a notification to a user on behalf of the calling ExApp", "tags": [ "notifications" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "params" ], "properties": { "params": { "type": "object", "description": "Notification parameters", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "ex-app-id", "in": "header", "schema": { "type": "string" } }, { "name": "authorization-app-api", "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": "Notification sent", "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/Notification" } } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/occ_command": { "post": { "operationId": "occ_command-register-command", "summary": "Register an occ command for the calling ExApp", "tags": [ "occ_command" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "description", "execute_handler" ], "properties": { "name": { "type": "string", "description": "Name of the command" }, "description": { "type": "string", "description": "Description of the command" }, "execute_handler": { "type": "string", "description": "Handler route called when the command is executed" }, "hidden": { "type": "integer", "format": "int64", "default": 0, "description": "Whether the command is hidden from the command list (1) or not (0)" }, "arguments": { "type": "array", "default": [], "description": "Command argument definitions", "items": { "type": "object" } }, "options": { "type": "array", "default": [], "description": "Command option definitions", "items": { "type": "object" } }, "usages": { "type": "array", "default": [], "description": "Example usages of the command", "items": { "type": "object" } } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Command registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "Command could not be registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "occ_command-unregister-command", "summary": "Unregister an occ command of the calling ExApp", "tags": [ "occ_command" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the command to remove", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Command unregistered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Command not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "get": { "operationId": "occ_command-get-command", "summary": "Get an occ command of the calling ExApp", "tags": [ "occ_command" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the command", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Command 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/OccCommand" } } } } } } } }, "404": { "description": "Command not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/talk_bot": { "post": { "operationId": "talk_bot-register-ex-app-talk-bot", "summary": "Register a Talk bot for the calling ExApp", "tags": [ "talk_bot" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "route", "description" ], "properties": { "name": { "type": "string", "description": "Bot display name" }, "route": { "type": "string", "description": "ExApp route that receives bot messages" }, "description": { "type": "string", "description": "Description of the bot" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Talk bot registered", "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/TalkBot" } } } } } } } }, "400": { "description": "Talk bot could not be registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "talk_bot-unregister-ex-app-talk-bot", "summary": "Unregister a Talk bot of the calling ExApp", "tags": [ "talk_bot" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "route", "in": "query", "description": "ExApp route of the bot to remove", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Talk bot unregistered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": { "type": "boolean" } } } } } } } }, "404": { "description": "Talk bot could not be unregistered", "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/apps/app_api/api/v1/talk_proxy/{appId}/{route}": { "post": { "operationId": "talk_bot-proxy-talk-message", "summary": "Proxy a Talk chat message to the bot of a registered ExApp", "tags": [ "talk_bot" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "appId", "in": "path", "description": "ID of the ExApp owning the bot", "required": true, "schema": { "type": "string" } }, { "name": "route", "in": "path", "description": "ExApp route that receives the message", "required": true, "schema": { "type": "string", "pattern": "^.+$" } }, { "name": "x-nextcloud-talk-random", "in": "header", "schema": { "type": "string" } }, { "name": "x-nextcloud-talk-signature", "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": "Message proxied to the ExApp bot", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Invalid signature or unknown bot", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "500": { "description": "The ExApp bot could not be reached", "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/apps/app_api/api/v1/ui/files-actions-menu": { "post": { "operationId": "ocs_ui-register-file-action-menu", "summary": "Register a files action menu entry for the calling ExApp", "deprecated": true, "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "displayName", "actionHandler" ], "properties": { "name": { "type": "string", "description": "Unique name of the action" }, "displayName": { "type": "string", "description": "Human-readable display name" }, "actionHandler": { "type": "string", "description": "Handler route called when the action is triggered" }, "icon": { "type": "string", "default": "", "description": "Icon to display next to the action" }, "mime": { "type": "string", "default": "file", "description": "Mimetype the action applies to" }, "permissions": { "type": "integer", "format": "int64", "default": 31, "description": "Required permissions on the file" }, "order": { "type": "integer", "format": "int64", "default": 0, "description": "Ordering of the action in the menu" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "File action menu entry registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "File action menu entry could not be registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "ocs_ui-unregister-file-action-menu", "summary": "Unregister a files action menu entry of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the action to remove", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "File action menu entry unregistered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "File action menu entry not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "get": { "operationId": "ocs_ui-get-file-action-menu", "summary": "Get a files action menu entry of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the action", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "File action menu entry 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/FileAction" } } } } } } } }, "404": { "description": "File action menu entry not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v2/ui/files-actions-menu": { "post": { "operationId": "ocs_ui-register-file-action-menu-v2", "summary": "Register a files action menu entry (v2) for the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "displayName", "actionHandler" ], "properties": { "name": { "type": "string", "description": "Unique name of the action" }, "displayName": { "type": "string", "description": "Human-readable display name" }, "actionHandler": { "type": "string", "description": "Handler route called when the action is triggered" }, "icon": { "type": "string", "default": "", "description": "Icon to display next to the action" }, "mime": { "type": "string", "default": "file", "description": "Mimetype the action applies to" }, "permissions": { "type": "integer", "format": "int64", "default": 31, "description": "Required permissions on the file" }, "order": { "type": "integer", "format": "int64", "default": 0, "description": "Ordering of the action in the menu" }, "defaultAction": { "type": "string", "default": "", "description": "Whether this is the default action: one of '', 'default' or 'hidden'" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "File action menu entry registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "File action menu entry could not be registered or defaultAction is invalid", "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/apps/app_api/api/v1/ui/top-menu": { "post": { "operationId": "ocs_ui-register-ex-app-menu-entry", "summary": "Register a top menu entry for the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "displayName" ], "properties": { "name": { "type": "string", "description": "Unique name of the menu entry" }, "displayName": { "type": "string", "description": "Human-readable display name" }, "icon": { "type": "string", "default": "", "description": "Icon to display for the menu entry" }, "adminRequired": { "type": "integer", "format": "int64", "default": 0, "description": "Whether the entry is only visible to admins (1) or to everyone (0)" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Top menu entry registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "Top menu entry could not be registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "ocs_ui-unregister-ex-app-menu-entry", "summary": "Unregister a top menu entry of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the menu entry to remove", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Top menu entry unregistered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Top menu entry not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "get": { "operationId": "ocs_ui-get-ex-app-menu-entry", "summary": "Get a top menu entry of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the menu entry", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Top menu entry 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/TopMenu" } } } } } } } }, "404": { "description": "Top menu entry not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ui/initial-state": { "post": { "operationId": "ocs_ui-set-ex-app-initial-state", "summary": "Set an initial state for a page of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "name", "key", "value" ], "properties": { "type": { "type": "string", "description": "Page type the initial state belongs to" }, "name": { "type": "string", "description": "Name of the page" }, "key": { "type": "string", "description": "Initial state key" }, "value": { "type": "object", "description": "Initial state value", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Initial state set", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "Initial state could not be set", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "ocs_ui-delete-ex-app-initial-state", "summary": "Delete an initial state of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "type", "in": "query", "description": "Page type the initial state belongs to", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the page", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Initial state key", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Initial state deleted", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Initial state not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "get": { "operationId": "ocs_ui-get-ex-app-initial-state", "summary": "Get an initial state of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "type", "in": "query", "description": "Page type the initial state belongs to", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the page", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Initial state key", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Initial state 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/InitialState" } } } } } } } }, "404": { "description": "Initial state not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ui/script": { "post": { "operationId": "ocs_ui-set-ex-app-script", "summary": "Register a script for a page of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "name", "path" ], "properties": { "type": { "type": "string", "description": "Page type the script belongs to" }, "name": { "type": "string", "description": "Name of the page" }, "path": { "type": "string", "description": "Path to the script file inside the ExApp" }, "afterAppId": { "type": "string", "default": "", "description": "Load the script after the script of this app" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Script registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "Script could not be set", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "ocs_ui-delete-ex-app-script", "summary": "Delete a script of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "type", "in": "query", "description": "Page type the script belongs to", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the page", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "Path to the script file inside the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Script deleted", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Script not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "get": { "operationId": "ocs_ui-get-ex-app-script", "summary": "Get a script of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "type", "in": "query", "description": "Page type the script belongs to", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the page", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "Path to the script file inside the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Script 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/Script" } } } } } } } }, "404": { "description": "Script not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ui/style": { "post": { "operationId": "ocs_ui-set-ex-app-style", "summary": "Register a style for a page of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "name", "path" ], "properties": { "type": { "type": "string", "description": "Page type the style belongs to" }, "name": { "type": "string", "description": "Name of the page" }, "path": { "type": "string", "description": "Path to the style file inside the ExApp" } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Style registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "Style could not be set", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "ocs_ui-delete-ex-app-style", "summary": "Delete a style of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "type", "in": "query", "description": "Page type the style belongs to", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the page", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "Path to the style file inside the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Style deleted", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Style not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "get": { "operationId": "ocs_ui-get-ex-app-style", "summary": "Get a style of the calling ExApp", "tags": [ "ocs_ui" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "type", "in": "query", "description": "Page type the style belongs to", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the page", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "Path to the style file inside the ExApp", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Style 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/Style" } } } } } } } }, "404": { "description": "Style not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ui/settings": { "post": { "operationId": "ocs_settings-register-form", "summary": "Register a declarative settings form for the calling ExApp", "tags": [ "ocs_settings" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "formScheme" ], "properties": { "formScheme": { "type": "object", "description": "Declarative settings form scheme", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Settings form registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "Settings form could not be registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "ocs_settings-unregister-form", "summary": "Unregister a declarative settings form of the calling ExApp", "tags": [ "ocs_settings" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "formId", "in": "query", "description": "ID of the settings form to remove", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Settings form unregistered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Settings form not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "get": { "operationId": "ocs_settings-get-form", "summary": "Get a declarative settings form of the calling ExApp", "tags": [ "ocs_settings" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "formId", "in": "query", "description": "ID of the settings form", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Settings form 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", "additionalProperties": { "type": "object" } } } } } } } } }, "404": { "description": "Settings form not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/ai_provider/task_processing": { "post": { "operationId": "task_processing-register-provider", "summary": "Register a Task Processing provider for the calling ExApp", "tags": [ "task_processing" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "provider" ], "properties": { "provider": { "type": "object", "description": "Task Processing provider definition", "additionalProperties": { "type": "object" } }, "customTaskType": { "type": "object", "nullable": true, "description": "Custom task type definition, or null", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "ex-app-id", "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": "Provider registered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "400": { "description": "Provider could not be registered", "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-unregister-provider", "summary": "Unregister a Task Processing provider of the calling ExApp", "tags": [ "task_processing" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the provider to remove", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Provider unregistered", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } }, "404": { "description": "Provider not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "get": { "operationId": "task_processing-get-provider", "summary": "Get a Task Processing provider of the calling ExApp", "tags": [ "task_processing" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "Name of the provider", "required": true, "schema": { "type": "string" } }, { "name": "ex-app-id", "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": "Provider 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/TaskProcessingProvider" } } } } } } } }, "404": { "description": "Provider not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } }, "/ocs/v2.php/apps/app_api/api/v1/setup_check": { "post": { "operationId": "setup_check-register-checks", "summary": "Opt the calling ExApp in to setup checks", "description": "The ExApp is identified from the authenticated `ex-app-id` header, so it can only ever opt itself in. Its live results are then fetched from the ExApp's `/setup_checks` endpoint by a background job and surfaced in the admin \"Security & setup warnings\" panel.", "tags": [ "setup_check" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "ex-app-id", "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": "ExApp opted in to setup checks", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } }, "delete": { "operationId": "setup_check-unregister-checks", "summary": "Opt the calling ExApp out of setup checks", "tags": [ "setup_check" ], "security": [ {}, { "bearer_auth": [] }, { "basic_auth": [] } ], "parameters": [ { "name": "ex-app-id", "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": "ExApp opted out of setup checks", "content": { "application/json": { "schema": { "type": "object", "required": [ "ocs" ], "properties": { "ocs": { "type": "object", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/OCSMeta" }, "data": {} } } } } } } } } } } }, "tags": [ { "name": "ex_apps_page", "description": "ExApps actions controller similar to default one with project-specific changes and additions" }, { "name": "daemon_config", "description": "DaemonConfig actions (for UI)" } ] }