upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-02-03 20:41:22 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 37
nextcloud/apps/files_sharing/openapi.json

4553 lines
190 KiB
JSON
Raw Normal View History

Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"openapi": "3.0.3",
"info": {
"title": "files_sharing",
"version": "0.0.1",
"description": "File sharing",
"license": {
"name": "agpl"
}
},
"components": {
"securitySchemes": {
"basic_auth": {
"type": "http",
"scheme": "basic"
},
"bearer_auth": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"Capabilities": {
"type": "object",
"required": [
"files_sharing"
],
"properties": {
"files_sharing": {
"type": "object",
"required": [
"api_enabled",
"public",
"user",
"resharing",
"federation",
"sharee"
],
"properties": {
"api_enabled": {
"type": "boolean"
},
"public": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "object",
"required": [
"enforced",
"askForOptionalPassword"
],
"properties": {
"enforced": {
"type": "boolean"
},
"askForOptionalPassword": {
"type": "boolean"
}
}
},
"multiple_links": {
"type": "boolean"
},
"expire_date": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"days": {
"type": "integer",
"format": "int64"
},
"enforced": {
"type": "boolean"
}
}
},
"expire_date_internal": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"days": {
"type": "integer",
"format": "int64"
},
"enforced": {
"type": "boolean"
}
}
},
"expire_date_remote": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"days": {
"type": "integer",
"format": "int64"
},
"enforced": {
"type": "boolean"
}
}
},
"send_mail": {
"type": "boolean"
},
"upload": {
"type": "boolean"
},
"upload_files_drop": {
"type": "boolean"
chore(openapi): Update capabilities spec Signed-off-by: Christopher Ng <chrng8@gmail.com>
2024-12-16 18:53:12 -05:00
},
"custom_tokens": {
"type": "boolean"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"user": {
"type": "object",
"required": [
"send_mail"
],
"properties": {
"send_mail": {
"type": "boolean"
},
"expire_date": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
}
}
}
},
"resharing": {
"type": "boolean"
},
"group_sharing": {
"type": "boolean"
},
"group": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"expire_date": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
}
}
}
},
"default_permissions": {
"type": "integer",
"format": "int64"
},
"federation": {
"type": "object",
"required": [
"outgoing",
"incoming",
"expire_date",
"expire_date_supported"
],
"properties": {
"outgoing": {
"type": "boolean"
},
"incoming": {
"type": "boolean"
},
"expire_date": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"expire_date_supported": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
}
}
}
},
"sharee": {
"type": "object",
"required": [
"query_lookup_default",
"always_show_unique"
],
"properties": {
"query_lookup_default": {
"type": "boolean"
},
"always_show_unique": {
"type": "boolean"
}
}
}
}
}
}
},
"DeletedShare": {
"type": "object",
"required": [
"id",
"share_type",
"uid_owner",
"displayname_owner",
"permissions",
"stime",
"uid_file_owner",
"displayname_file_owner",
"path",
"item_type",
"mimetype",
"storage",
"item_source",
"file_source",
"file_parent",
"file_target",
"expiration",
"share_with",
"share_with_displayname",
"share_with_link"
],
"properties": {
"id": {
"type": "string"
},
"share_type": {
"type": "integer",
"format": "int64"
},
"uid_owner": {
"type": "string"
},
"displayname_owner": {
"type": "string"
},
"permissions": {
"type": "integer",
"format": "int64"
},
"stime": {
"type": "integer",
"format": "int64"
},
"uid_file_owner": {
"type": "string"
},
"displayname_file_owner": {
"type": "string"
},
"path": {
"type": "string"
},
"item_type": {
"type": "string"
},
"mimetype": {
"type": "string"
},
"storage": {
"type": "integer",
"format": "int64"
},
"item_source": {
"type": "integer",
"format": "int64"
},
"file_source": {
"type": "integer",
"format": "int64"
},
"file_parent": {
"type": "integer",
"format": "int64"
},
"file_target": {
"type": "integer",
"format": "int64"
},
"expiration": {
"type": "string",
"nullable": true
},
"share_with": {
"type": "string",
"nullable": true
},
"share_with_displayname": {
"type": "string",
"nullable": true
},
"share_with_link": {
"type": "string",
"nullable": true
}
}
},
"Lookup": {
"type": "object",
"required": [
"value",
"verified"
],
"properties": {
"value": {
"type": "string"
},
"verified": {
"type": "integer",
"format": "int64"
}
}
},
"OCSMeta": {
"type": "object",
"required": [
"status",
"statuscode"
],
"properties": {
"status": {
"type": "string"
},
"statuscode": {
"type": "integer"
},
"message": {
"type": "string"
},
"totalitems": {
"type": "string"
},
"itemsperpage": {
"type": "string"
}
}
},
"RemoteShare": {
"type": "object",
"required": [
"accepted",
"file_id",
"id",
"mimetype",
"mountpoint",
"mtime",
"name",
"owner",
"parent",
"permissions",
"remote",
"remote_id",
"share_token",
"share_type",
"type",
"user"
],
"properties": {
"accepted": {
fix(openapi): Fix returned types from external share We always been returning an int for for accepted, but since it was returned as a mixed from the DB, psalm never complained about the fact this was typed as a bool in the API doc. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-12-10 05:05:40 -05:00
"type": "integer",
"format": "int64"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"file_id": {
"type": "integer",
"format": "int64",
"nullable": true
},
"id": {
perf(external-sharing): Port to Entity and SnowflakeId This removes all the read after write and we don't need to queries all the time the same share in the same request anymore. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-10-29 11:50:50 -04:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"mimetype": {
"type": "string",
"nullable": true
},
"mountpoint": {
"type": "string"
},
"mtime": {
"type": "integer",
"format": "int64",
"nullable": true
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"parent": {
perf(external-sharing): Port to Entity and SnowflakeId This removes all the read after write and we don't need to queries all the time the same share in the same request anymore. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-10-29 11:50:50 -04:00
"type": "string",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"nullable": true
},
"permissions": {
"type": "integer",
"format": "int64",
"nullable": true
},
"remote": {
"type": "string"
},
"remote_id": {
"type": "string"
},
"share_token": {
"type": "string"
},
"share_type": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"nullable": true
},
"user": {
"type": "string"
}
}
},
"Share": {
"type": "object",
"required": [
"attributes",
"can_delete",
"can_edit",
"displayname_file_owner",
"displayname_owner",
"expiration",
"file_parent",
"file_source",
"file_target",
"has_preview",
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"hide_download",
fix: Display 'Leave share' instead of 'Delete' Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2024-08-20 05:31:21 -04:00
"is-mount-root",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"id",
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"item_mtime",
"item_size",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"item_source",
"item_type",
"label",
"mail_send",
"mimetype",
fix: Display 'Leave share' instead of 'Delete' Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2024-08-20 05:31:21 -04:00
"mount-type",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"note",
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"parent",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"path",
"permissions",
"share_type",
"stime",
"storage",
"storage_id",
"token",
"uid_file_owner",
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"uid_owner"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
],
"properties": {
"attributes": {
"type": "string",
"nullable": true
},
"can_delete": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"displayname_file_owner": {
"type": "string"
},
"displayname_owner": {
"type": "string"
},
"expiration": {
"type": "string",
"nullable": true
},
"file_parent": {
"type": "integer",
"format": "int64"
},
"file_source": {
"type": "integer",
"format": "int64"
},
"file_target": {
"type": "string"
},
"has_preview": {
"type": "boolean"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"hide_download": {
"type": "integer",
chore(deps): Update openapi-extractor Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-12-08 05:06:05 -05:00
"format": "int64",
"enum": [
0,
1
]
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
},
feat(files_sharing): Toggle display for trusted server shares Signed-off-by: nfebe <fenn25.fn@gmail.com>
2025-06-24 08:16:22 -04:00
"is_trusted_server": {
"type": "boolean"
},
fix: Display 'Leave share' instead of 'Delete' Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2024-08-20 05:31:21 -04:00
"is-mount-root": {
"type": "boolean"
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"id": {
"type": "string"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"item_mtime": {
"type": "integer",
"format": "int64"
},
"item_permissions": {
"type": "integer",
"format": "int64"
},
"item_size": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-15 03:10:59 -04:00
"anyOf": [
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
{
"type": "number",
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-15 03:10:59 -04:00
"format": "double"
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
},
{
"type": "integer",
"format": "int64"
}
]
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"item_source": {
"type": "integer",
"format": "int64"
},
"item_type": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"type": "string",
"enum": [
"file",
"folder"
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"label": {
revert: "fix(files_sharing): Make share labels nullable" This reverts commit 01c4fa3ba8a7311da331e6a2b70fc866b0a9b39c. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2024-10-14 09:16:13 -04:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"mail_send": {
"type": "integer",
chore(deps): Update openapi-extractor Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-12-08 05:06:05 -05:00
"format": "int64",
"enum": [
0,
1
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"mimetype": {
"type": "string"
},
fix: Display 'Leave share' instead of 'Delete' Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2024-08-20 05:31:21 -04:00
"mount-type": {
"type": "string"
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"note": {
"type": "string"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"parent": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"nullable": true
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"password": {
fix: public dav and files_sharing testing fixes Signed-off-by: John Molakvoæ <skjnldsv@protonmail.com>
2022-10-28 09:05:07 -04:00
"type": "string",
"nullable": true
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"password_expiration_time": {
"type": "string",
"nullable": true
},
"path": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"type": "string",
"nullable": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"permissions": {
"type": "integer",
"format": "int64"
},
"send_password_by_talk": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"type": "boolean"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"share_type": {
"type": "integer",
"format": "int64"
},
"share_with": {
fix: public dav and files_sharing testing fixes Signed-off-by: John Molakvoæ <skjnldsv@protonmail.com>
2022-10-28 09:05:07 -04:00
"type": "string",
"nullable": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"share_with_avatar": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"share_with_displayname": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"type": "string"
},
"share_with_displayname_unique": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"type": "string",
"nullable": true
},
"share_with_link": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"status": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"type": "object",
fix: public dav and files_sharing testing fixes Signed-off-by: John Molakvoæ <skjnldsv@protonmail.com>
2022-10-28 09:05:07 -04:00
"required": [
"clearAt",
"icon",
"message",
"status"
],
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"properties": {
"clearAt": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"type": "integer",
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"format": "int64",
"nullable": true
},
"icon": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"status": {
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"stime": {
"type": "integer",
"format": "int64"
},
"storage": {
"type": "integer",
"format": "int64"
},
"storage_id": {
"type": "string"
},
"token": {
"type": "string",
"nullable": true
},
"uid_file_owner": {
"type": "string"
},
"uid_owner": {
"type": "string"
},
"url": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"ShareInfo": {
"type": "object",
"required": [
"id",
"parentId",
"mtime",
"name",
"permissions",
"mimetype",
"size",
"type",
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"etag"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
],
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"parentId": {
"type": "integer",
"format": "int64"
},
"mtime": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"permissions": {
"type": "integer",
"format": "int64"
},
"mimetype": {
"type": "string"
},
"size": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-15 03:10:59 -04:00
"anyOf": [
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
{
"type": "integer",
"format": "int64"
},
{
"type": "number",
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-15 03:10:59 -04:00
"format": "double"
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"type": {
"type": "string"
},
"etag": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
},
"Sharee": {
"type": "object",
"required": [
"label"
],
"properties": {
"label": {
"type": "string"
}
}
},
"ShareeCircle": {
"allOf": [
{
"$ref": "#/components/schemas/Sharee"
},
{
"type": "object",
"required": [
"shareWithDescription",
"value"
],
"properties": {
"shareWithDescription": {
"type": "string"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/ShareeValue"
},
{
"type": "object",
"required": [
"circle"
],
"properties": {
"circle": {
"type": "string"
}
}
}
]
}
}
}
]
},
"ShareeEmail": {
"allOf": [
{
"$ref": "#/components/schemas/Sharee"
},
{
"type": "object",
"required": [
"uuid",
"name",
"type",
"shareWithDisplayNameUnique",
"value"
],
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"shareWithDisplayNameUnique": {
"type": "string"
},
"value": {
"$ref": "#/components/schemas/ShareeValue"
}
}
}
]
},
fix(files_sharing): Fix sharee search result types Signed-off-by: provokateurin <kate@provokateurin.de>
2025-01-06 06:47:57 -05:00
"ShareeGroup": {
"allOf": [
{
"$ref": "#/components/schemas/Sharee"
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"$ref": "#/components/schemas/ShareeValue"
}
}
}
]
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"ShareeLookup": {
"allOf": [
{
"$ref": "#/components/schemas/Sharee"
},
{
"type": "object",
"required": [
"extra",
"value"
],
"properties": {
"extra": {
"type": "object",
"required": [
"federationId",
"name",
"email",
"address",
"website",
"twitter",
"phone",
"twitter_signature",
"website_signature",
"userid"
],
"properties": {
"federationId": {
"type": "string"
},
"name": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"email": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"address": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"website": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"twitter": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"phone": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"twitter_signature": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"website_signature": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
},
"userid": {
chore(deps): bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.8.0 to 1.8.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.8.0...v1.8.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-version: 1.8.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2025-07-25 21:26:52 -04:00
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Lookup"
}
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/ShareeValue"
},
{
"type": "object",
"required": [
"globalScale"
],
"properties": {
"globalScale": {
"type": "boolean"
}
}
}
]
}
}
}
]
},
"ShareeRemote": {
"allOf": [
{
"$ref": "#/components/schemas/Sharee"
},
{
"type": "object",
"required": [
"uuid",
"name",
"type",
"value"
],
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/ShareeValue"
},
{
"type": "object",
"required": [
"server"
],
"properties": {
"server": {
"type": "string"
}
}
}
]
}
}
}
]
},
"ShareeRemoteGroup": {
"allOf": [
{
"$ref": "#/components/schemas/Sharee"
},
{
"type": "object",
"required": [
"guid",
"name",
"value"
],
"properties": {
"guid": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/ShareeValue"
},
{
"type": "object",
"required": [
"server"
],
"properties": {
"server": {
"type": "string"
}
}
}
]
}
}
}
]
},
fix(files_sharing): Fix sharee search result types Signed-off-by: provokateurin <kate@provokateurin.de>
2025-01-06 06:47:57 -05:00
"ShareeRoom": {
"allOf": [
{
"$ref": "#/components/schemas/Sharee"
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"$ref": "#/components/schemas/ShareeValue"
}
}
}
]
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"ShareeUser": {
"allOf": [
{
"$ref": "#/components/schemas/Sharee"
},
{
"type": "object",
"required": [
"subline",
"icon",
"shareWithDisplayNameUnique",
"status",
"value"
],
"properties": {
"subline": {
"type": "string"
},
"icon": {
"type": "string"
},
"shareWithDisplayNameUnique": {
"type": "string"
},
"status": {
"type": "object",
"required": [
"status",
"message",
"icon",
"clearAt"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"icon": {
"type": "string"
},
"clearAt": {
"type": "integer",
"format": "int64",
"nullable": true
}
}
},
"value": {
"$ref": "#/components/schemas/ShareeValue"
}
}
}
]
},
"ShareeValue": {
"type": "object",
"required": [
"shareType",
"shareWith"
],
"properties": {
"shareType": {
"type": "integer",
"format": "int64"
},
"shareWith": {
"type": "string"
}
}
},
"ShareesRecommendedResult": {
"type": "object",
"required": [
"exact",
"emails",
"groups",
"remote_groups",
"remotes",
"users"
],
"properties": {
"exact": {
"type": "object",
"required": [
"emails",
"groups",
"remote_groups",
"remotes",
"users"
],
"properties": {
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeEmail"
}
},
"groups": {
"type": "array",
"items": {
fix(files_sharing): Fix sharee search result types Signed-off-by: provokateurin <kate@provokateurin.de>
2025-01-06 06:47:57 -05:00
"$ref": "#/components/schemas/ShareeGroup"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
"remote_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeRemoteGroup"
}
},
"remotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeRemote"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeUser"
}
}
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeEmail"
}
},
"groups": {
"type": "array",
"items": {
fix(files_sharing): Fix sharee search result types Signed-off-by: provokateurin <kate@provokateurin.de>
2025-01-06 06:47:57 -05:00
"$ref": "#/components/schemas/ShareeGroup"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
"remote_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeRemoteGroup"
}
},
"remotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeRemote"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeUser"
}
}
}
},
"ShareesSearchResult": {
"type": "object",
"required": [
"exact",
"circles",
"emails",
"groups",
"lookup",
"remote_groups",
"remotes",
"rooms",
"users",
"lookupEnabled"
],
"properties": {
"exact": {
"type": "object",
"required": [
"circles",
"emails",
"groups",
"remote_groups",
"remotes",
"rooms",
"users"
],
"properties": {
"circles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeCircle"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeEmail"
}
},
"groups": {
"type": "array",
"items": {
fix(files_sharing): Fix sharee search result types Signed-off-by: provokateurin <kate@provokateurin.de>
2025-01-06 06:47:57 -05:00
"$ref": "#/components/schemas/ShareeGroup"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
"remote_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeRemoteGroup"
}
},
"remotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeRemote"
}
},
"rooms": {
"type": "array",
"items": {
fix(files_sharing): Fix sharee search result types Signed-off-by: provokateurin <kate@provokateurin.de>
2025-01-06 06:47:57 -05:00
"$ref": "#/components/schemas/ShareeRoom"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeUser"
}
}
}
},
"circles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeCircle"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeEmail"
}
},
"groups": {
"type": "array",
"items": {
fix(files_sharing): Fix sharee search result types Signed-off-by: provokateurin <kate@provokateurin.de>
2025-01-06 06:47:57 -05:00
"$ref": "#/components/schemas/ShareeGroup"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
"lookup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeLookup"
}
},
"remote_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeRemoteGroup"
}
},
"remotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeRemote"
}
},
"rooms": {
"type": "array",
"items": {
fix(files_sharing): Fix sharee search result types Signed-off-by: provokateurin <kate@provokateurin.de>
2025-01-06 06:47:57 -05:00
"$ref": "#/components/schemas/ShareeRoom"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareeUser"
}
},
"lookupEnabled": {
"type": "boolean"
}
}
}
}
},
"paths": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"/index.php/s/{token}/preview": {
"get": {
"operationId": "public_preview-direct-link",
"summary": "Get a direct link preview for a shared file",
"tags": [
"public_preview"
],
"security": [
{},
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "token",
"in": "path",
"description": "Token of the share",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Preview returned",
"content": {
"*/*": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Getting preview is not possible",
"content": {
"application/json": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-01-18 09:56:09 -05:00
"schema": {}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
}
},
"403": {
"description": "Getting preview is not allowed",
"content": {
"application/json": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-01-18 09:56:09 -05:00
"schema": {}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
}
},
"404": {
"description": "Share or preview not found",
"content": {
"application/json": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-01-18 09:56:09 -05:00
"schema": {}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
}
}
}
}
},
"/index.php/apps/files_sharing/publicpreview/{token}": {
"get": {
"operationId": "public_preview-get-preview",
"summary": "Get a preview for a shared file",
"tags": [
"public_preview"
],
"security": [
{},
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"parameters": [
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
{
"name": "token",
"in": "path",
"description": "Token of the share",
"required": true,
"schema": {
"type": "string"
}
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
},
{
"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": {
chore(deps): Update nextcloud/openapi-extractor to v1.8.3 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-09-01 10:03:07 -04:00
"type": "boolean",
"default": false
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
}
fix(files_sharing): add mime fallback to public preview too Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
2025-05-13 10:13:00 -04:00
},
{
"name": "mimeFallback",
"in": "query",
"description": "Whether to fallback to the mime icon if no preview is available",
"schema": {
chore(deps): Update nextcloud/openapi-extractor to v1.8.3 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-09-01 10:03:07 -04:00
"type": "boolean",
"default": false
fix(files_sharing): add mime fallback to public preview too Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
2025-05-13 10:13:00 -04:00
}
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
},
{
chore: update openAPI files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-09 11:39:23 -04:00
"name": "x-nc-preview",
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"in": "header",
"schema": {
"type": "string"
}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
],
"responses": {
"200": {
"description": "Preview returned",
"content": {
"*/*": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Getting preview is not possible",
"content": {
"application/json": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-01-18 09:56:09 -05:00
"schema": {}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
}
},
"403": {
"description": "Getting preview is not allowed",
"content": {
"application/json": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-01-18 09:56:09 -05:00
"schema": {}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
}
},
"404": {
"description": "Share or preview not found",
"content": {
"application/json": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-01-18 09:56:09 -05:00
"schema": {}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
}
fix(files_sharing): add mime fallback to public preview too Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
2025-05-13 10:13:00 -04:00
},
"303": {
"description": "Redirect to the mime icon url if mimeFallback is true",
"headers": {
"Location": {
"schema": {
"type": "string"
}
}
}
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
}
}
}
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"/index.php/apps/files_sharing/shareinfo": {
"post": {
"operationId": "share_info-info",
"summary": "Get the info about a share",
"tags": [
"share_info"
],
"security": [
{},
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"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,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "Password of the share"
},
"dir": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "Subdirectory to get info about"
},
"depth": {
"type": "integer",
"format": "int64",
"default": -1,
"description": "Maximum depth to get info about"
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"responses": {
"200": {
"description": "Share info returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShareInfo"
}
}
}
},
"403": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"description": "Getting share info is not allowed",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"content": {
"application/json": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"schema": {}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"404": {
"description": "Share not found",
"content": {
"application/json": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"schema": {}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/shares": {
"get": {
"operationId": "shareapi-get-shares",
"summary": "Get shares of the current user",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"parameters": [
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
{
"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"
}
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Shares 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/Share"
}
}
}
}
}
}
}
}
},
"404": {
"description": "The folder was not found or is inaccessible",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"post": {
"operationId": "shareapi-create-share",
"summary": "Create a share",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"path": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "Path of the share"
},
"permissions": {
"type": "integer",
"format": "int64",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "Permissions for the share"
},
"shareType": {
"type": "integer",
"format": "int64",
"default": -1,
"description": "Type of the share"
},
"shareWith": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "The entity this should be shared with"
},
"publicUpload": {
"type": "string",
fix(files_sharing): Respect permissions passed when creating link shares Given: User creates a link or email share with permissions=4 (create only = file drop). Problem: Currently the permissions are automatically extended to permissions = 5 (READ + CREATE). Work around was to create the share and directly update it. Solution: Respect what the user is requesting, create a file drop share. Co-authored-by: Ferdinand Thiessen <opensource@fthiessen.de> Co-authored-by: Côme Chilliet <91878298+come-nc@users.noreply.github.com> Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-01-20 07:03:45 -05:00
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
fix(files_sharing): Respect permissions passed when creating link shares Given: User creates a link or email share with permissions=4 (create only = file drop). Problem: Currently the permissions are automatically extended to permissions = 5 (READ + CREATE). Work around was to create the share and directly update it. Solution: Respect what the user is requesting, create a file drop share. Co-authored-by: Ferdinand Thiessen <opensource@fthiessen.de> Co-authored-by: Côme Chilliet <91878298+come-nc@users.noreply.github.com> Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-01-20 07:03:45 -05:00
"enum": [
"true",
"false"
],
"description": "If public uploading is allowed (deprecated)"
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
},
"password": {
"type": "string",
"default": "",
"description": "Password for the share"
},
"sendPasswordByTalk": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "Send the password for the share over Talk"
},
"expireDate": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.0.0 to 1.0.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.0.0...v1.0.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2024-10-18 22:06:03 -04:00
"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."
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
},
"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,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "Additional attributes for the share"
fix(files_sharing): phpunit & openapi fixes Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
2024-07-09 09:38:33 -04:00
},
"sendMail": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
fix(files_sharing): phpunit & openapi fixes Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
2024-07-09 09:38:33 -04:00
"enum": [
"false",
"true"
],
"description": "Send a mail to the recipient"
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
}
},
"parameters": [
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share created",
"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/Share"
}
}
}
}
}
}
}
},
"400": {
"description": "Unknown share type",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"403": {
"description": "Creating the share is not allowed",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"404": {
"description": "Creating the share failed",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/shares/inherited": {
"get": {
"operationId": "shareapi-get-inherited-shares",
"summary": "Get all shares relative to a file, including parent folders shares rights",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"parameters": [
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
{
"name": "path",
"in": "query",
"description": "Path all shares will be relative to",
"required": true,
"schema": {
"type": "string"
}
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Shares 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/Share"
}
}
}
}
}
}
}
}
},
"500": {
"description": "",
"content": {
"text/plain": {
"schema": {
openapi: Fix wrapping OCS responses that are not DataResponse Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-06-05 02:29:29 -04:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"404": {
"description": "The given path is invalid",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/shares/pending": {
"get": {
"operationId": "shareapi-pending-shares",
"summary": "Get all shares that are still pending",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
Add single status code descriptions for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-19 08:12:17 -04:00
"description": "Pending shares returned",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"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/Share"
}
}
}
}
}
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}": {
"get": {
"operationId": "shareapi-get-share",
"summary": "Get a specific share by id",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"parameters": [
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"name": "id",
"in": "path",
"description": "ID of the share",
"required": true,
"schema": {
"type": "string"
}
},
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
{
"name": "include_tags",
"in": "query",
"description": "Include tags in the share",
"schema": {
chore(deps): Update nextcloud/openapi-extractor to v1.8.3 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-09-01 10:03:07 -04:00
"type": "boolean",
"default": false
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
}
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share returned",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
fix(OpenAPI): Adjust array syntax to avoid ambiguities Signed-off-by: provokateurin <kate@provokateurin.de>
2024-09-24 09:53:13 -04:00
"type": "array",
"items": {
"$ref": "#/components/schemas/Share"
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"put": {
"operationId": "shareapi-update-share",
"summary": "Update a share",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"permissions": {
"type": "integer",
"format": "int64",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New permissions"
},
"password": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New password"
},
"sendPasswordByTalk": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New condition if the password should be send over Talk"
},
"publicUpload": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New condition if public uploading is allowed"
},
"expireDate": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New expiry date"
},
"note": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New note"
},
"label": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New label"
},
"hideDownload": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New condition if the download should be hidden"
},
"attributes": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"description": "New additional attributes"
fix(files_sharing): phpunit & openapi fixes Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
2024-07-09 09:38:33 -04:00
},
"sendMail": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Bump nextcloud/openapi-extractor Bumps [nextcloud/openapi-extractor](https://github.com/nextcloud-releases/openapi-extractor) from 1.0.0 to 1.0.1. - [Changelog](https://github.com/nextcloud-releases/openapi-extractor/blob/main/CHANGELOG.md) - [Commits](https://github.com/nextcloud-releases/openapi-extractor/compare/v1.0.0...v1.0.1) --- updated-dependencies: - dependency-name: nextcloud/openapi-extractor dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: provokateurin <kate@provokateurin.de>
2024-10-18 22:06:03 -04:00
"description": "if the share should be send by mail. Considering the share already exists, no mail will be send after the share is updated. You will have to use the sendMail action to send the mail."
chore(openapi): Update spec Signed-off-by: Christopher Ng <chrng8@gmail.com>
2024-12-16 18:53:12 -05:00
},
"token": {
"type": "string",
"nullable": true,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(openapi): Update spec Signed-off-by: Christopher Ng <chrng8@gmail.com>
2024-12-16 18:53:12 -05:00
"description": "New token"
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
}
},
"parameters": [
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"name": "id",
"in": "path",
"description": "ID of the share",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"$ref": "#/components/schemas/Share"
}
}
}
}
}
}
}
},
"400": {
"description": "Share could not be updated because the requested changes are invalid",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"403": {
"description": "Missing permissions to update the share",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"delete": {
"operationId": "shareapi-delete-share",
"summary": "Delete a share",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the share",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"data": {}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"403": {
"description": "Missing permissions to delete the share",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
fix(files_sharing): phpunit & openapi fixes Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
2024-07-09 09:38:33 -04:00
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
fix(files_sharing): phpunit & openapi fixes Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
2024-07-09 09:38:33 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}/send-email": {
"post": {
"operationId": "shareapi-send-share-email",
"summary": "Send a mail notification again for a share. The mail_send option must be enabled for the given share.",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"default": "",
chore(files_sharing): lint & refactor fixes Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
2024-07-12 09:11:10 -04:00
"description": "the password to check against. Necessary for password protected shares."
fix(files_sharing): phpunit & openapi fixes Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
2024-07-09 09:38:33 -04:00
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"description": "the share ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
"required": true,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"404": {
"description": "Share not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"403": {
"description": "You are not allowed to send mail notifications",
"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 request or wrong password",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"200": {
"description": "The email notification was sent successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/shares/pending/{id}": {
"post": {
"operationId": "shareapi-accept-share",
"summary": "Accept a share",
"tags": [
"shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the share",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share accepted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"data": {}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"400": {
"description": "Share could not be accepted",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/deletedshares": {
"get": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-01-18 09:56:09 -05:00
"operationId": "deleted_shareapi-index",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"summary": "Get a list of all deleted shares",
"tags": [
"deleted_shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
Add single status code descriptions for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-19 08:12:17 -04:00
"description": "Deleted shares returned",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"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/DeletedShare"
}
}
}
}
}
}
}
}
},
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/deletedshares/{id}": {
"post": {
"operationId": "deleted_shareapi-undelete",
"summary": "Undelete a deleted share",
"tags": [
"deleted_shareapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"description": "ID of the share",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share undeleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"data": {}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/sharees": {
"get": {
"operationId": "shareesapi-search",
"summary": "Search for sharees",
"tags": [
"shareesapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
"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",
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"nullable": true,
"default": null
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
}
},
{
"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,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
"oneOf": [
{
"type": "integer",
"format": "int64"
},
{
"type": "array",
"items": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
"type": "integer",
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
"format": "int64"
chore(deps): Update openapi-extractor Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-12-08 05:06:05 -05:00
}
}
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
},
{
"name": "lookup",
"in": "query",
"description": "If a global lookup should be performed too",
"schema": {
chore(deps): Update nextcloud/openapi-extractor to v1.8.3 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-09-01 10:03:07 -04:00
"type": "boolean",
"default": false
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
}
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Sharees search result returned",
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"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/ShareesSearchResult"
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid search parameters",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/sharees_recommended": {
"get": {
"operationId": "shareesapi-find-recommended",
"summary": "Find recommended sharees",
"tags": [
"shareesapi"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
"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,
docs: update openAPI extracted files Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2025-06-01 07:39:11 -04:00
"default": null,
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
"oneOf": [
{
"type": "integer",
"format": "int64"
},
{
"type": "array",
"items": {
"type": "integer",
"format": "int64"
chore(deps): Update openapi-extractor Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-12-08 05:06:05 -05:00
}
}
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
]
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
chore(deps): Update openapi-extractor to v1.0.0 Signed-off-by: provokateurin <kate@provokateurin.de>
2024-08-19 05:08:28 -04:00
},
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
Add single status code descriptions for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-19 08:12:17 -04:00
"description": "Recommended sharees returned",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"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/ShareesRecommendedResult"
}
}
}
}
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/remote_shares": {
"get": {
"operationId": "remote-get-shares",
"summary": "Get a list of accepted remote shares",
"tags": [
"remote"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
Add single status code descriptions for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-19 08:12:17 -04:00
"description": "Accepted remote shares returned",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"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/RemoteShare"
}
}
}
}
}
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending": {
"get": {
"operationId": "remote-get-open-shares",
"summary": "Get list of pending remote shares",
"tags": [
"remote"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
Add single status code descriptions for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-19 08:12:17 -04:00
"description": "Pending remote shares returned",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"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/RemoteShare"
}
}
}
}
}
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/{id}": {
"post": {
"operationId": "remote-accept-share",
perf(external-sharing): Port to Entity and SnowflakeId This removes all the read after write and we don't need to queries all the time the same share in the same request anymore. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-10-29 11:50:50 -04:00
"summary": "Accept a remote share.",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"tags": [
"remote"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the share",
"required": true,
"schema": {
perf(external-sharing): Port to Entity and SnowflakeId This removes all the read after write and we don't need to queries all the time the same share in the same request anymore. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-10-29 11:50:50 -04:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share accepted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"data": {}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"delete": {
"operationId": "remote-decline-share",
perf(external-sharing): Port to Entity and SnowflakeId This removes all the read after write and we don't need to queries all the time the same share in the same request anymore. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-10-29 11:50:50 -04:00
"summary": "Decline a remote share.",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"tags": [
"remote"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the share",
"required": true,
"schema": {
perf(external-sharing): Port to Entity and SnowflakeId This removes all the read after write and we don't need to queries all the time the same share in the same request anymore. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-10-29 11:50:50 -04:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share declined successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"data": {}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/{id}": {
"get": {
"operationId": "remote-get-share",
"summary": "Get info of a remote share",
"tags": [
"remote"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the share",
"required": true,
"schema": {
perf(external-sharing): Port to Entity and SnowflakeId This removes all the read after write and we don't need to queries all the time the same share in the same request anymore. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-10-29 11:50:50 -04:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share 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/RemoteShare"
}
}
}
}
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
},
"delete": {
"operationId": "remote-unshare",
"summary": "Unshare a remote share",
"tags": [
"remote"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the share",
"required": true,
"schema": {
perf(external-sharing): Port to Entity and SnowflakeId This removes all the read after write and we don't need to queries all the time the same share in the same request anymore. Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>
2025-10-29 11:50:50 -04:00
"type": "string"
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"description": "Required to be true for the API request to pass",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"required": true,
"schema": {
Fix OCS-APIRequest header for OpenAPI Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-09-27 04:22:20 -04:00
"type": "boolean",
"default": true
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
],
"responses": {
"200": {
"description": "Share unshared successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"data": {}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
}
}
}
},
"404": {
"description": "Share not found",
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
},
"403": {
files_sharing: Add OpenAPI spec Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-02-15 13:22:09 -05:00
"description": "Unsharing is not possible",
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"content": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"application/json": {
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
"schema": {
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-04-08 14:09:24 -04:00
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
}
}
chore(openapi): Update spec Signed-off-by: Christopher Ng <chrng8@gmail.com>
2024-12-16 18:53:12 -05:00
},
"/ocs/v2.php/apps/files_sharing/api/v1/token": {
"get": {
"operationId": "shareapi-generate-token",
"summary": "Get a unique share token",
"tags": [
"shareapi"
],
"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": "Token generated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string"
}
}
}
}
}
}
}
}
}
chore(deps): Update nextcloud/openapi-extractor to v1.8.2 Signed-off-by: provokateurin <kate@provokateurin.de>
2025-08-26 04:21:10 -04:00
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
chore(openapi): Update spec Signed-off-by: Christopher Ng <chrng8@gmail.com>
2024-12-16 18:53:12 -05:00
}
}
}
Add OpenAPI specs Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-05-24 10:34:27 -04:00
}
},
chore: remove legacy action to test remote endpoint Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
2024-11-25 05:17:29 -05:00
"tags": []
chore(deps): Update openapi-extractor Signed-off-by: provokateurin <kate@provokateurin.de>
2024-07-02 03:08:04 -04:00
}
Reference in a new issue Copy permalink