aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_sharing/openapi.json
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_sharing/openapi.json')
-rw-r--r--apps/files_sharing/openapi.json782
1 files changed, 355 insertions, 427 deletions
diff --git a/apps/files_sharing/openapi.json b/apps/files_sharing/openapi.json
index 87f36d4331f..65beb9121b8 100644
--- a/apps/files_sharing/openapi.json
+++ b/apps/files_sharing/openapi.json
@@ -1385,49 +1385,41 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "file",
- "in": "query",
- "description": "File in the share",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "x",
- "in": "query",
- "description": "Width of the preview",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 32
- }
- },
- {
- "name": "y",
- "in": "query",
- "description": "Height of the preview",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 32
- }
- },
- {
- "name": "a",
- "in": "query",
- "description": "Whether to not crop the preview",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "string",
+ "default": "",
+ "description": "File in the share"
+ },
+ "x": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32,
+ "description": "Width of the preview"
+ },
+ "y": {
+ "type": "integer",
+ "format": "int64",
+ "default": 32,
+ "description": "Height of the preview"
+ },
+ "a": {
+ "type": "boolean",
+ "default": false,
+ "description": "Whether to not crop the preview"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "token",
"in": "path",
@@ -1493,45 +1485,41 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "t",
- "in": "query",
- "description": "Token of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "Password of the share",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "dir",
- "in": "query",
- "description": "Subdirectory to get info about",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "depth",
- "in": "query",
- "description": "Maximum depth to get info about",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": -1
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "t"
+ ],
+ "properties": {
+ "t": {
+ "type": "string",
+ "description": "Token of the share"
+ },
+ "password": {
+ "type": "string",
+ "nullable": true,
+ "description": "Password of the share"
+ },
+ "dir": {
+ "type": "string",
+ "nullable": true,
+ "description": "Subdirectory to get info about"
+ },
+ "depth": {
+ "type": "integer",
+ "format": "int64",
+ "default": -1,
+ "description": "Maximum depth to get info about"
+ }
+ }
+ }
}
}
- ],
+ },
"responses": {
"200": {
"description": "Share info returned",
@@ -1577,52 +1565,44 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "shared_with_me",
- "in": "query",
- "description": "Only get shares with the current user",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "reshares",
- "in": "query",
- "description": "Only get shares by the current user and reshares",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "subfiles",
- "in": "query",
- "description": "Only get all shares in a folder",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "path",
- "in": "query",
- "description": "Get shares for a specific path",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "include_tags",
- "in": "query",
- "description": "Include tags in the share",
- "schema": {
- "type": "string",
- "default": "false"
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "shared_with_me": {
+ "type": "string",
+ "default": "false",
+ "description": "Only get shares with the current user"
+ },
+ "reshares": {
+ "type": "string",
+ "default": "false",
+ "description": "Only get shares by the current user and reshares"
+ },
+ "subfiles": {
+ "type": "string",
+ "default": "false",
+ "description": "Only get all shares in a folder"
+ },
+ "path": {
+ "type": "string",
+ "default": "",
+ "description": "Get shares for a specific path"
+ },
+ "include_tags": {
+ "type": "string",
+ "default": "false",
+ "description": "Include tags in the share"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
@@ -1712,108 +1692,76 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "path",
- "in": "query",
- "description": "Path of the share",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "permissions",
- "in": "query",
- "description": "Permissions for the share",
- "schema": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- },
- {
- "name": "shareType",
- "in": "query",
- "description": "Type of the share",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": -1
- }
- },
- {
- "name": "shareWith",
- "in": "query",
- "description": "The entity this should be shared with",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "publicUpload",
- "in": "query",
- "description": "If public uploading is allowed",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "Password for the share",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "sendPasswordByTalk",
- "in": "query",
- "description": "Send the password for the share over Talk",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "expireDate",
- "in": "query",
- "description": "The expiry date of the share in the user's timezone at 00:00. If $expireDate is not supplied or set to `null`, the system default will be used.",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "note",
- "in": "query",
- "description": "Note for the share",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "label",
- "in": "query",
- "description": "Label for the share (only used in link and email)",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "attributes",
- "in": "query",
- "description": "Additional attributes for the share",
- "schema": {
- "type": "string",
- "nullable": true
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "nullable": true,
+ "description": "Path of the share"
+ },
+ "permissions": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true,
+ "description": "Permissions for the share"
+ },
+ "shareType": {
+ "type": "integer",
+ "format": "int64",
+ "default": -1,
+ "description": "Type of the share"
+ },
+ "shareWith": {
+ "type": "string",
+ "nullable": true,
+ "description": "The entity this should be shared with"
+ },
+ "publicUpload": {
+ "type": "string",
+ "default": "false",
+ "description": "If public uploading is allowed"
+ },
+ "password": {
+ "type": "string",
+ "default": "",
+ "description": "Password for the share"
+ },
+ "sendPasswordByTalk": {
+ "type": "string",
+ "nullable": true,
+ "description": "Send the password for the share over Talk"
+ },
+ "expireDate": {
+ "type": "string",
+ "nullable": true,
+ "description": "The expiry date of the share in the user's timezone at 00:00.\n If $expireDate is not supplied or set to `null`, the system default will be used."
+ },
+ "note": {
+ "type": "string",
+ "default": "",
+ "description": "Note for the share"
+ },
+ "label": {
+ "type": "string",
+ "default": "",
+ "description": "Label for the share (only used in link and email)"
+ },
+ "attributes": {
+ "type": "string",
+ "nullable": true,
+ "description": "Additional attributes for the share"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
@@ -1958,16 +1906,26 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "path",
- "in": "query",
- "description": "Path all shares will be relative to",
- "required": true,
- "schema": {
- "type": "string"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "path"
+ ],
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Path all shares will be relative to"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
@@ -2133,20 +2091,24 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "include_tags",
- "in": "query",
- "description": "Include tags in the share",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "include_tags": {
+ "type": "boolean",
+ "default": false,
+ "description": "Include tags in the share"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "id",
"in": "path",
@@ -2242,89 +2204,65 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "permissions",
- "in": "query",
- "description": "New permissions",
- "schema": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "New password",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "sendPasswordByTalk",
- "in": "query",
- "description": "New condition if the password should be send over Talk",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "publicUpload",
- "in": "query",
- "description": "New condition if public uploading is allowed",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "expireDate",
- "in": "query",
- "description": "New expiry date",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "note",
- "in": "query",
- "description": "New note",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "label",
- "in": "query",
- "description": "New label",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "hideDownload",
- "in": "query",
- "description": "New condition if the download should be hidden",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "attributes",
- "in": "query",
- "description": "New additional attributes",
- "schema": {
- "type": "string",
- "nullable": true
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true,
+ "description": "New permissions"
+ },
+ "password": {
+ "type": "string",
+ "nullable": true,
+ "description": "New password"
+ },
+ "sendPasswordByTalk": {
+ "type": "string",
+ "nullable": true,
+ "description": "New condition if the password should be send over Talk"
+ },
+ "publicUpload": {
+ "type": "string",
+ "nullable": true,
+ "description": "New condition if public uploading is allowed"
+ },
+ "expireDate": {
+ "type": "string",
+ "nullable": true,
+ "description": "New expiry date"
+ },
+ "note": {
+ "type": "string",
+ "nullable": true,
+ "description": "New note"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true,
+ "description": "New label"
+ },
+ "hideDownload": {
+ "type": "string",
+ "nullable": true,
+ "description": "New condition if the download should be hidden"
+ },
+ "attributes": {
+ "type": "string",
+ "nullable": true,
+ "description": "New additional attributes"
+ }
+ }
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "id",
"in": "path",
@@ -2884,79 +2822,63 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "search",
- "in": "query",
- "description": "Text to search for",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "itemType",
- "in": "query",
- "description": "Limit to specific item types",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "page",
- "in": "query",
- "description": "Page offset for searching",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 1
- }
- },
- {
- "name": "perPage",
- "in": "query",
- "description": "Limit amount of search results per page",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 200
- }
- },
- {
- "name": "shareType",
- "in": "query",
- "description": "Limit to specific share types",
- "schema": {
- "nullable": true,
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "array",
- "items": {
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "search": {
+ "type": "string",
+ "default": "",
+ "description": "Text to search for"
+ },
+ "itemType": {
+ "type": "string",
+ "nullable": true,
+ "description": "Limit to specific item types"
+ },
+ "page": {
"type": "integer",
- "format": "int64"
+ "format": "int64",
+ "default": 1,
+ "description": "Page offset for searching"
+ },
+ "perPage": {
+ "type": "integer",
+ "format": "int64",
+ "default": 200,
+ "description": "Limit amount of search results per page"
+ },
+ "shareType": {
+ "nullable": true,
+ "description": "Limit to specific share types",
+ "oneOf": [
+ {
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ]
+ },
+ "lookup": {
+ "type": "boolean",
+ "default": false,
+ "description": "If a global lookup should be performed too"
}
}
- ]
- }
- },
- {
- "name": "lookup",
- "in": "query",
- "description": "If a global lookup should be performed too",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
@@ -3052,37 +2974,43 @@
"basic_auth": []
}
],
- "parameters": [
- {
- "name": "itemType",
- "in": "query",
- "description": "Limit to specific item types",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "shareType",
- "in": "query",
- "description": "Limit to specific share types",
- "schema": {
- "nullable": true,
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "itemType"
+ ],
+ "properties": {
+ "itemType": {
+ "type": "string",
+ "description": "Limit to specific item types"
+ },
+ "shareType": {
+ "nullable": true,
+ "description": "Limit to specific share types",
+ "oneOf": [
+ {
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ]
}
}
- ]
+ }
}
- },
+ }
+ },
+ "parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
@@ -3677,4 +3605,4 @@
"description": "Class ExternalSharesController"
}
]
-} \ No newline at end of file
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-30 21:45:45 +0000