diff options
Diffstat (limited to 'apps')
27 files changed, 2866 insertions, 2608 deletions
diff --git a/apps/cloud_federation_api/openapi.json b/apps/cloud_federation_api/openapi.json index ca20c31d6d9..a6e529d4f89 100644 --- a/apps/cloud_federation_api/openapi.json +++ b/apps/cloud_federation_api/openapi.json @@ -151,107 +151,93 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "shareWith", - "in": "query", - "description": "The user who the share will be shared with", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "in": "query", - "description": "The resource name (e.g. document.odt)", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "description", - "in": "query", - "description": "Share description", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "providerId", - "in": "query", - "description": "Resource UID on the provider side", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "in": "query", - "description": "Provider specific UID of the user who owns the resource", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ownerDisplayName", - "in": "query", - "description": "Display name of the user who shared the item", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "sharedBy", - "in": "query", - "description": "Provider specific UID of the user who shared the resource", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "sharedByDisplayName", - "in": "query", - "description": "Display name of the user who shared the resource", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "protocol", - "in": "query", - "description": "e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "shareType", - "in": "query", - "description": "'group' or 'user' share", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "resourceType", - "in": "query", - "description": "'file', 'calendar',...", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "shareWith", + "name", + "providerId", + "owner", + "protocol", + "shareType", + "resourceType" + ], + "properties": { + "shareWith": { + "type": "string", + "description": "The user who the share will be shared with" + }, + "name": { + "type": "string", + "description": "The resource name (e.g. document.odt)" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Share description" + }, + "providerId": { + "type": "string", + "description": "Resource UID on the provider side" + }, + "owner": { + "type": "string", + "description": "Provider specific UID of the user who owns the resource" + }, + "ownerDisplayName": { + "type": "string", + "nullable": true, + "description": "Display name of the user who shared the item" + }, + "sharedBy": { + "type": "string", + "nullable": true, + "description": "Provider specific UID of the user who shared the resource" + }, + "sharedByDisplayName": { + "type": "string", + "nullable": true, + "description": "Display name of the user who shared the resource" + }, + "protocol": { + "type": "object", + "description": "e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]", + "required": [ + "name", + "options" + ], + "properties": { + "name": { + "type": "array", + "items": { + "type": "string" + } + }, + "options": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "shareType": { + "type": "string", + "description": "'group' or 'user' share" + }, + "resourceType": { + "type": "string", + "description": "'file', 'calendar',..." + } + } + } } } - ], + }, "responses": { "201": { "description": "The notification was successfully received. The display name of the recipient might be returned in the body", @@ -302,44 +288,43 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "notificationType", - "in": "query", - "description": "Notification type, e.g. SHARE_ACCEPTED", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "resourceType", - "in": "query", - "description": "calendar, file, contact,...", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "providerId", - "in": "query", - "description": "ID of the share", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "notification", - "in": "query", - "description": "The actual payload of the notification", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "notificationType", + "resourceType" + ], + "properties": { + "notificationType": { + "type": "string", + "description": "Notification type, e.g. SHARE_ACCEPTED" + }, + "resourceType": { + "type": "string", + "description": "calendar, file, contact,..." + }, + "providerId": { + "type": "string", + "nullable": true, + "description": "ID of the share" + }, + "notification": { + "type": "object", + "nullable": true, + "description": "The actual payload of the notification", + "additionalProperties": { + "type": "object" + } + } + } + } } } - ], + }, "responses": { "201": { "description": "The notification was successfully received", @@ -394,4 +379,4 @@ "description": "Open-Cloud-Mesh-API" } ] -}
\ No newline at end of file +} diff --git a/apps/comments/openapi.json b/apps/comments/openapi.json index b7440a5b526..cadc64da052 100644 --- a/apps/comments/openapi.json +++ b/apps/comments/openapi.json @@ -43,4 +43,4 @@ }, "paths": {}, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/dashboard/openapi.json b/apps/dashboard/openapi.json index c317611ab27..3351e0a3e3c 100644 --- a/apps/dashboard/openapi.json +++ b/apps/dashboard/openapi.json @@ -187,39 +187,43 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "sinceIds", - "in": "query", - "description": "Array indexed by widget Ids, contains date/id from which we want the new items", - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit number of result items per widget", - "schema": { - "type": "integer", - "format": "int64", - "default": 7, - "minimum": 1, - "maximum": 30 - } - }, - { - "name": "widgets[]", - "in": "query", - "description": "Limit results to specific widgets", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "string" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sinceIds": { + "type": "object", + "default": [], + "description": "Array indexed by widget Ids, contains date/id from which we want the new items", + "additionalProperties": { + "type": "string" + } + }, + "limit": { + "type": "integer", + "format": "int64", + "default": 7, + "description": "Limit number of result items per widget", + "minimum": 1, + "maximum": 30 + }, + "widgets": { + "type": "array", + "default": [], + "description": "Limit results to specific widgets", + "items": { + "type": "string" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -286,39 +290,43 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "sinceIds", - "in": "query", - "description": "Array indexed by widget Ids, contains date/id from which we want the new items", - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit number of result items per widget, not more than 30 are allowed", - "schema": { - "type": "integer", - "format": "int64", - "default": 7, - "minimum": 1, - "maximum": 30 - } - }, - { - "name": "widgets[]", - "in": "query", - "description": "Limit results to specific widgets", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "string" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sinceIds": { + "type": "object", + "default": [], + "description": "Array indexed by widget Ids, contains date/id from which we want the new items", + "additionalProperties": { + "type": "string" + } + }, + "limit": { + "type": "integer", + "format": "int64", + "default": 7, + "description": "Limit number of result items per widget, not more than 30 are allowed", + "minimum": 1, + "maximum": 30 + }, + "widgets": { + "type": "array", + "default": [], + "description": "Limit results to specific widgets", + "items": { + "type": "string" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -516,19 +524,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "layout[]", - "in": "query", - "description": "The new layout", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "layout" + ], + "properties": { + "layout": { + "type": "array", + "description": "The new layout", + "items": { + "type": "string" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -670,19 +688,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "statuses[]", - "in": "query", - "description": "The new statuses", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "statuses" + ], + "properties": { + "statuses": { + "type": "array", + "description": "The new statuses", + "items": { + "type": "string" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -741,4 +769,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/dav/openapi.json b/apps/dav/openapi.json index 71cebfa684b..d565035b8ac 100644 --- a/apps/dav/openapi.json +++ b/apps/dav/openapi.json @@ -170,27 +170,33 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "fileId", - "in": "query", - "description": "ID of the file", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "expirationTime", - "in": "query", - "description": "Duration until the link expires", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "fileId", + "expirationTime" + ], + "properties": { + "fileId": { + "type": "integer", + "format": "int64", + "description": "ID of the file" + }, + "expirationTime": { + "type": "integer", + "format": "int64", + "description": "Duration until the link expires" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -541,61 +547,51 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "firstDay", - "in": "query", - "description": "First day of the absence in format `YYYY-MM-DD`", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "lastDay", - "in": "query", - "description": "Last day of the absence in format `YYYY-MM-DD`", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "in": "query", - "description": "Short text that is set as user status during the absence", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "message", - "in": "query", - "description": "Longer multiline message that is shown to others during the absence", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "replacementUserId", - "in": "query", - "description": "User id of the replacement user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "replacementUserDisplayName", - "in": "query", - "description": "Display name of the replacement user", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "firstDay", + "lastDay", + "status", + "message" + ], + "properties": { + "firstDay": { + "type": "string", + "description": "First day of the absence in format `YYYY-MM-DD`" + }, + "lastDay": { + "type": "string", + "description": "Last day of the absence in format `YYYY-MM-DD`" + }, + "status": { + "type": "string", + "description": "Short text that is set as user status during the absence" + }, + "message": { + "type": "string", + "description": "Longer multiline message that is shown to others during the absence" + }, + "replacementUserId": { + "type": "string", + "default": "", + "description": "User id of the replacement user" + }, + "replacementUserDisplayName": { + "type": "string", + "default": "", + "description": "Display name of the replacement user" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -849,4 +845,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/federatedfilesharing/openapi.json b/apps/federatedfilesharing/openapi.json index 4f0f10dd045..0e58235e4fb 100644 --- a/apps/federatedfilesharing/openapi.json +++ b/apps/federatedfilesharing/openapi.json @@ -63,35 +63,35 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "shareWith", - "in": "query", - "description": "Username to share with", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "in": "query", - "description": "Token of the share", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "password", - "in": "query", - "description": "Password of the share", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "shareWith", + "token" + ], + "properties": { + "shareWith": { + "type": "string", + "description": "Username to share with" + }, + "token": { + "type": "string", + "description": "Token of the share" + }, + "password": { + "type": "string", + "default": "", + "description": "Password of the share" + } + } + } } } - ], + }, "responses": { "200": { "description": "Remote URL returned", @@ -148,89 +148,65 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "remote", - "in": "query", - "description": "Address of the remote", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "token", - "in": "query", - "description": "Shared secret between servers", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "name", - "in": "query", - "description": "Name of the shared resource", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "owner", - "in": "query", - "description": "Display name of the receiver", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "sharedBy", - "in": "query", - "description": "Display name of the sender", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "shareWith", - "in": "query", - "description": "ID of the user that receives the share", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "remoteId", - "in": "query", - "description": "ID of the remote", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "sharedByFederatedId", - "in": "query", - "description": "Federated ID of the sender", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "ownerFederatedId", - "in": "query", - "description": "Federated ID of the receiver", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "remote": { + "type": "string", + "nullable": true, + "description": "Address of the remote" + }, + "token": { + "type": "string", + "nullable": true, + "description": "Shared secret between servers" + }, + "name": { + "type": "string", + "nullable": true, + "description": "Name of the shared resource" + }, + "owner": { + "type": "string", + "nullable": true, + "description": "Display name of the receiver" + }, + "sharedBy": { + "type": "string", + "nullable": true, + "description": "Display name of the sender" + }, + "shareWith": { + "type": "string", + "nullable": true, + "description": "ID of the user that receives the share" + }, + "remoteId": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "ID of the remote" + }, + "sharedByFederatedId": { + "type": "string", + "nullable": true, + "description": "Federated ID of the sender" + }, + "ownerFederatedId": { + "type": "string", + "nullable": true, + "description": "Federated ID of the receiver" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -290,36 +266,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Shared secret between servers", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "shareWith", - "in": "query", - "description": "ID of the user that receives the share", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "remoteId", - "in": "query", - "description": "ID of the remote", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "nullable": true, + "description": "Shared secret between servers" + }, + "shareWith": { + "type": "string", + "nullable": true, + "description": "ID of the user that receives the share" + }, + "remoteId": { + "type": "integer", + "format": "int64", + "nullable": true, + "default": 0, + "description": "ID of the remote" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -431,26 +407,30 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Shared secret between servers", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "permissions", - "in": "query", - "description": "New permissions", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "nullable": true, + "description": "Shared secret between servers" + }, + "permissions": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "New permissions" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -548,16 +528,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Shared secret between servers", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "nullable": true, + "description": "Shared secret between servers" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -637,16 +625,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Shared secret between servers", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "nullable": true, + "description": "Shared secret between servers" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -716,16 +712,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Shared secret between servers", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "nullable": true, + "description": "Shared secret between servers" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -795,16 +799,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Shared secret between servers", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "nullable": true, + "description": "Shared secret between servers" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -902,34 +914,34 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Shared secret between servers", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "remote", - "in": "query", - "description": "Address of the remote", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "remote_id", - "in": "query", - "description": "ID of the remote", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "nullable": true, + "description": "Shared secret between servers" + }, + "remote": { + "type": "string", + "nullable": true, + "description": "Address of the remote" + }, + "remote_id": { + "type": "string", + "nullable": true, + "description": "ID of the remote" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -1032,4 +1044,4 @@ "description": "Class MountPublicLinkController\nconvert public links to federated shares" } ] -}
\ No newline at end of file +} diff --git a/apps/federation/openapi.json b/apps/federation/openapi.json index 59545e7dc98..c8b4d1a91b3 100644 --- a/apps/federation/openapi.json +++ b/apps/federation/openapi.json @@ -63,25 +63,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "url", - "in": "query", - "description": "URL of the server", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "in": "query", - "description": "Token of the server", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "url", + "token" + ], + "properties": { + "url": { + "type": "string", + "description": "URL of the server" + }, + "token": { + "type": "string", + "description": "Token of the server" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -179,25 +185,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "url", - "in": "query", - "description": "URL of the server", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "in": "query", - "description": "Token of the server", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "url", + "token" + ], + "properties": { + "url": { + "type": "string", + "description": "URL of the server" + }, + "token": { + "type": "string", + "description": "Token of the server" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -285,25 +297,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "url", - "in": "query", - "description": "URL of the server", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "in": "query", - "description": "Token of the server", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "url", + "token" + ], + "properties": { + "url": { + "type": "string", + "description": "URL of the server" + }, + "token": { + "type": "string", + "description": "Token of the server" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -399,25 +417,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "url", - "in": "query", - "description": "URL of the server", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "in": "query", - "description": "Token of the server", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "url", + "token" + ], + "properties": { + "url": { + "type": "string", + "description": "URL of the server" + }, + "token": { + "type": "string", + "description": "Token of the server" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -496,4 +520,4 @@ "description": "Class OCSAuthAPI\nOCS API end-points to exchange shared secret between two connected Nextclouds" } ] -}
\ No newline at end of file +} diff --git a/apps/files/openapi.json b/apps/files/openapi.json index 99e755ae8a3..e00674ccc81 100644 --- a/apps/files/openapi.json +++ b/apps/files/openapi.json @@ -593,35 +593,37 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "path", - "in": "query", - "description": "Path of the file", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "editorId", - "in": "query", - "description": "ID of the editor", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "fileId", - "in": "query", - "description": "ID of the file", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "path" + ], + "properties": { + "path": { + "type": "string", + "description": "Path of the file" + }, + "editorId": { + "type": "string", + "nullable": true, + "description": "ID of the editor" + }, + "fileId": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "ID of the file" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -766,43 +768,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "path", - "in": "query", - "description": "Path of the file", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "editorId", - "in": "query", - "description": "ID of the editor", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "creatorId", - "in": "query", - "description": "ID of the creator", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "templateId", - "in": "query", - "description": "ID of the template", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "path", + "editorId", + "creatorId" + ], + "properties": { + "path": { + "type": "string", + "description": "Path of the file" + }, + "editorId": { + "type": "string", + "description": "ID of the editor" + }, + "creatorId": { + "type": "string", + "description": "ID of the creator" + }, + "templateId": { + "type": "string", + "nullable": true, + "description": "ID of the template" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1011,34 +1011,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "filePath", - "in": "query", - "description": "Path of the file", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "templatePath", - "in": "query", - "description": "Name of the template", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "templateType", - "in": "query", - "description": "Type of the template", - "schema": { - "type": "string", - "default": "user" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "filePath" + ], + "properties": { + "filePath": { + "type": "string", + "description": "Path of the file" + }, + "templatePath": { + "type": "string", + "default": "", + "description": "Name of the template" + }, + "templateType": { + "type": "string", + "default": "user", + "description": "Type of the template" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1127,29 +1129,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "templatePath", - "in": "query", - "description": "Path of the template directory", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "copySystemTemplates", - "in": "query", - "description": "Whether to copy the system templates to the template directory", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "templatePath": { + "type": "string", + "default": "", + "description": "Path of the template directory" + }, + "copySystemTemplates": { + "type": "boolean", + "default": false, + "description": "Whether to copy the system templates to the template directory" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1253,25 +1255,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "recipient", - "in": "query", - "description": "Username of the recipient", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "path", - "in": "query", - "description": "Path of the file", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "recipient", + "path" + ], + "properties": { + "recipient": { + "type": "string", + "description": "Username of the recipient" + }, + "path": { + "type": "string", + "description": "Path of the file" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1634,16 +1642,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "path", - "in": "query", - "description": "Path of the file", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "path" + ], + "properties": { + "path": { + "type": "string", + "description": "Path of the file" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1754,16 +1772,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "path", - "in": "query", - "description": "Path of the file", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "path" + ], + "properties": { + "path": { + "type": "string", + "description": "Path of the file" + } + } + } } - }, + } + }, + "parameters": [ { "name": "token", "in": "path", @@ -1869,4 +1897,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/files_external/openapi.json b/apps/files_external/openapi.json index 73aa38b7c6f..e3b74e2a935 100644 --- a/apps/files_external/openapi.json +++ b/apps/files_external/openapi.json @@ -236,4 +236,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/files_reminders/openapi.json b/apps/files_reminders/openapi.json index 4e9653b2f0b..3564b90b1c2 100644 --- a/apps/files_reminders/openapi.json +++ b/apps/files_reminders/openapi.json @@ -177,16 +177,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "dueDate", - "in": "query", - "description": "ISO 8601 formatted date time string", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "dueDate" + ], + "properties": { + "dueDate": { + "type": "string", + "description": "ISO 8601 formatted date time string" + } + } + } } - }, + } + }, + "parameters": [ { "name": "version", "in": "path", @@ -495,4 +505,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/files_sharing/openapi.json b/apps/files_sharing/openapi.json index 87f36d4331f..65beb9121b8 100644 --- a/apps/files_sharing/openapi.json +++ b/apps/files_sharing/openapi.json @@ -1385,49 +1385,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "file", - "in": "query", - "description": "File in the share", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "x", - "in": "query", - "description": "Width of the preview", - "schema": { - "type": "integer", - "format": "int64", - "default": 32 - } - }, - { - "name": "y", - "in": "query", - "description": "Height of the preview", - "schema": { - "type": "integer", - "format": "int64", - "default": 32 - } - }, - { - "name": "a", - "in": "query", - "description": "Whether to not crop the preview", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "default": "", + "description": "File in the share" + }, + "x": { + "type": "integer", + "format": "int64", + "default": 32, + "description": "Width of the preview" + }, + "y": { + "type": "integer", + "format": "int64", + "default": 32, + "description": "Height of the preview" + }, + "a": { + "type": "boolean", + "default": false, + "description": "Whether to not crop the preview" + } + } + } } - }, + } + }, + "parameters": [ { "name": "token", "in": "path", @@ -1493,45 +1485,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "t", - "in": "query", - "description": "Token of the share", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "password", - "in": "query", - "description": "Password of the share", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "dir", - "in": "query", - "description": "Subdirectory to get info about", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "depth", - "in": "query", - "description": "Maximum depth to get info about", - "schema": { - "type": "integer", - "format": "int64", - "default": -1 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "t" + ], + "properties": { + "t": { + "type": "string", + "description": "Token of the share" + }, + "password": { + "type": "string", + "nullable": true, + "description": "Password of the share" + }, + "dir": { + "type": "string", + "nullable": true, + "description": "Subdirectory to get info about" + }, + "depth": { + "type": "integer", + "format": "int64", + "default": -1, + "description": "Maximum depth to get info about" + } + } + } } } - ], + }, "responses": { "200": { "description": "Share info returned", @@ -1577,52 +1565,44 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "shared_with_me", - "in": "query", - "description": "Only get shares with the current user", - "schema": { - "type": "string", - "default": "false" - } - }, - { - "name": "reshares", - "in": "query", - "description": "Only get shares by the current user and reshares", - "schema": { - "type": "string", - "default": "false" - } - }, - { - "name": "subfiles", - "in": "query", - "description": "Only get all shares in a folder", - "schema": { - "type": "string", - "default": "false" - } - }, - { - "name": "path", - "in": "query", - "description": "Get shares for a specific path", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "include_tags", - "in": "query", - "description": "Include tags in the share", - "schema": { - "type": "string", - "default": "false" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "shared_with_me": { + "type": "string", + "default": "false", + "description": "Only get shares with the current user" + }, + "reshares": { + "type": "string", + "default": "false", + "description": "Only get shares by the current user and reshares" + }, + "subfiles": { + "type": "string", + "default": "false", + "description": "Only get all shares in a folder" + }, + "path": { + "type": "string", + "default": "", + "description": "Get shares for a specific path" + }, + "include_tags": { + "type": "string", + "default": "false", + "description": "Include tags in the share" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1712,108 +1692,76 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "path", - "in": "query", - "description": "Path of the share", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "permissions", - "in": "query", - "description": "Permissions for the share", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "shareType", - "in": "query", - "description": "Type of the share", - "schema": { - "type": "integer", - "format": "int64", - "default": -1 - } - }, - { - "name": "shareWith", - "in": "query", - "description": "The entity this should be shared with", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "publicUpload", - "in": "query", - "description": "If public uploading is allowed", - "schema": { - "type": "string", - "default": "false" - } - }, - { - "name": "password", - "in": "query", - "description": "Password for the share", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "sendPasswordByTalk", - "in": "query", - "description": "Send the password for the share over Talk", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "expireDate", - "in": "query", - "description": "The expiry date of the share in the user's timezone at 00:00. If $expireDate is not supplied or set to `null`, the system default will be used.", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "note", - "in": "query", - "description": "Note for the share", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "label", - "in": "query", - "description": "Label for the share (only used in link and email)", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "attributes", - "in": "query", - "description": "Additional attributes for the share", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string", + "nullable": true, + "description": "Path of the share" + }, + "permissions": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Permissions for the share" + }, + "shareType": { + "type": "integer", + "format": "int64", + "default": -1, + "description": "Type of the share" + }, + "shareWith": { + "type": "string", + "nullable": true, + "description": "The entity this should be shared with" + }, + "publicUpload": { + "type": "string", + "default": "false", + "description": "If public uploading is allowed" + }, + "password": { + "type": "string", + "default": "", + "description": "Password for the share" + }, + "sendPasswordByTalk": { + "type": "string", + "nullable": true, + "description": "Send the password for the share over Talk" + }, + "expireDate": { + "type": "string", + "nullable": true, + "description": "The expiry date of the share in the user's timezone at 00:00.\n If $expireDate is not supplied or set to `null`, the system default will be used." + }, + "note": { + "type": "string", + "default": "", + "description": "Note for the share" + }, + "label": { + "type": "string", + "default": "", + "description": "Label for the share (only used in link and email)" + }, + "attributes": { + "type": "string", + "nullable": true, + "description": "Additional attributes for the share" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1958,16 +1906,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "path", - "in": "query", - "description": "Path all shares will be relative to", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "path" + ], + "properties": { + "path": { + "type": "string", + "description": "Path all shares will be relative to" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -2133,20 +2091,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "include_tags", - "in": "query", - "description": "Include tags in the share", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "include_tags": { + "type": "boolean", + "default": false, + "description": "Include tags in the share" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -2242,89 +2204,65 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "permissions", - "in": "query", - "description": "New permissions", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "password", - "in": "query", - "description": "New password", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "sendPasswordByTalk", - "in": "query", - "description": "New condition if the password should be send over Talk", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "publicUpload", - "in": "query", - "description": "New condition if public uploading is allowed", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "expireDate", - "in": "query", - "description": "New expiry date", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "note", - "in": "query", - "description": "New note", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "label", - "in": "query", - "description": "New label", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "hideDownload", - "in": "query", - "description": "New condition if the download should be hidden", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "attributes", - "in": "query", - "description": "New additional attributes", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permissions": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "New permissions" + }, + "password": { + "type": "string", + "nullable": true, + "description": "New password" + }, + "sendPasswordByTalk": { + "type": "string", + "nullable": true, + "description": "New condition if the password should be send over Talk" + }, + "publicUpload": { + "type": "string", + "nullable": true, + "description": "New condition if public uploading is allowed" + }, + "expireDate": { + "type": "string", + "nullable": true, + "description": "New expiry date" + }, + "note": { + "type": "string", + "nullable": true, + "description": "New note" + }, + "label": { + "type": "string", + "nullable": true, + "description": "New label" + }, + "hideDownload": { + "type": "string", + "nullable": true, + "description": "New condition if the download should be hidden" + }, + "attributes": { + "type": "string", + "nullable": true, + "description": "New additional attributes" + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -2884,79 +2822,63 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "itemType", - "in": "query", - "description": "Limit to specific item types", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "page", - "in": "query", - "description": "Page offset for searching", - "schema": { - "type": "integer", - "format": "int64", - "default": 1 - } - }, - { - "name": "perPage", - "in": "query", - "description": "Limit amount of search results per page", - "schema": { - "type": "integer", - "format": "int64", - "default": 200 - } - }, - { - "name": "shareType", - "in": "query", - "description": "Limit to specific share types", - "schema": { - "nullable": true, - "oneOf": [ - { - "type": "integer", - "format": "int64" - }, - { - "type": "array", - "items": { + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "itemType": { + "type": "string", + "nullable": true, + "description": "Limit to specific item types" + }, + "page": { "type": "integer", - "format": "int64" + "format": "int64", + "default": 1, + "description": "Page offset for searching" + }, + "perPage": { + "type": "integer", + "format": "int64", + "default": 200, + "description": "Limit amount of search results per page" + }, + "shareType": { + "nullable": true, + "description": "Limit to specific share types", + "oneOf": [ + { + "type": "integer", + "format": "int64" + }, + { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + ] + }, + "lookup": { + "type": "boolean", + "default": false, + "description": "If a global lookup should be performed too" } } - ] - } - }, - { - "name": "lookup", - "in": "query", - "description": "If a global lookup should be performed too", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -3052,37 +2974,43 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "itemType", - "in": "query", - "description": "Limit to specific item types", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "shareType", - "in": "query", - "description": "Limit to specific share types", - "schema": { - "nullable": true, - "oneOf": [ - { - "type": "integer", - "format": "int64" - }, - { - "type": "array", - "items": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "itemType" + ], + "properties": { + "itemType": { + "type": "string", + "description": "Limit to specific item types" + }, + "shareType": { + "nullable": true, + "description": "Limit to specific share types", + "oneOf": [ + { + "type": "integer", + "format": "int64" + }, + { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + ] } } - ] + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -3677,4 +3605,4 @@ "description": "Class ExternalSharesController" } ] -}
\ No newline at end of file +} diff --git a/apps/files_trashbin/openapi.json b/apps/files_trashbin/openapi.json index 2103047c282..03b98635b39 100644 --- a/apps/files_trashbin/openapi.json +++ b/apps/files_trashbin/openapi.json @@ -57,51 +57,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "fileId", - "in": "query", - "description": "ID of the file", - "schema": { - "type": "integer", - "format": "int64", - "default": -1 - } - }, - { - "name": "x", - "in": "query", - "description": "Width of the preview", - "schema": { - "type": "integer", - "format": "int64", - "default": 32 - } - }, - { - "name": "y", - "in": "query", - "description": "Height of the preview", - "schema": { - "type": "integer", - "format": "int64", - "default": 32 - } - }, - { - "name": "a", - "in": "query", - "description": "Whether to not crop the preview", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fileId": { + "type": "integer", + "format": "int64", + "default": -1, + "description": "ID of the file" + }, + "x": { + "type": "integer", + "format": "int64", + "default": 32, + "description": "Width of the preview" + }, + "y": { + "type": "integer", + "format": "int64", + "default": 32, + "description": "Height of the preview" + }, + "a": { + "type": "boolean", + "default": false, + "description": "Whether to not crop the preview" + } + } + } } } - ], + }, "responses": { "200": { "description": "Preview returned", @@ -135,4 +125,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/files_versions/openapi.json b/apps/files_versions/openapi.json index 2ff4dcc2035..ee81923c905 100644 --- a/apps/files_versions/openapi.json +++ b/apps/files_versions/openapi.json @@ -65,46 +65,40 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "file", - "in": "query", - "description": "Path of the file", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "x", - "in": "query", - "description": "Width of the preview", - "schema": { - "type": "integer", - "format": "int64", - "default": 44 - } - }, - { - "name": "y", - "in": "query", - "description": "Height of the preview", - "schema": { - "type": "integer", - "format": "int64", - "default": 44 - } - }, - { - "name": "version", - "in": "query", - "description": "Version of the file to get the preview for", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "default": "", + "description": "Path of the file" + }, + "x": { + "type": "integer", + "format": "int64", + "default": 44, + "description": "Width of the preview" + }, + "y": { + "type": "integer", + "format": "int64", + "default": 44, + "description": "Height of the preview" + }, + "version": { + "type": "string", + "default": "", + "description": "Version of the file to get the preview for" + } + } + } } } - ], + }, "responses": { "200": { "description": "Preview returned", @@ -138,4 +132,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/oauth2/openapi.json b/apps/oauth2/openapi.json index c745e73bf79..f06f72b317b 100644 --- a/apps/oauth2/openapi.json +++ b/apps/oauth2/openapi.json @@ -38,35 +38,35 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "client_id", - "in": "query", - "description": "Client ID", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "in": "query", - "description": "State of the flow", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "response_type", - "in": "query", - "description": "Response type for the flow", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "client_id", + "state", + "response_type" + ], + "properties": { + "client_id": { + "type": "string", + "description": "Client ID" + }, + "state": { + "type": "string", + "description": "State of the flow" + }, + "response_type": { + "type": "string", + "description": "Response type for the flow" + } + } + } } } - ], + }, "responses": { "200": { "description": "Client not found", @@ -107,53 +107,45 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "grant_type", - "in": "query", - "description": "Token type that should be granted", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "code", - "in": "query", - "description": "Code of the flow", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "refresh_token", - "in": "query", - "description": "Refresh token", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "client_id", - "in": "query", - "description": "Client ID", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "client_secret", - "in": "query", - "description": "Client secret", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "grant_type" + ], + "properties": { + "grant_type": { + "type": "string", + "description": "Token type that should be granted" + }, + "code": { + "type": "string", + "nullable": true, + "description": "Code of the flow" + }, + "refresh_token": { + "type": "string", + "nullable": true, + "description": "Refresh token" + }, + "client_id": { + "type": "string", + "nullable": true, + "description": "Client ID" + }, + "client_secret": { + "type": "string", + "nullable": true, + "description": "Client secret" + } + } + } } } - ], + }, "responses": { "500": { "description": "", @@ -223,4 +215,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/provisioning_api/openapi-administration.json b/apps/provisioning_api/openapi-administration.json index 5c98e19bff1..abf799a1688 100644 --- a/apps/provisioning_api/openapi-administration.json +++ b/apps/provisioning_api/openapi-administration.json @@ -95,16 +95,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "Filter for enabled or disabled apps", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filter": { + "type": "string", + "nullable": true, + "description": "Filter for enabled or disabled apps" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -461,25 +469,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "displayname", - "in": "query", - "description": "Display name of the group", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "groupid" + ], + "properties": { + "groupid": { + "type": "string", + "description": "ID of the group" + }, + "displayname": { + "type": "string", + "default": "", + "description": "Display name of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -539,25 +553,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "key", - "in": "query", - "description": "Key to update, only 'displayname'", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "value", - "in": "query", - "description": "New value for the key", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key to update, only 'displayname'" + }, + "value": { + "type": "string", + "description": "New value for the key" + } + } + } } - }, + } + }, + "parameters": [ { "name": "groupId", "in": "path", @@ -767,16 +787,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "groupid" + ], + "properties": { + "groupid": { + "type": "string", + "description": "ID of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -843,16 +873,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "groupid" + ], + "properties": { + "groupid": { + "type": "string", + "description": "ID of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -1122,16 +1162,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "defaultValue", - "in": "query", - "description": "Default returned value if the value is empty", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "defaultValue": { + "type": "string", + "default": "", + "description": "Default returned value if the value is empty" + } + } + } } - }, + } + }, + "parameters": [ { "name": "app", "in": "path", @@ -1373,4 +1421,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/provisioning_api/openapi-full.json b/apps/provisioning_api/openapi-full.json index a1a2d10e13c..e7c094c214d 100644 --- a/apps/provisioning_api/openapi-full.json +++ b/apps/provisioning_api/openapi-full.json @@ -404,16 +404,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "Filter for enabled or disabled apps", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filter": { + "type": "string", + "nullable": true, + "description": "Filter for enabled or disabled apps" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -769,36 +777,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1026,16 +1034,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "groupid" + ], + "properties": { + "groupid": { + "type": "string", + "description": "ID of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -1102,16 +1120,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "groupid" + ], + "properties": { + "groupid": { + "type": "string", + "description": "ID of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -1381,16 +1409,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "value", - "in": "query", - "description": "New value for the key", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "New value for the key" + } + } + } } - }, + } + }, + "parameters": [ { "name": "app", "in": "path", @@ -1513,36 +1551,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1752,36 +1790,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "groupId", "in": "path", @@ -1878,36 +1916,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1978,94 +2016,72 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "userid", - "in": "query", - "description": "ID of the user", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "password", - "in": "query", - "description": "Password of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "displayName", - "in": "query", - "description": "Display name of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "email", - "in": "query", - "description": "Email of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "groups[]", - "in": "query", - "description": "Groups of the user", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "string" - } - } - }, - { - "name": "subadmin[]", - "in": "query", - "description": "Groups where the user is subadmin", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "userid" + ], + "properties": { + "userid": { + "type": "string", + "description": "ID of the user" + }, + "password": { + "type": "string", + "default": "", + "description": "Password of the user" + }, + "displayName": { + "type": "string", + "default": "", + "description": "Display name of the user" + }, + "email": { + "type": "string", + "default": "", + "description": "Email of the user" + }, + "groups": { + "type": "array", + "default": [], + "description": "Groups of the user", + "items": { + "type": "string" + } + }, + "subadmin": { + "type": "array", + "default": [], + "description": "Groups where the user is subadmin", + "items": { + "type": "string" + } + }, + "quota": { + "type": "string", + "default": "", + "description": "Quota of the user" + }, + "language": { + "type": "string", + "default": "", + "description": "Language of the user" + }, + "manager": { + "type": "string", + "nullable": true, + "description": "Manager of the user" + } + } } } - }, - { - "name": "quota", - "in": "query", - "description": "Quota of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "language", - "in": "query", - "description": "Language of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "manager", - "in": "query", - "description": "Manager of the user", - "schema": { - "type": "string", - "nullable": true - } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -2162,36 +2178,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -2278,36 +2294,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of users returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of users returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -2394,25 +2410,37 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "location", - "in": "query", - "description": "Location of the phone number (for country code)", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "search", - "in": "query", - "description": "Phone numbers to search for", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "location", + "search" + ], + "properties": { + "location": { + "type": "string", + "description": "Location of the phone number (for country code)" + }, + "search": { + "type": "object", + "description": "Phone numbers to search for", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -2573,25 +2601,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "key", - "in": "query", - "description": "Key that will be updated", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "value", - "in": "query", - "description": "New value for the key", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key that will be updated" + }, + "value": { + "type": "string", + "description": "New value for the key" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -2925,25 +2959,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "key", - "in": "query", - "description": "Key that will be updated", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "value", - "in": "query", - "description": "New value for the key", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key that will be updated" + }, + "value": { + "type": "string", + "description": "New value for the key" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -3308,16 +3348,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupid": { + "type": "string", + "default": "", + "description": "ID of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -3384,16 +3432,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "groupid" + ], + "properties": { + "groupid": { + "type": "string", + "description": "ID of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -3530,16 +3588,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "configValue", - "in": "query", - "description": "New value", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "configValue" + ], + "properties": { + "configValue": { + "type": "string", + "description": "New value" + } + } + } } - }, + } + }, + "parameters": [ { "name": "appId", "in": "path", @@ -3747,16 +3815,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "configs", - "in": "query", - "description": "Key-value pairs of the preferences", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "configs" + ], + "properties": { + "configs": { + "type": "object", + "description": "Key-value pairs of the preferences", + "additionalProperties": { + "type": "string" + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "appId", "in": "path", @@ -3850,19 +3931,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "configKeys[]", - "in": "query", - "description": "Keys to delete", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "configKeys" + ], + "properties": { + "configKeys": { + "type": "array", + "description": "Keys to delete", + "items": { + "type": "string" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "appId", "in": "path", @@ -3945,4 +4036,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/provisioning_api/openapi.json b/apps/provisioning_api/openapi.json index c938ce60a78..65cb01bc380 100644 --- a/apps/provisioning_api/openapi.json +++ b/apps/provisioning_api/openapi.json @@ -403,36 +403,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -504,36 +504,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -743,36 +743,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "groupId", "in": "path", @@ -952,36 +952,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1052,94 +1052,72 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "userid", - "in": "query", - "description": "ID of the user", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "password", - "in": "query", - "description": "Password of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "displayName", - "in": "query", - "description": "Display name of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "email", - "in": "query", - "description": "Email of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "groups[]", - "in": "query", - "description": "Groups of the user", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "string" - } - } - }, - { - "name": "subadmin[]", - "in": "query", - "description": "Groups where the user is subadmin", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "userid" + ], + "properties": { + "userid": { + "type": "string", + "description": "ID of the user" + }, + "password": { + "type": "string", + "default": "", + "description": "Password of the user" + }, + "displayName": { + "type": "string", + "default": "", + "description": "Display name of the user" + }, + "email": { + "type": "string", + "default": "", + "description": "Email of the user" + }, + "groups": { + "type": "array", + "default": [], + "description": "Groups of the user", + "items": { + "type": "string" + } + }, + "subadmin": { + "type": "array", + "default": [], + "description": "Groups where the user is subadmin", + "items": { + "type": "string" + } + }, + "quota": { + "type": "string", + "default": "", + "description": "Quota of the user" + }, + "language": { + "type": "string", + "default": "", + "description": "Language of the user" + }, + "manager": { + "type": "string", + "nullable": true, + "description": "Manager of the user" + } + } } } - }, - { - "name": "quota", - "in": "query", - "description": "Quota of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "language", - "in": "query", - "description": "Language of the user", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "manager", - "in": "query", - "description": "Manager of the user", - "schema": { - "type": "string", - "nullable": true - } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1236,36 +1214,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of groups returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for searching for groups", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of groups returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset for searching for groups" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1352,36 +1330,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit the amount of users returned", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "search": { + "type": "string", + "default": "", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Limit the amount of users returned" + }, + "offset": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Offset" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1468,25 +1446,37 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "location", - "in": "query", - "description": "Location of the phone number (for country code)", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "search", - "in": "query", - "description": "Phone numbers to search for", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "location", + "search" + ], + "properties": { + "location": { + "type": "string", + "description": "Location of the phone number (for country code)" + }, + "search": { + "type": "object", + "description": "Phone numbers to search for", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1647,25 +1637,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "key", - "in": "query", - "description": "Key that will be updated", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "value", - "in": "query", - "description": "New value for the key", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key that will be updated" + }, + "value": { + "type": "string", + "description": "New value for the key" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -1999,25 +1995,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "key", - "in": "query", - "description": "Key that will be updated", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "value", - "in": "query", - "description": "New value for the key", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key that will be updated" + }, + "value": { + "type": "string", + "description": "New value for the key" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -2382,16 +2384,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groupid": { + "type": "string", + "default": "", + "description": "ID of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -2458,16 +2468,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "groupid", - "in": "query", - "description": "ID of the group", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "groupid" + ], + "properties": { + "groupid": { + "type": "string", + "description": "ID of the group" + } + } + } } - }, + } + }, + "parameters": [ { "name": "userId", "in": "path", @@ -2605,16 +2625,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "value", - "in": "query", - "description": "New value for the key", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "New value for the key" + } + } + } } - }, + } + }, + "parameters": [ { "name": "app", "in": "path", @@ -2737,16 +2767,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "configValue", - "in": "query", - "description": "New value", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "configValue" + ], + "properties": { + "configValue": { + "type": "string", + "description": "New value" + } + } + } } - }, + } + }, + "parameters": [ { "name": "appId", "in": "path", @@ -2954,16 +2994,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "configs", - "in": "query", - "description": "Key-value pairs of the preferences", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "configs" + ], + "properties": { + "configs": { + "type": "object", + "description": "Key-value pairs of the preferences", + "additionalProperties": { + "type": "string" + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "appId", "in": "path", @@ -3057,19 +3110,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "configKeys[]", - "in": "query", - "description": "Keys to delete", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "configKeys" + ], + "properties": { + "configKeys": { + "type": "array", + "description": "Keys to delete", + "items": { + "type": "string" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "appId", "in": "path", @@ -3152,4 +3215,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/settings/openapi-administration.json b/apps/settings/openapi-administration.json index 5d39237779a..090ef865371 100644 --- a/apps/settings/openapi-administration.json +++ b/apps/settings/openapi-administration.json @@ -62,4 +62,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/settings/openapi-full.json b/apps/settings/openapi-full.json index e313a354a16..b5cbfda7096 100644 --- a/apps/settings/openapi-full.json +++ b/apps/settings/openapi-full.json @@ -252,43 +252,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "app", - "in": "query", - "description": "ID of the app", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "formId", - "in": "query", - "description": "ID of the form", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "fieldId", - "in": "query", - "description": "ID of the field", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "value", - "in": "query", - "description": "Value to be saved", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "app", + "formId", + "fieldId", + "value" + ], + "properties": { + "app": { + "type": "string", + "description": "ID of the app" + }, + "formId": { + "type": "string", + "description": "ID of the form" + }, + "fieldId": { + "type": "string", + "description": "ID of the field" + }, + "value": { + "type": "object", + "description": "Value to be saved" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -448,4 +446,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/settings/openapi.json b/apps/settings/openapi.json index 3e829b834d1..f81b18bdc70 100644 --- a/apps/settings/openapi.json +++ b/apps/settings/openapi.json @@ -214,43 +214,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "app", - "in": "query", - "description": "ID of the app", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "formId", - "in": "query", - "description": "ID of the form", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "fieldId", - "in": "query", - "description": "ID of the field", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "value", - "in": "query", - "description": "Value to be saved", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "app", + "formId", + "fieldId", + "value" + ], + "properties": { + "app": { + "type": "string", + "description": "ID of the app" + }, + "formId": { + "type": "string", + "description": "ID of the form" + }, + "fieldId": { + "type": "string", + "description": "ID of the field" + }, + "value": { + "type": "object", + "description": "Value to be saved" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -410,4 +408,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/sharebymail/openapi.json b/apps/sharebymail/openapi.json index 0a70274bf26..7bc231c0770 100644 --- a/apps/sharebymail/openapi.json +++ b/apps/sharebymail/openapi.json @@ -107,4 +107,4 @@ }, "paths": {}, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/systemtags/openapi.json b/apps/systemtags/openapi.json index e27985c441d..383908d6e51 100644 --- a/apps/systemtags/openapi.json +++ b/apps/systemtags/openapi.json @@ -46,4 +46,4 @@ }, "paths": {}, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/theming/openapi.json b/apps/theming/openapi.json index fe0f342f993..45284ebf613 100644 --- a/apps/theming/openapi.json +++ b/apps/theming/openapi.json @@ -138,33 +138,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "plain", - "in": "query", - "description": "Let the browser decide the CSS priority", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "withCustomCss", - "in": "query", - "description": "Include custom CSS", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "plain": { + "type": "boolean", + "default": false, + "description": "Let the browser decide the CSS priority" + }, + "withCustomCss": { + "type": "boolean", + "default": false, + "description": "Include custom CSS" + } + } + } } - }, + } + }, + "parameters": [ { "name": "themeId", "in": "path", @@ -216,20 +212,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "useSvg", - "in": "query", - "description": "Return image as SVG", - "schema": { - "type": "integer", - "default": 1, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "useSvg": { + "type": "boolean", + "default": true, + "description": "Return image as SVG" + } + } + } } - }, + } + }, + "parameters": [ { "name": "key", "in": "path", @@ -846,4 +846,4 @@ "description": "Class ThemingController\nhandle ajax requests to update the theme" } ] -}
\ No newline at end of file +} diff --git a/apps/updatenotification/openapi.json b/apps/updatenotification/openapi.json index 94ed779d2c8..ffa726a31bb 100644 --- a/apps/updatenotification/openapi.json +++ b/apps/updatenotification/openapi.json @@ -220,16 +220,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "version", - "in": "query", - "description": "The version to search the changelog entry for (defaults to the latest installed)", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "version": { + "type": "string", + "nullable": true, + "description": "The version to search the changelog entry for (defaults to the latest installed)" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -344,4 +352,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/user_ldap/openapi.json b/apps/user_ldap/openapi.json index 739cc9cc3e7..61fcfea3e6b 100644 --- a/apps/user_ldap/openapi.json +++ b/apps/user_ldap/openapi.json @@ -133,20 +133,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "showPassword", - "in": "query", - "description": "Whether to show the password", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "showPassword": { + "type": "boolean", + "default": false, + "description": "Whether to show the password" + } + } + } } - }, + } + }, + "parameters": [ { "name": "configID", "in": "path", @@ -246,16 +250,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "configData", - "in": "query", - "description": "New config", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "configData" + ], + "properties": { + "configData": { + "type": "object", + "description": "New config", + "additionalProperties": { + "type": "object" + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "configID", "in": "path", @@ -461,4 +478,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/user_status/openapi.json b/apps/user_status/openapi.json index b0e5c547bcb..cbaec7d7731 100644 --- a/apps/user_status/openapi.json +++ b/apps/user_status/openapi.json @@ -221,16 +221,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Only online, away", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "status" + ], + "properties": { + "status": { + "type": "string", + "description": "Only online, away" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -414,27 +424,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Maximum number of statuses to find", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true - } - }, - { - "name": "offset", - "in": "query", - "description": "Offset for finding statuses", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Maximum number of statuses to find" + }, + "offset": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Offset for finding statuses" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -685,16 +699,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "statusType", - "in": "query", - "description": "The new status type", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "statusType" + ], + "properties": { + "statusType": { + "type": "string", + "description": "The new status type" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -783,26 +807,32 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "messageId", - "in": "query", - "description": "ID of the predefined message", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "clearAt", - "in": "query", - "description": "When the message should be cleared", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "messageId" + ], + "properties": { + "messageId": { + "type": "string", + "description": "ID of the predefined message" + }, + "clearAt": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "When the message should be cleared" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -891,35 +921,35 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "statusIcon", - "in": "query", - "description": "Icon of the status", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "message", - "in": "query", - "description": "Message of the status", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "clearAt", - "in": "query", - "description": "When the message should be cleared", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "statusIcon": { + "type": "string", + "nullable": true, + "description": "Icon of the status" + }, + "message": { + "type": "string", + "nullable": true, + "description": "Message of the status" + }, + "clearAt": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "When the message should be cleared" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -1132,4 +1162,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/weather_status/openapi.json b/apps/weather_status/openapi.json index e43ee2a1e38..8749de66360 100644 --- a/apps/weather_status/openapi.json +++ b/apps/weather_status/openapi.json @@ -285,17 +285,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "mode", - "in": "query", - "description": "New mode", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mode" + ], + "properties": { + "mode": { + "type": "integer", + "format": "int64", + "description": "New mode" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -476,36 +486,36 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "address", - "in": "query", - "description": "Any approximative or exact address", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "lat", - "in": "query", - "description": "Latitude in decimal degree format", - "schema": { - "type": "number", - "format": "double", - "nullable": true - } - }, - { - "name": "lon", - "in": "query", - "description": "Longitude in decimal degree format", - "schema": { - "type": "number", - "format": "double", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "address": { + "type": "string", + "nullable": true, + "description": "Any approximative or exact address" + }, + "lat": { + "type": "number", + "format": "double", + "nullable": true, + "description": "Latitude in decimal degree format" + }, + "lon": { + "type": "number", + "format": "double", + "nullable": true, + "description": "Longitude in decimal degree format" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -737,19 +747,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "favorites[]", - "in": "query", - "description": "Favorite addresses", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "favorites" + ], + "properties": { + "favorites": { + "type": "array", + "description": "Favorite addresses", + "items": { + "type": "string" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -797,4 +817,4 @@ } }, "tags": [] -}
\ No newline at end of file +} diff --git a/apps/webhook_listeners/openapi.json b/apps/webhook_listeners/openapi.json index 3d1e9cf7a30..01a9c59e6c2 100644 --- a/apps/webhook_listeners/openapi.json +++ b/apps/webhook_listeners/openapi.json @@ -111,16 +111,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "uri", - "in": "query", - "description": "The callback URI to filter by", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "nullable": true, + "description": "The callback URI to filter by" + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -183,74 +191,69 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "httpMethod", - "in": "query", - "description": "HTTP method to use to contact the webhook", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "uri", - "in": "query", - "description": "Webhook URI endpoint", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "event", - "in": "query", - "description": "Event class name to listen to", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "eventFilter", - "in": "query", - "description": "Mongo filter to apply to the serialized data to decide if firing", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "headers", - "in": "query", - "description": "Array of headers to send", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "authMethod", - "in": "query", - "description": "Authentication method to use", - "schema": { - "type": "string", - "nullable": true, - "enum": [ - "none", - "headers" - ] - } - }, - { - "name": "authData", - "in": "query", - "description": "Array of data for authentication", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "httpMethod", + "uri", + "event" + ], + "properties": { + "httpMethod": { + "type": "string", + "description": "HTTP method to use to contact the webhook" + }, + "uri": { + "type": "string", + "description": "Webhook URI endpoint" + }, + "event": { + "type": "string", + "description": "Event class name to listen to" + }, + "eventFilter": { + "type": "object", + "nullable": true, + "description": "Mongo filter to apply to the serialized data to decide if firing", + "additionalProperties": { + "type": "object" + } + }, + "headers": { + "type": "object", + "nullable": true, + "description": "Array of headers to send", + "additionalProperties": { + "type": "string" + } + }, + "authMethod": { + "type": "string", + "nullable": true, + "enum": [ + "none", + "headers" + ], + "description": "Authentication method to use" + }, + "authData": { + "type": "object", + "nullable": true, + "description": "Array of data for authentication", + "additionalProperties": { + "type": "object" + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "OCS-APIRequest", "in": "header", @@ -466,74 +469,69 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "httpMethod", - "in": "query", - "description": "HTTP method to use to contact the webhook", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "uri", - "in": "query", - "description": "Webhook URI endpoint", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "event", - "in": "query", - "description": "Event class name to listen to", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "eventFilter", - "in": "query", - "description": "Mongo filter to apply to the serialized data to decide if firing", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "headers", - "in": "query", - "description": "Array of headers to send", - "schema": { - "type": "string", - "nullable": true - } - }, - { - "name": "authMethod", - "in": "query", - "description": "Authentication method to use", - "schema": { - "type": "string", - "nullable": true, - "enum": [ - "none", - "headers" - ] - } - }, - { - "name": "authData", - "in": "query", - "description": "Array of data for authentication", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "httpMethod", + "uri", + "event" + ], + "properties": { + "httpMethod": { + "type": "string", + "description": "HTTP method to use to contact the webhook" + }, + "uri": { + "type": "string", + "description": "Webhook URI endpoint" + }, + "event": { + "type": "string", + "description": "Event class name to listen to" + }, + "eventFilter": { + "type": "object", + "nullable": true, + "description": "Mongo filter to apply to the serialized data to decide if firing", + "additionalProperties": { + "type": "object" + } + }, + "headers": { + "type": "object", + "nullable": true, + "description": "Array of headers to send", + "additionalProperties": { + "type": "string" + } + }, + "authMethod": { + "type": "string", + "nullable": true, + "enum": [ + "none", + "headers" + ], + "description": "Authentication method to use" + }, + "authData": { + "type": "object", + "nullable": true, + "description": "Array of data for authentication", + "additionalProperties": { + "type": "object" + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "id", "in": "path", @@ -773,4 +771,4 @@ } }, "tags": [] -}
\ No newline at end of file +} |