aboutsummaryrefslogtreecommitdiffstats
path: root/core/openapi.json
diff options
context:
space:
mode:
authorprovokateurin <kate@provokateurin.de>2024-08-19 11:08:28 +0200
committerprovokateurin <kate@provokateurin.de>2024-08-21 11:07:50 +0200
commitff10f9f60f777407ecf8ac8901339e985e4d49b5 (patch)
tree7cd27ea42b4b22288bdfcf3212aa921a4762848f /core/openapi.json
parentcf56874cb1cb6150eadaf673474785e6b86937f7 (diff)
downloadnextcloud-server-ff10f9f60f777407ecf8ac8901339e985e4d49b5.tar.gz
nextcloud-server-ff10f9f60f777407ecf8ac8901339e985e4d49b5.zip
chore(deps): Update openapi-extractor to v1.0.0
Signed-off-by: provokateurin <kate@provokateurin.de>
Diffstat (limited to 'core/openapi.json')
-rw-r--r--core/openapi.json882
1 files changed, 441 insertions, 441 deletions
diff --git a/core/openapi.json b/core/openapi.json
index 5d8a66cac21..582b01fd050 100644
--- a/core/openapi.json
+++ b/core/openapi.json
@@ -1453,56 +1453,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",
@@ -1840,30 +1850,6 @@
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "resourceType",
- "resourceId"
- ],
- "properties": {
- "resourceType": {
- "type": "string",
- "description": "Name of the resource"
- },
- "resourceId": {
- "type": "string",
- "description": "ID of the resource"
- }
- }
- }
- }
- }
- },
"parameters": [
{
"name": "collectionId",
@@ -1876,6 +1862,24 @@
}
},
{
+ "name": "resourceType",
+ "in": "query",
+ "description": "Name of the resource",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "resourceId",
+ "in": "query",
+ "description": "ID of the resource",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
@@ -2645,25 +2649,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",
@@ -2729,25 +2729,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",
@@ -3310,27 +3306,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",
@@ -3502,32 +3488,26 @@
"basic_auth": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "reference",
- "sharingToken"
- ],
- "properties": {
- "reference": {
- "type": "string",
- "description": "Reference to resolve"
- },
- "sharingToken": {
- "type": "string",
- "description": "Token of the public share"
- }
- }
- }
- }
- }
- },
"parameters": [
{
+ "name": "reference",
+ "in": "query",
+ "description": "Reference to resolve",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sharingToken",
+ "in": "query",
+ "description": "Token of the public share",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
@@ -4470,23 +4450,6 @@
"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": "appId",
@@ -4498,6 +4461,15 @@
}
},
{
+ "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",
@@ -4606,30 +4578,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",
@@ -5818,23 +5786,6 @@
"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": "appId",
@@ -5846,6 +5797,15 @@
}
},
{
+ "name": "identifier",
+ "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",
@@ -6653,23 +6613,6 @@
"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": "appId",
@@ -6681,6 +6624,15 @@
}
},
{
+ "name": "identifier",
+ "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",
@@ -7116,25 +7068,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",
@@ -7198,53 +7142,6 @@
"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": "providerId",
@@ -7256,6 +7153,61 @@
}
},
{
+ "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"
+ }
+ ]
+ }
+ },
+ {
+ "name": "from",
+ "in": "query",
+ "description": "The current user URL",
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
@@ -7533,23 +7485,6 @@
"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": "userId",
@@ -7573,6 +7508,19 @@
512
]
}
+ },
+ {
+ "name": "guestFallback",
+ "in": "query",
+ "description": "Fallback to guest avatar if not found",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
@@ -7644,23 +7592,6 @@
"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": "userId",
@@ -7684,6 +7615,19 @@
512
]
}
+ },
+ {
+ "name": "guestFallback",
+ "in": "query",
+ "description": "Fallback to guest avatar if not found",
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
@@ -7888,24 +7832,6 @@
"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": "guestName",
@@ -7929,6 +7855,20 @@
512
]
}
+ },
+ {
+ "name": "darkTheme",
+ "in": "query",
+ "description": "Return dark avatar",
+ "schema": {
+ "type": "integer",
+ "nullable": true,
+ "default": 0,
+ "enum": [
+ 0,
+ 1
+ ]
+ }
}
],
"responses": {
@@ -8250,59 +8190,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",
@@ -8367,60 +8337,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",