diff options
| author | Marcel Klehr <mklehr@gmx.net> | 2024-07-13 12:25:51 +0200 |
|---|---|---|
| committer | Marcel Klehr <mklehr@gmx.net> | 2024-07-17 13:55:55 +0200 |
| commit | 0d07ad98b067ea4fb6f5b871442fbdac2d87440a (patch) | |
| tree | e4adc008639ddcd948337585edd82c75785e3529 /core/openapi-full.json | |
| parent | 969cc52851aa579b7b265624c1f3ad6f8b90d6ed (diff) | |
| download | nextcloud-server-0d07ad98b067ea4fb6f5b871442fbdac2d87440a.tar.gz nextcloud-server-0d07ad98b067ea4fb6f5b871442fbdac2d87440a.zip | |
fix(TaskProcessing): Update openapi specs
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
Diffstat (limited to 'core/openapi-full.json')
| -rw-r--r-- | core/openapi-full.json | 1867 |
1 files changed, 975 insertions, 892 deletions
diff --git a/core/openapi-full.json b/core/openapi-full.json index b70e82c3ee8..b39c6021299 100644 --- a/core/openapi-full.json +++ b/core/openapi-full.json @@ -1209,27 +1209,17 @@ "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": "password", + "in": "query", + "description": "The password of the user", + "required": true, + "schema": { + "type": "string" + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -1326,56 +1316,66 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "search" - ], - "properties": { - "search": { - "type": "string", - "description": "Text to search for" - }, - "itemType": { - "type": "string", - "nullable": true, - "description": "Type of the items to search for" - }, - "itemId": { - "type": "string", - "nullable": true, - "description": "ID of the items to search for" - }, - "sorter": { - "type": "string", - "nullable": true, - "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"" - }, - "shareTypes": { - "type": "array", - "default": [], - "description": "Types of shares to search for", - "items": { - "type": "integer", - "format": "int64" - } - }, - "limit": { - "type": "integer", - "format": "int64", - "default": 10, - "description": "Maximum number of results to return" - } - } + "parameters": [ + { + "name": "search", + "in": "query", + "description": "Text to search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "itemType", + "in": "query", + "description": "Type of the items to search for", + "schema": { + "type": "string", + "nullable": true + } + }, + { + "name": "itemId", + "in": "query", + "description": "ID of the items to search for", + "schema": { + "type": "string", + "nullable": true + } + }, + { + "name": "sorter", + "in": "query", + "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"", + "schema": { + "type": "string", + "nullable": true + } + }, + { + "name": "shareTypes[]", + "in": "query", + "description": "Types of shares to search for", + "schema": { + "type": "array", + "default": [], + "items": { + "type": "integer", + "format": "int64" } } - } - }, - "parameters": [ + }, + { + "name": "limit", + "in": "query", + "description": "Maximum number of results to return", + "schema": { + "type": "integer", + "format": "int64", + "default": 10 + } + }, { "name": "OCS-APIRequest", "in": "header", @@ -1564,32 +1564,26 @@ "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": "resourceType", + "in": "query", + "description": "Name of the resource", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceId", + "in": "query", + "description": "ID of the resource", + "required": true, + "schema": { + "type": "string" + } + }, + { "name": "collectionId", "in": "path", "description": "ID of the collection", @@ -1713,32 +1707,26 @@ "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": "resourceType", + "in": "query", + "description": "Name of the resource", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resourceId", + "in": "query", + "description": "ID of the resource", + "required": true, + "schema": { + "type": "string" + } + }, + { "name": "collectionId", "in": "path", "description": "ID of the collection", @@ -1862,27 +1850,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "collectionName" - ], - "properties": { - "collectionName": { - "type": "string", - "description": "New name" - } - } - } - } - } - }, "parameters": [ { + "name": "collectionName", + "in": "query", + "description": "New name", + "required": true, + "schema": { + "type": "string" + } + }, + { "name": "collectionId", "in": "path", "description": "ID of the collection", @@ -2219,27 +2197,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the collection" - } - } - } - } - } - }, "parameters": [ { + "name": "name", + "in": "query", + "description": "Name of the collection", + "required": true, + "schema": { + "type": "string" + } + }, + { "name": "baseResourceType", "in": "path", "description": "Type of the base resource", @@ -2518,25 +2486,21 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "absolute": { - "type": "boolean", - "default": false, - "description": "Rewrite URLs to absolute ones" - } - } - } - } - } - }, "parameters": [ { + "name": "absolute", + "in": "query", + "description": "Rewrite URLs to absolute ones", + "schema": { + "type": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -2602,25 +2566,21 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "absolute": { - "type": "boolean", - "default": false, - "description": "Rewrite URLs to absolute ones" - } - } - } - } - } - }, "parameters": [ { + "name": "absolute", + "in": "query", + "description": "Rewrite URLs to absolute ones", + "schema": { + "type": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -2795,32 +2755,26 @@ "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": "paramId", + "in": "query", + "description": "ID of the parameter", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "visibility", + "in": "query", + "description": "New visibility", + "required": true, + "schema": { + "type": "string" + } + }, + { "name": "targetUserId", "in": "path", "description": "ID of the user", @@ -2971,38 +2925,40 @@ "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": "text", + "in": "query", + "description": "Text to extract from", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "resolve", + "in": "query", + "description": "Resolve the references", + "schema": { + "type": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] + } + }, + { + "name": "limit", + "in": "query", + "description": "Maximum amount of references to extract", + "schema": { + "type": "integer", + "format": "int64", + "default": 1 + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -3074,27 +3030,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "reference" - ], - "properties": { - "reference": { - "type": "string", - "description": "Reference to resolve" - } - } - } - } - } - }, "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", @@ -3164,35 +3110,29 @@ "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": "references[]", + "in": "query", + "description": "References to resolve", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" } } - } - }, - "parameters": [ + }, + { + "name": "limit", + "in": "query", + "description": "Maximum amount of references to resolve", + "schema": { + "type": "integer", + "format": "int64", + "default": 1 + } + }, { "name": "OCS-APIRequest", "in": "header", @@ -3329,26 +3269,18 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "timestamp": { - "type": "integer", - "format": "int64", - "nullable": true, - "description": "Timestamp of the last usage" - } - } - } - } - } - }, "parameters": [ { + "name": "timestamp", + "in": "query", + "description": "Timestamp of the last usage", + "schema": { + "type": "integer", + "format": "int64", + "nullable": true + } + }, + { "name": "providerId", "in": "path", "description": "ID of the provider", @@ -3499,45 +3431,44 @@ "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" - } - } - } - } - } - }, "parameters": [ { + "name": "input", + "in": "query", + "description": "Task's input parameters", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "Type of the task", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "appId", + "in": "query", + "description": "ID of the app that will execute the task", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "customId", + "in": "query", + "description": "An arbitrary identifier for the task", + "schema": { + "type": "string", + "default": "" + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -4021,25 +3952,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "customId": { - "type": "string", - "nullable": true, - "description": "An arbitrary identifier for the task" - } - } - } - } - } - }, "parameters": [ { + "name": "customId", + "in": "query", + "description": "An arbitrary identifier for the task", + "schema": { + "type": "string", + "nullable": true + } + }, + { "name": "appId", "in": "path", "description": "ID of the app", @@ -4157,30 +4080,26 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "taskType": { - "type": "string", - "nullable": true, - "description": "The task type to filter by" - }, - "customId": { - "type": "string", - "nullable": true, - "description": "An arbitrary identifier for the task" - } - } - } - } - } - }, "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 + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -4843,42 +4762,44 @@ "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": "input", + "in": "query", + "description": "Input text", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "Type of the task", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "appId", + "in": "query", + "description": "ID of the app that will execute the task", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "identifier", + "in": "query", + "description": "An arbitrary identifier for the task", + "schema": { + "type": "string", + "default": "" + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -5369,25 +5290,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "identifier": { - "type": "string", - "nullable": true, - "description": "An arbitrary identifier for the task" - } - } - } - } - } - }, "parameters": [ { + "name": "identifier", + "in": "query", + "description": "An arbitrary identifier for the task", + "schema": { + "type": "string", + "nullable": true + } + }, + { "name": "appId", "in": "path", "description": "ID of the app", @@ -5576,43 +5489,45 @@ "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": "input", + "in": "query", + "description": "Input text", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "appId", + "in": "query", + "description": "ID of the app that will execute the task", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "identifier", + "in": "query", + "description": "An arbitrary identifier for the task", + "schema": { + "type": "string", + "default": "" + } + }, + { + "name": "numberOfImages", + "in": "query", + "description": "The number of images to generate", + "schema": { + "type": "integer", + "format": "int64", + "default": 8 + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -6204,25 +6119,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "identifier": { - "type": "string", - "nullable": true, - "description": "An arbitrary identifier for the task" - } - } - } - } - } - }, "parameters": [ { + "name": "identifier", + "in": "query", + "description": "An arbitrary identifier for the task", + "schema": { + "type": "string", + "nullable": true + } + }, + { "name": "appId", "in": "path", "description": "ID of the app", @@ -6438,37 +6345,35 @@ "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": "text", + "in": "query", + "description": "Text to be translated", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fromLanguage", + "in": "query", + "description": "Language to translate from", + "schema": { + "type": "string", + "nullable": true + } + }, + { + "name": "toLanguage", + "in": "query", + "description": "Language to translate to", + "required": true, + "schema": { + "type": "string" + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -6667,25 +6572,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "from": { - "type": "string", - "default": "", - "description": "the url the user is currently at" - } - } - } - } - } - }, "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", @@ -6749,54 +6646,62 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "term": { - "type": "string", - "default": "", - "description": "Term to search" - }, - "sortOrder": { - "type": "integer", - "format": "int64", - "nullable": true, - "description": "Order of entries" - }, - "limit": { - "type": "integer", - "format": "int64", - "nullable": true, - "description": "Maximum amount of entries, limited to 25" - }, - "cursor": { - "nullable": true, - "description": "Offset for searching", - "oneOf": [ - { - "type": "integer", - "format": "int64" - }, - { - "type": "string" - } - ] - }, - "from": { - "type": "string", - "default": "", - "description": "The current user URL" - } + "parameters": [ + { + "name": "term", + "in": "query", + "description": "Term to search", + "schema": { + "type": "string", + "default": "" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "Order of entries", + "schema": { + "type": "integer", + "format": "int64", + "nullable": true + } + }, + { + "name": "limit", + "in": "query", + "description": "Maximum amount of entries, limited to 25", + "schema": { + "type": "integer", + "format": "int64", + "nullable": true + } + }, + { + "name": "cursor", + "in": "query", + "description": "Offset for searching", + "schema": { + "nullable": true, + "oneOf": [ + { + "type": "integer", + "format": "int64" + }, + { + "type": "string" } - } + ] } - } - }, - "parameters": [ + }, + { + "name": "from", + "in": "query", + "description": "The current user URL", + "schema": { + "type": "string", + "default": "" + } + }, { "name": "providerId", "in": "path", @@ -6995,27 +6900,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "version" - ], - "properties": { - "version": { - "type": "string", - "description": "Version to dismiss the changes for" - } - } - } - } - } - }, "parameters": [ { + "name": "version", + "in": "query", + "description": "Version to dismiss the changes for", + "required": true, + "schema": { + "type": "string" + } + }, + { "name": "OCS-APIRequest", "in": "header", "description": "Required to be true for the API request to pass", @@ -7084,25 +6979,21 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "guestFallback": { - "type": "boolean", - "default": false, - "description": "Fallback to guest avatar if not found" - } - } - } - } - } - }, "parameters": [ { + "name": "guestFallback", + "in": "query", + "description": "Fallback to guest avatar if not found", + "schema": { + "type": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] + } + }, + { "name": "userId", "in": "path", "description": "ID of the user", @@ -7191,25 +7082,21 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "guestFallback": { - "type": "boolean", - "default": false, - "description": "Fallback to guest avatar if not found" - } - } - } - } - } - }, "parameters": [ { + "name": "guestFallback", + "in": "query", + "description": "Fallback to guest avatar if not found", + "schema": { + "type": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] + } + }, + { "name": "userId", "in": "path", "description": "ID of the user", @@ -7298,25 +7185,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "token" - ], - "properties": { - "token": { - "type": "string", - "description": "Token of the flow" - } - } - } + "parameters": [ + { + "name": "token", + "in": "query", + "description": "Token of the flow", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Login flow credentials returned", @@ -7385,26 +7264,22 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "darkTheme": { - "type": "boolean", - "nullable": true, - "default": false, - "description": "Return dark avatar" - } - } - } - } - } - }, "parameters": [ { + "name": "darkTheme", + "in": "query", + "description": "Return dark avatar", + "schema": { + "type": "integer", + "nullable": true, + "default": 0, + "enum": [ + 0, + 1 + ] + } + }, + { "name": "guestName", "in": "path", "description": "The guest name, e.g. \"Albert\"", @@ -7564,25 +7439,17 @@ "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": "password", + "in": "query", + "description": "The password of the user", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Password confirmation succeeded", @@ -7737,59 +7604,89 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "default": "", - "description": "Path of the file" - }, - "x": { - "type": "integer", - "format": "int64", - "default": 32, - "description": "Width of the preview. A width of -1 will use the original image width." - }, - "y": { - "type": "integer", - "format": "int64", - "default": 32, - "description": "Height of the preview. A height of -1 will use the original image height." - }, - "a": { - "type": "boolean", - "default": false, - "description": "Preserve the aspect ratio" - }, - "forceIcon": { - "type": "boolean", - "default": true, - "description": "Force returning an icon" - }, - "mode": { - "type": "string", - "default": "fill", - "enum": [ - "fill", - "cover" - ], - "description": "How to crop the image" - }, - "mimeFallback": { - "type": "boolean", - "default": false, - "description": "Whether to fallback to the mime icon if no preview is available" - } - } - } + "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": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] + } + }, + { + "name": "forceIcon", + "in": "query", + "description": "Force returning an icon", + "schema": { + "type": "integer", + "default": 1, + "enum": [ + 0, + 1 + ] + } + }, + { + "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": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] } } - }, + ], "responses": { "200": { "description": "Preview returned", @@ -7854,60 +7751,90 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "fileId": { - "type": "integer", - "format": "int64", - "default": -1, - "description": "ID of the file" - }, - "x": { - "type": "integer", - "format": "int64", - "default": 32, - "description": "Width of the preview. A width of -1 will use the original image width." - }, - "y": { - "type": "integer", - "format": "int64", - "default": 32, - "description": "Height of the preview. A height of -1 will use the original image height." - }, - "a": { - "type": "boolean", - "default": false, - "description": "Preserve the aspect ratio" - }, - "forceIcon": { - "type": "boolean", - "default": true, - "description": "Force returning an icon" - }, - "mode": { - "type": "string", - "default": "fill", - "enum": [ - "fill", - "cover" - ], - "description": "How to crop the image" - }, - "mimeFallback": { - "type": "boolean", - "default": false, - "description": "Whether to fallback to the mime icon if no preview is available" - } - } - } + "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": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] + } + }, + { + "name": "forceIcon", + "in": "query", + "description": "Force returning an icon", + "schema": { + "type": "integer", + "default": 1, + "enum": [ + 0, + 1 + ] + } + }, + { + "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": "integer", + "default": 0, + "enum": [ + 0, + 1 + ] } } - }, + ], "responses": { "200": { "description": "Preview returned", @@ -8025,25 +7952,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "token" - ], - "properties": { - "token": { - "type": "string", - "description": "App password" - } - } - } + "parameters": [ + { + "name": "token", + "in": "query", + "description": "App password", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Device should be wiped", @@ -8090,25 +8009,17 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "token" - ], - "properties": { - "token": { - "type": "string", - "description": "App password" - } - } - } + "parameters": [ + { + "name": "token", + "in": "query", + "description": "App password", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Wipe finished successfully", @@ -8285,11 +8196,11 @@ } } }, - "/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/progress": { + "/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/file": { "post": { - "operationId": "task_processing_api-set-progress", - "summary": "Sets the task progress", - "description": "This endpoint requires admin access", + "operationId": "task_processing_api-set-file-contents-ex-app", + "summary": "Upload a file so it can be referenced in a task result (ExApp route version)", + "description": "Use field 'file' for the file upload\nThis endpoint requires admin access", "tags": [ "task_processing_api" ], @@ -8301,28 +8212,213 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "progress" - ], - "properties": { - "progress": { - "type": "number", - "format": "double", - "description": "The progress" + "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": { + "201": { + "description": "File created", + "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": [ + "fileId" + ], + "properties": { + "fileId": { + "type": "integer", + "format": "int64" + } + } + } + } + } + } + } + } + } + }, + "400": { + "description": "File upload failed or no file was uploaded", + "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" + } + } + } + } + } + } + } + } + } + }, + "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" + } + } + } + } + } } } } } } - }, + } + } + }, + "/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/progress": { + "post": { + "operationId": "task_processing_api-set-progress", + "summary": "Sets the task progress", + "description": "This endpoint requires admin access", + "tags": [ + "task_processing_api" + ], + "security": [ + { + "bearer_auth": [] + }, + { + "basic_auth": [] + } + ], "parameters": [ { + "name": "progress", + "in": "query", + "description": "The progress", + "required": true, + "schema": { + "type": "number", + "format": "double" + } + }, + { "name": "taskId", "in": "path", "description": "The id of the task", @@ -8477,33 +8573,26 @@ "basic_auth": [] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "output": { - "type": "object", - "nullable": true, - "description": "The resulting task output", - "additionalProperties": { - "type": "object" - } - }, - "errorMessage": { - "type": "string", - "nullable": true, - "description": "An error message if the task failed" - } - } - } - } - } - }, "parameters": [ { + "name": "output", + "in": "query", + "description": "The resulting task output, files are represented by their IDs", + "schema": { + "type": "string", + "nullable": true + } + }, + { + "name": "errorMessage", + "in": "query", + "description": "An error message if the task failed", + "schema": { + "type": "string", + "nullable": true + } + }, + { "name": "taskId", "in": "path", "description": "The id of the task", @@ -8658,37 +8747,31 @@ "basic_auth": [] } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "providerIds", - "taskTypeIds" - ], - "properties": { - "providerIds": { - "type": "array", - "description": "The ids of the providers", - "items": { - "type": "string" - } - }, - "taskTypeIds": { - "type": "array", - "description": "The ids of the task types", - "items": { - "type": "string" - } - } - } + "parameters": [ + { + "name": "providerIds[]", + "in": "query", + "description": "The ids of the providers", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" } } - } - }, - "parameters": [ + }, + { + "name": "taskTypeIds[]", + "in": "query", + "description": "The ids of the task types", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, { "name": "OCS-APIRequest", "in": "header", @@ -8810,4 +8893,4 @@ "description": "Controller about the endpoint /ocm-provider/" } ] -} +}
\ No newline at end of file |