diff --git a/openapi-administration.json b/openapi-administration.json index 5278dd8a1c6..f97be4ed9d5 100644 --- a/openapi-administration.json +++ b/openapi-administration.json @@ -431,16 +431,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "host", - "in": "query", - "description": "Host to check", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "host" + ], + "properties": { + "host": { + "type": "string", + "description": "Host to check" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -562,52 +572,46 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "url", - "in": "query", - "description": "Server URL", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "in": "query", - "description": "Display name of the user", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "email", - "in": "query", - "description": "Email of the user", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "language", - "in": "query", - "description": "Language of the user", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "country", - "in": "query", - "description": "Country of the user", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "url", + "name", + "email", + "language", + "country" + ], + "properties": { + "url": { + "type": "string", + "description": "Server URL" + }, + "name": { + "type": "string", + "description": "Display name of the user" + }, + "email": { + "type": "string", + "description": "Email of the user" + }, + "language": { + "type": "string", + "description": "Language of the user" + }, + "country": { + "type": "string", + "description": "Country of the user" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1275,37 +1279,37 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "sipGroups[]", - "in": "query", - "description": "New SIP groups", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "string" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sipGroups": { + "type": "array", + "default": [], + "description": "New SIP groups", + "items": { + "type": "string" + } + }, + "dialInInfo": { + "type": "string", + "default": "", + "description": "New dial info" + }, + "sharedSecret": { + "type": "string", + "default": "", + "description": "New shared secret" + } + } } } - }, - { - "name": "dialInInfo", - "in": "query", - "description": "New dial info", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "sharedSecret", - "in": "query", - "description": "New shared secret", - "schema": { - "type": "string", - "default": "" - } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1520,4 +1524,4 @@ } }, "tags": [] -} \ No newline at end of file +} diff --git a/openapi-backend-recording.json b/openapi-backend-recording.json index 636ae832288..44b0eb6f615 100644 --- a/openapi-backend-recording.json +++ b/openapi-backend-recording.json @@ -521,16 +521,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "owner", - "in": "query", - "description": "User that will own the recording file. `null` is actually not allowed and will always result in a \"400 Bad Request\". It's only allowed code-wise to handle requests where the post data exceeded the limits, so we can return a proper error instead of \"500 Internal Server Error\".", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "owner": { + "type": "string", + "nullable": true, + "description": "User that will own the recording file. `null` is actually not allowed and will always result in a \"400 Bad Request\". It's only allowed code-wise to handle requests where the post data exceeded the limits, so we can return a proper error instead of \"500 Internal Server Error\"." + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -689,4 +697,4 @@ } }, "tags": [] -} \ No newline at end of file +} diff --git a/openapi-backend-signaling.json b/openapi-backend-signaling.json index 26e2c110116..f75b47f01f3 100644 --- a/openapi-backend-signaling.json +++ b/openapi-backend-signaling.json @@ -423,4 +423,4 @@ } }, "tags": [] -} \ No newline at end of file +} diff --git a/openapi-backend-sipbridge.json b/openapi-backend-sipbridge.json index de1b1b96f96..a01946ed84e 100644 --- a/openapi-backend-sipbridge.json +++ b/openapi-backend-sipbridge.json @@ -1120,16 +1120,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "pin", - "in": "query", - "description": "PIN the participant used to dial-in", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "pin" + ], + "properties": { + "pin": { + "type": "string", + "description": "PIN the participant used to dial-in" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1296,24 +1306,43 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "number", - "in": "query", - "description": "E164 formatted phone number", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "options", - "in": "query", - "description": "Additional details to verify the validity of the request", - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "number" + ], + "properties": { + "number": { + "type": "string", + "description": "E164 formatted phone number" + }, + "options": { + "type": "object", + "default": [], + "description": "Additional details to verify the validity of the request", + "properties": { + "actorId": { + "type": "string" + }, + "actorType": { + "type": "string" + }, + "attendeeId": { + "type": "integer", + "format": "int64" + } + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1647,24 +1676,43 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "callId", - "in": "query", - "description": "The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "options", - "in": "query", - "description": "Additional details to verify the validity of the request", - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "callId" + ], + "properties": { + "callId": { + "type": "string", + "description": "The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate" + }, + "options": { + "type": "object", + "default": [], + "description": "Additional details to verify the validity of the request", + "properties": { + "actorId": { + "type": "string" + }, + "actorType": { + "type": "string" + }, + "attendeeId": { + "type": "integer", + "format": "int64" + } + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1843,4 +1891,4 @@ } }, "tags": [] -} \ No newline at end of file +} diff --git a/openapi-bots.json b/openapi-bots.json index a8787a88ec1..e861244d9b1 100644 --- a/openapi-bots.json +++ b/openapi-bots.json @@ -288,48 +288,42 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "message", - "in": "query", - "description": "The message to send", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "referenceId", - "in": "query", - "description": "For the message to be able to later identify it again", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "replyTo", - "in": "query", - "description": "Parent id which this message is a reply to", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 - } - }, - { - "name": "silent", - "in": "query", - "description": "If sent silent the chat message will not create any notifications", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "The message to send" + }, + "referenceId": { + "type": "string", + "default": "", + "description": "For the message to be able to later identify it again" + }, + "replyTo": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Parent id which this message is a reply to" + }, + "silent": { + "type": "boolean", + "default": false, + "description": "If sent silent the chat message will not create any notifications" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -495,16 +489,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Reaction to add", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reaction" + ], + "properties": { + "reaction": { + "type": "string", + "description": "Reaction to add" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -706,16 +710,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Reaction to delete", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reaction" + ], + "properties": { + "reaction": { + "type": "string", + "description": "Reaction to delete" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -877,4 +891,4 @@ } }, "tags": [] -} \ No newline at end of file +} diff --git a/openapi-federation.json b/openapi-federation.json index 8b689ea9426..1cc8deaacb3 100644 --- a/openapi-federation.json +++ b/openapi-federation.json @@ -845,29 +845,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "cloudId", - "in": "query", - "description": "Federation CloudID to get the avatar for", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "darkTheme", - "in": "query", - "description": "Theme used for background", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "cloudId" + ], + "properties": { + "cloudId": { + "type": "string", + "description": "Federation CloudID to get the avatar for" + }, + "darkTheme": { + "type": "boolean", + "default": false, + "description": "Theme used for background" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -935,16 +937,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "cloudId", - "in": "query", - "description": "Federation CloudID to get the avatar for", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "cloudId" + ], + "properties": { + "cloudId": { + "type": "string", + "description": "Federation CloudID to get the avatar for" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1013,29 +1025,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "cloudId", - "in": "query", - "description": "Federation CloudID to get the avatar for", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "darkTheme", - "in": "query", - "description": "Theme used for background", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "cloudId" + ], + "properties": { + "cloudId": { + "type": "string", + "description": "Federation CloudID to get the avatar for" + }, + "darkTheme": { + "type": "boolean", + "default": false, + "description": "Theme used for background" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1113,16 +1127,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "cloudId", - "in": "query", - "description": "Federation CloudID to get the avatar for", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "cloudId" + ], + "properties": { + "cloudId": { + "type": "string", + "description": "Federation CloudID to get the avatar for" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1729,4 +1753,4 @@ } }, "tags": [] -} \ No newline at end of file +} diff --git a/openapi-full.json b/openapi-full.json index f3c96085ebc..757d0c1247c 100644 --- a/openapi-full.json +++ b/openapi-full.json @@ -1623,20 +1623,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "darkTheme", - "in": "query", - "description": "Theme used for background", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "darkTheme": { + "type": "boolean", + "default": false, + "description": "Theme used for background" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1781,25 +1785,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "emoji", - "in": "query", - "description": "Emoji", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "color", - "in": "query", - "description": "Color of the emoji", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "emoji" + ], + "properties": { + "emoji": { + "type": "string", + "description": "Emoji" + }, + "color": { + "type": "string", + "nullable": true, + "description": "Color of the emoji" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1985,39 +1995,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "actorType", - "in": "query", - "description": "Type of actor to ban, or `ip` when banning a clients remote address", - "required": true, - "schema": { - "type": "string", - "enum": [ - "users", - "guests", - "ip" - ] - } - }, - { - "name": "actorId", - "in": "query", - "description": "Actor ID or the IP address or range in case of type `ip`", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "internalNote", - "in": "query", - "description": "Optional internal note (max. 4000 characters)", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "actorType", + "actorId" + ], + "properties": { + "actorType": { + "type": "string", + "enum": [ + "users", + "guests", + "ip" + ], + "description": "Type of actor to ban, or `ip` when banning a clients remote address" + }, + "actorId": { + "type": "string", + "description": "Actor ID or the IP address or range in case of type `ip`" + }, + "internalNote": { + "type": "string", + "default": "", + "description": "Optional internal note (max. 4000 characters)" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -2696,44 +2708,46 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "mode", - "in": "query", - "description": "Mode of the breakout rooms", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1, - 2, - 3 - ] - } - }, - { - "name": "amount", - "in": "query", - "description": "Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT}", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 1, - "maximum": 20 - } - }, - { - "name": "attendeeMap", - "in": "query", - "description": "Mapping of the attendees to breakout rooms", - "schema": { - "type": "string", - "default": "[]" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mode", + "amount" + ], + "properties": { + "mode": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1, + 2, + 3 + ], + "description": "Mode of the breakout rooms" + }, + "amount": { + "type": "integer", + "format": "int64", + "description": "Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT}", + "minimum": 1, + "maximum": 20 + }, + "attendeeMap": { + "type": "string", + "default": "[]", + "description": "Mapping of the attendees to breakout rooms" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -2936,16 +2950,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "message", - "in": "query", - "description": "Message to broadcast", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "Message to broadcast" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -3106,16 +3130,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeMap", - "in": "query", - "description": "JSON encoded mapping of the attendees to breakout rooms `array`", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeMap" + ], + "properties": { + "attendeeMap": { + "type": "string", + "description": "JSON encoded mapping of the attendees to breakout rooms `array`" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -3720,16 +3754,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "target", - "in": "query", - "description": "Target breakout room", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "target" + ], + "properties": { + "target": { + "type": "string", + "description": "Target breakout room" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -3934,57 +3978,45 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "flags", - "in": "query", - "description": "In-Call flags", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0, - "maximum": 15 - } - }, - { - "name": "forcePermissions", - "in": "query", - "description": "In-call permissions", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0, - "maximum": 255 - } - }, - { - "name": "silent", - "in": "query", - "description": "Join the call silently", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "recordingConsent", - "in": "query", - "description": "When the user ticked a checkbox and agreed with being recorded (Only needed when the `config => call => recording-consent` capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} and the conversation `recordingConsent` value is {@see RecordingService::CONSENT_REQUIRED_YES} )", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "flags": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "In-Call flags", + "minimum": 0, + "maximum": 15 + }, + "forcePermissions": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "In-call permissions", + "minimum": 0, + "maximum": 255 + }, + "silent": { + "type": "boolean", + "default": false, + "description": "Join the call silently" + }, + "recordingConsent": { + "type": "boolean", + "default": false, + "description": "When the user ticked a checkbox and agreed with being recorded\n (Only needed when the `config => call => recording-consent` capability is set to {@see RecordingService::CONSENT_REQUIRED_YES}\n or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL}\n and the conversation `recordingConsent` value is {@see RecordingService::CONSENT_REQUIRED_YES} )" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -4126,19 +4158,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "flags", - "in": "query", - "description": "New flags", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 15 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "flags" + ], + "properties": { + "flags": { + "type": "integer", + "format": "int64", + "description": "New flags", + "minimum": 0, + "maximum": 15 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -4273,20 +4315,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "all", - "in": "query", - "description": "whether to also terminate the call for all participants", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "all": { + "type": "boolean", + "default": false, + "description": "whether to also terminate the call for all participants" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -4768,127 +4814,105 @@ "basic_auth": [] } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "lookIntoFuture" + ], + "properties": { + "lookIntoFuture": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "Polling for new messages (1) or getting the history of the chat (0)" + }, + "limit": { + "type": "integer", + "format": "int64", + "default": 100, + "description": "Number of chat messages to receive (100 by default, 200 at most)" + }, + "lastKnownMessageId": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "The last known message (serves as offset)", + "minimum": 0 + }, + "lastCommonReadId": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "The last known common read message\n (so the response is 200 instead of 304 when\n it changes even when there are no messages)", + "minimum": 0 + }, + "timeout": { + "type": "integer", + "format": "int64", + "default": 30, + "description": "Number of seconds to wait for new messages (30 by default, 30 at most)", + "minimum": 0, + "maximum": 30 + }, + "setReadMarker": { + "type": "integer", + "format": "int64", + "default": 1, + "enum": [ + 0, + 1 + ], + "description": "Automatically set the last read marker when 1,\n if your client does this itself via chat/{token}/read set to 0" + }, + "includeLastKnown": { + "type": "integer", + "format": "int64", + "default": 0, + "enum": [ + 0, + 1 + ], + "description": "Include the $lastKnownMessageId in the messages when 1 (default 0)" + }, + "noStatusUpdate": { + "type": "integer", + "format": "int64", + "default": 0, + "enum": [ + 0, + 1 + ], + "description": "When the user status should not be automatically set to online set to 1 (default 0)" + }, + "markNotificationsAsRead": { + "type": "integer", + "format": "int64", + "default": 1, + "enum": [ + 0, + 1 + ], + "description": "Set to 0 when notifications should not be marked as read (default 1)" + } + } + } + } + } + }, "parameters": [ { - "name": "lookIntoFuture", - "in": "query", - "description": "Polling for new messages (1) or getting the history of the chat (0)", + "name": "apiVersion", + "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "limit", - "in": "query", - "description": "Number of chat messages to receive (100 by default, 200 at most)", - "schema": { - "type": "integer", - "format": "int64", - "default": 100 - } - }, - { - "name": "lastKnownMessageId", - "in": "query", - "description": "The last known message (serves as offset)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 - } - }, - { - "name": "lastCommonReadId", - "in": "query", - "description": "The last known common read message (so the response is 200 instead of 304 when it changes even when there are no messages)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 - } - }, - { - "name": "timeout", - "in": "query", - "description": "Number of seconds to wait for new messages (30 by default, 30 at most)", - "schema": { - "type": "integer", - "format": "int64", - "default": 30, - "minimum": 0, - "maximum": 30 - } - }, - { - "name": "setReadMarker", - "in": "query", - "description": "Automatically set the last read marker when 1, if your client does this itself via chat/{token}/read set to 0", - "schema": { - "type": "integer", - "format": "int64", - "default": 1, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "includeLastKnown", - "in": "query", - "description": "Include the $lastKnownMessageId in the messages when 1 (default 0)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "noStatusUpdate", - "in": "query", - "description": "When the user status should not be automatically set to online set to 1 (default 0)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "markNotificationsAsRead", - "in": "query", - "description": "Set to 0 when notifications should not be marked as read (default 1)", - "schema": { - "type": "integer", - "format": "int64", - "default": 1, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "apiVersion", - "in": "path", - "required": true, - "schema": { - "type": "string", + "type": "string", "enum": [ "v1" ], @@ -4982,58 +5006,48 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "message", - "in": "query", - "description": "the message to send", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "actorDisplayName", - "in": "query", - "description": "for guests", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "referenceId", - "in": "query", - "description": "for the message to be able to later identify it again", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "replyTo", - "in": "query", - "description": "Parent id which this message is a reply to", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 - } - }, - { - "name": "silent", - "in": "query", - "description": "If sent silent the chat message will not create any notifications", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "the message to send" + }, + "actorDisplayName": { + "type": "string", + "default": "", + "description": "for guests" + }, + "referenceId": { + "type": "string", + "default": "", + "description": "for the message to be able to later identify it again" + }, + "replyTo": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Parent id which this message is a reply to", + "minimum": 0 + }, + "silent": { + "type": "boolean", + "default": false, + "description": "If sent silent the chat message will not create any notifications" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -5636,16 +5650,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "message", - "in": "query", - "description": "the message to send", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "the message to send" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -5933,19 +5957,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of chat messages to receive in both directions (50 by default, 100 at most, might return 201 messages)", - "schema": { - "type": "integer", - "format": "int64", - "default": 50, - "minimum": 1, - "maximum": 100 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "format": "int64", + "default": 50, + "description": "Number of chat messages to receive in both directions (50 by default, 100 at most, might return 201 messages)", + "minimum": 1, + "maximum": 100 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6056,18 +6088,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "timestamp", - "in": "query", - "description": "Timestamp of the reminder", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "timestamp" + ], + "properties": { + "timestamp": { + "type": "integer", + "format": "int64", + "description": "Timestamp of the reminder", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6453,18 +6495,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "lastReadMessage", - "in": "query", - "description": "ID if the last read message (Optional only with `chat-read-last` capability)", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "lastReadMessage": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "ID if the last read message (Optional only with `chat-read-last` capability)", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6642,39 +6692,37 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Maximum number of results", - "schema": { - "type": "integer", - "format": "int64", - "default": 20 - } - }, - { - "name": "includeStatus", - "in": "query", - "description": "Include the user statuses", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "search" + ], + "properties": { + "search": { + "type": "string", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "default": 20, + "description": "Maximum number of results" + }, + "includeStatus": { + "type": "boolean", + "default": false, + "description": "Include the user statuses" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6761,52 +6809,46 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "objectType", - "in": "query", - "description": "Type of the object", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "objectId", - "in": "query", - "description": "ID of the object", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "metaData", - "in": "query", - "description": "Additional metadata", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "actorDisplayName", - "in": "query", - "description": "Guest name", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "referenceId", - "in": "query", - "description": "Reference ID", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "objectType", + "objectId" + ], + "properties": { + "objectType": { + "type": "string", + "description": "Type of the object" + }, + "objectId": { + "type": "string", + "description": "ID of the object" + }, + "metaData": { + "type": "string", + "default": "", + "description": "Additional metadata" + }, + "actorDisplayName": { + "type": "string", + "default": "", + "description": "Guest name" + }, + "referenceId": { + "type": "string", + "default": "", + "description": "Reference ID" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6979,39 +7021,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "objectType", - "in": "query", - "description": "Type of the objects", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "lastKnownMessageId", - "in": "query", - "description": "ID of the last known message", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 - } - }, - { - "name": "limit", - "in": "query", - "description": "Maximum number of objects", - "schema": { - "type": "integer", - "format": "int64", - "default": 100, - "minimum": 1, - "maximum": 200 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "objectType" + ], + "properties": { + "objectType": { + "type": "string", + "description": "Type of the objects" + }, + "lastKnownMessageId": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "ID of the last known message", + "minimum": 0 + }, + "limit": { + "type": "integer", + "format": "int64", + "default": 100, + "description": "Maximum number of objects", + "minimum": 1, + "maximum": 200 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -7104,19 +7148,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Maximum number of objects", - "schema": { - "type": "integer", - "format": "int64", - "default": 7, - "minimum": 1, - "maximum": 20 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "format": "int64", + "default": 7, + "description": "Maximum number of objects", + "minimum": 1, + "maximum": 20 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -7510,16 +7562,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "displayName", - "in": "query", - "description": "New display name", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "displayName" + ], + "properties": { + "displayName": { + "type": "string", + "description": "New display name" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -7735,28 +7797,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "enabled", - "in": "query", - "description": "If the bridge should be enabled", - "required": true, - "schema": { - "type": "integer", - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "parts", - "in": "query", - "description": "New parts", - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "If the bridge should be enabled" + }, + "parts": { + "$ref": "#/components/schemas/MatterbridgeConfigFields", + "default": [], + "description": "New parts" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -8077,52 +8142,50 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "question", - "in": "query", - "description": "Question of the poll", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "options[]", - "in": "query", - "description": "Options of the poll", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "question", + "options", + "resultMode", + "maxVotes" + ], + "properties": { + "question": { + "type": "string", + "description": "Question of the poll" + }, + "options": { + "type": "array", + "description": "Options of the poll", + "items": { + "type": "string" + } + }, + "resultMode": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "Mode how the results will be shown" + }, + "maxVotes": { + "type": "integer", + "format": "int64", + "description": "Number of maximum votes per voter" + } + } } } - }, - { - "name": "resultMode", - "in": "query", - "description": "Mode how the results will be shown", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "maxVotes", - "in": "query", - "description": "Number of maximum votes per voter", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -8353,20 +8416,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "optionIds[]", - "in": "query", - "description": "IDs of the selected options", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "optionIds": { + "type": "array", + "default": [], + "description": "IDs of the selected options", + "items": { + "type": "integer", + "format": "int64" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -8721,16 +8792,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "shareToken", - "in": "query", - "description": "Token of the file share", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "shareToken" + ], + "properties": { + "shareToken": { + "type": "string", + "description": "Token of the file share" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -8848,16 +8929,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Emoji to add", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reaction" + ], + "properties": { + "reaction": { + "type": "string", + "description": "Emoji to add" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9047,16 +9138,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Emoji to remove", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reaction" + ], + "properties": { + "reaction": { + "type": "string", + "description": "Emoji to remove" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9210,16 +9311,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Emoji to filter", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reaction": { + "type": "string", + "nullable": true, + "description": "Emoji to filter" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9346,17 +9455,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Type of the recording", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "status" + ], + "properties": { + "status": { + "type": "integer", + "format": "int64", + "description": "Type of the recording" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9590,18 +9709,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "timestamp", - "in": "query", - "description": "Timestamp of the notification to be dismissed", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "timestamp" + ], + "properties": { + "timestamp": { + "type": "integer", + "format": "int64", + "description": "Timestamp of the notification to be dismissed", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9719,29 +9848,35 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "fileId", - "in": "query", - "description": "ID of the file", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 - } - }, - { - "name": "timestamp", - "in": "query", - "description": "Timestamp of the notification to be dismissed", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "fileId", + "timestamp" + ], + "properties": { + "fileId": { + "type": "integer", + "format": "int64", + "description": "ID of the file", + "minimum": 0 + }, + "timestamp": { + "type": "integer", + "format": "int64", + "description": "Timestamp of the notification to be dismissed", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9859,45 +9994,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "noStatusUpdate", - "in": "query", - "description": "When the user status should not be automatically set to online set to 1 (default 0)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "includeStatus", - "in": "query", - "description": "Include the user status", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "modifiedSince", - "in": "query", - "description": "Filter rooms modified after a timestamp", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "noStatusUpdate": { + "type": "integer", + "format": "int64", + "default": 0, + "enum": [ + 0, + 1 + ], + "description": "When the user status should not be automatically set to online set to 1 (default 0)" + }, + "includeStatus": { + "type": "boolean", + "default": false, + "description": "Include the user status" + }, + "modifiedSince": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Filter rooms modified after a timestamp", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9988,62 +10119,52 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "roomType", - "in": "query", - "description": "Type of the room", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "invite", - "in": "query", - "description": "User, group, … ID to invite", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "roomName", - "in": "query", - "description": "Name of the room", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "source", - "in": "query", - "description": "Source of the invite ID ('circles' to create a room with a circle, etc.)", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "objectType", - "in": "query", - "description": "Type of the object", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "objectId", - "in": "query", - "description": "ID of the object", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "roomType" + ], + "properties": { + "roomType": { + "type": "integer", + "format": "int64", + "description": "Type of the room" + }, + "invite": { + "type": "string", + "default": "", + "description": "User, group, … ID to invite" + }, + "roomName": { + "type": "string", + "default": "", + "description": "Name of the room" + }, + "source": { + "type": "string", + "default": "", + "description": "Source of the invite ID ('circles' to create a room with a circle, etc.)" + }, + "objectType": { + "type": "string", + "default": "", + "description": "Type of the object" + }, + "objectId": { + "type": "string", + "default": "", + "description": "ID of the object" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -10237,16 +10358,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "searchTerm", - "in": "query", - "description": "search term", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "searchTerm": { + "type": "string", + "default": "", + "description": "search term" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -10893,16 +11022,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "description", - "in": "query", - "description": "New description", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "description" + ], + "properties": { + "description": { + "type": "string", + "description": "New description" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11010,21 +11149,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "state", - "in": "query", - "description": "New read-only state", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "New read-only state" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11132,22 +11281,32 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "scope", - "in": "query", - "description": "Scope where the room is listable", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1, - 2 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "scope" + ], + "properties": { + "scope": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1, + 2 + ], + "description": "Scope where the room is listable" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11256,16 +11415,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "password", - "in": "query", - "description": "New password", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "password" + ], + "properties": { + "password": { + "type": "string", + "description": "New password" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11408,20 +11577,30 @@ { "basic_auth": [] } - ], + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "permissions" + ], + "properties": { + "permissions": { + "type": "integer", + "format": "int64", + "description": "New permissions", + "minimum": 0, + "maximum": 255 + } + } + } + } + } + }, "parameters": [ - { - "name": "permissions", - "in": "query", - "description": "New permissions", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 255 - } - }, { "name": "apiVersion", "in": "path", @@ -11546,20 +11725,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "includeStatus", - "in": "query", - "description": "Include the user statuses", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "includeStatus": { + "type": "boolean", + "default": false, + "description": "Include the user statuses" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11677,33 +11860,39 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "newParticipant", - "in": "query", - "description": "New participant", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "source", - "in": "query", - "description": "Source of the participant", - "schema": { - "type": "string", - "default": "users", - "enum": [ - "users", - "groups", - "circles", - "emails", - "federated_users", - "phones" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "newParticipant" + ], + "properties": { + "newParticipant": { + "type": "string", + "description": "New participant" + }, + "source": { + "type": "string", + "default": "users", + "enum": [ + "users", + "groups", + "circles", + "emails", + "federated_users", + "phones" + ], + "description": "Source of the participant" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11894,20 +12083,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "includeStatus", - "in": "query", - "description": "Include the user statuses", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "includeStatus": { + "type": "boolean", + "default": false, + "description": "Include the user statuses" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12202,18 +12395,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeId" + ], + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "description": "ID of the attendee", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12378,44 +12581,46 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 - } - }, - { - "name": "method", - "in": "query", - "description": "Method of updating permissions ('set', 'remove', 'add')", - "required": true, - "schema": { - "type": "string", - "enum": [ - "set", - "remove", - "add" - ] - } - }, - { - "name": "permissions", - "in": "query", - "description": "New permissions", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 255 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeId", + "method", + "permissions" + ], + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "description": "ID of the attendee", + "minimum": 0 + }, + "method": { + "type": "string", + "enum": [ + "set", + "remove", + "add" + ], + "description": "Method of updating permissions ('set', 'remove', 'add')" + }, + "permissions": { + "type": "integer", + "format": "int64", + "description": "New permissions", + "minimum": 0, + "maximum": 255 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12580,33 +12785,39 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "method", - "in": "query", - "description": "Method of updating permissions ('set', 'remove', 'add')", - "required": true, - "schema": { - "type": "string", - "enum": [ - "set", - "remove", - "add" - ] - } - }, - { - "name": "permissions", - "in": "query", - "description": "New permissions", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 255 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "method", + "permissions" + ], + "properties": { + "method": { + "type": "string", + "enum": [ + "set", + "remove", + "add" + ], + "description": "Method of updating permissions ('set', 'remove', 'add')" + }, + "permissions": { + "type": "integer", + "format": "int64", + "description": "New permissions", + "minimum": 0, + "maximum": 255 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12717,29 +12928,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "password", - "in": "query", - "description": "Password of the room", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "force", - "in": "query", - "description": "Create a new session if necessary", - "schema": { - "type": "integer", - "default": 1, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "password": { + "type": "string", + "default": "", + "description": "Password of the room" + }, + "force": { + "type": "boolean", + "default": true, + "description": "Create a new session if necessary" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13027,18 +13238,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "ID of the attendee", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13147,21 +13366,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "state", - "in": "query", - "description": "of the room", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "of the room" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13300,18 +13529,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeId" + ], + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "description": "ID of the attendee", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13474,18 +13713,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeId" + ], + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "description": "ID of the attendee", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13806,18 +14055,28 @@ { "basic_auth": [] } - ], + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "level" + ], + "properties": { + "level": { + "type": "integer", + "format": "int64", + "description": "New level" + } + } + } + } + } + }, "parameters": [ - { - "name": "level", - "in": "query", - "description": "New level", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, { "name": "apiVersion", "in": "path", @@ -13925,17 +14184,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "level", - "in": "query", - "description": "New level", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "level" + ], + "properties": { + "level": { + "type": "integer", + "format": "int64", + "description": "New level" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14043,28 +14312,34 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "state", - "in": "query", - "description": "New state", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "timer", - "in": "query", - "description": "Timer when the lobby will be removed", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "integer", + "format": "int64", + "description": "New state" + }, + "timer": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Timer when the lobby will be removed", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14174,22 +14449,32 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "state", - "in": "query", - "description": "New state", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1, - 2 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1, + 2 + ], + "description": "New state" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14383,17 +14668,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "recordingConsent", - "in": "query", - "description": "New consent setting for the conversation (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.)", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "recordingConsent" + ], + "properties": { + "recordingConsent": { + "type": "integer", + "format": "int64", + "description": "New consent setting for the conversation\n (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.)" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14542,18 +14837,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "seconds", - "in": "query", - "description": "New time", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "seconds" + ], + "properties": { + "seconds": { + "type": "integer", + "format": "int64", + "description": "New time", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14772,21 +15077,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "mentionPermissions", - "in": "query", - "description": "New mention permissions", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mentionPermissions" + ], + "properties": { + "mentionPermissions": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "New mention permissions" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14896,39 +15211,45 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "key", - "in": "query", - "description": "Key to update", - "required": true, - "schema": { - "type": "string", - "enum": [ - "attachment_folder", - "read_status_privacy", - "typing_privacy", - "play_sounds" - ] - } - }, - { - "name": "value", - "in": "query", - "description": "New value for the key", - "schema": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "enum": [ + "attachment_folder", + "read_status_privacy", + "typing_privacy", + "play_sounds" + ], + "description": "Key to update" + }, + "value": { + "nullable": true, + "description": "New value for the key", + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer", + "format": "int64" + } + ] + } } - ] + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15029,16 +15350,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Token of the room", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "default": "", + "description": "Token of the room" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15168,16 +15497,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "messages", - "in": "query", - "description": "JSON encoded messages", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "messages" + ], + "properties": { + "messages": { + "type": "string", + "description": "JSON encoded messages" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15717,29 +16056,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "cloudId", - "in": "query", - "description": "Federation CloudID to get the avatar for", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "darkTheme", - "in": "query", - "description": "Theme used for background", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "cloudId" + ], + "properties": { + "cloudId": { + "type": "string", + "description": "Federation CloudID to get the avatar for" + }, + "darkTheme": { + "type": "boolean", + "default": false, + "description": "Theme used for background" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15807,16 +16148,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "cloudId", - "in": "query", - "description": "Federation CloudID to get the avatar for", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "cloudId" + ], + "properties": { + "cloudId": { + "type": "string", + "description": "Federation CloudID to get the avatar for" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15885,29 +16236,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "cloudId", - "in": "query", - "description": "Federation CloudID to get the avatar for", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "darkTheme", - "in": "query", - "description": "Theme used for background", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "cloudId" + ], + "properties": { + "cloudId": { + "type": "string", + "description": "Federation CloudID to get the avatar for" + }, + "darkTheme": { + "type": "boolean", + "default": false, + "description": "Theme used for background" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15984,17 +16337,27 @@ { "basic_auth": [] } - ], + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "cloudId" + ], + "properties": { + "cloudId": { + "type": "string", + "description": "Federation CloudID to get the avatar for" + } + } + } + } + } + }, "parameters": [ - { - "name": "cloudId", - "in": "query", - "description": "Federation CloudID to get the avatar for", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "apiVersion", "in": "path", @@ -16616,48 +16979,42 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "message", - "in": "query", - "description": "The message to send", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "referenceId", - "in": "query", - "description": "For the message to be able to later identify it again", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "replyTo", - "in": "query", - "description": "Parent id which this message is a reply to", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 - } - }, - { - "name": "silent", - "in": "query", - "description": "If sent silent the chat message will not create any notifications", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "The message to send" + }, + "referenceId": { + "type": "string", + "default": "", + "description": "For the message to be able to later identify it again" + }, + "replyTo": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Parent id which this message is a reply to" + }, + "silent": { + "type": "boolean", + "default": false, + "description": "If sent silent the chat message will not create any notifications" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -16823,16 +17180,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Reaction to add", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reaction" + ], + "properties": { + "reaction": { + "type": "string", + "description": "Reaction to add" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -17034,16 +17401,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Reaction to delete", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reaction" + ], + "properties": { + "reaction": { + "type": "string", + "description": "Reaction to delete" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -17296,16 +17673,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "host", - "in": "query", - "description": "Host to check", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "host" + ], + "properties": { + "host": { + "type": "string", + "description": "Host to check" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -17427,52 +17814,46 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "url", - "in": "query", - "description": "Server URL", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "in": "query", - "description": "Display name of the user", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "email", - "in": "query", - "description": "Email of the user", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "language", - "in": "query", - "description": "Language of the user", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "country", - "in": "query", - "description": "Country of the user", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "url", + "name", + "email", + "language", + "country" + ], + "properties": { + "url": { + "type": "string", + "description": "Server URL" + }, + "name": { + "type": "string", + "description": "Display name of the user" + }, + "email": { + "type": "string", + "description": "Email of the user" + }, + "language": { + "type": "string", + "description": "Language of the user" + }, + "country": { + "type": "string", + "description": "Country of the user" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -18140,37 +18521,37 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "sipGroups[]", - "in": "query", - "description": "New SIP groups", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "string" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sipGroups": { + "type": "array", + "default": [], + "description": "New SIP groups", + "items": { + "type": "string" + } + }, + "dialInInfo": { + "type": "string", + "default": "", + "description": "New dial info" + }, + "sharedSecret": { + "type": "string", + "default": "", + "description": "New shared secret" + } + } } } - }, - { - "name": "dialInInfo", - "in": "query", - "description": "New dial info", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "sharedSecret", - "in": "query", - "description": "New shared secret", - "schema": { - "type": "string", - "default": "" - } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -18633,16 +19014,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "owner", - "in": "query", - "description": "User that will own the recording file. `null` is actually not allowed and will always result in a \"400 Bad Request\". It's only allowed code-wise to handle requests where the post data exceeded the limits, so we can return a proper error instead of \"500 Internal Server Error\".", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "owner": { + "type": "string", + "nullable": true, + "description": "User that will own the recording file. `null` is actually not allowed and will always result in a \"400 Bad Request\". It's only allowed code-wise to handle requests where the post data exceeded the limits, so we can return a proper error instead of \"500 Internal Server Error\"." + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -18992,16 +19381,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "pin", - "in": "query", - "description": "PIN the participant used to dial-in", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "pin" + ], + "properties": { + "pin": { + "type": "string", + "description": "PIN the participant used to dial-in" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -19168,24 +19567,43 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "number", - "in": "query", - "description": "E164 formatted phone number", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "options", - "in": "query", - "description": "Additional details to verify the validity of the request", - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "number" + ], + "properties": { + "number": { + "type": "string", + "description": "E164 formatted phone number" + }, + "options": { + "type": "object", + "default": [], + "description": "Additional details to verify the validity of the request", + "properties": { + "actorId": { + "type": "string" + }, + "actorType": { + "type": "string" + }, + "attendeeId": { + "type": "integer", + "format": "int64" + } + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -19519,24 +19937,43 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "callId", - "in": "query", - "description": "The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "options", - "in": "query", - "description": "Additional details to verify the validity of the request", - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "callId" + ], + "properties": { + "callId": { + "type": "string", + "description": "The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate" + }, + "options": { + "type": "object", + "default": [], + "description": "Additional details to verify the validity of the request", + "properties": { + "actorId": { + "type": "string" + }, + "actorType": { + "type": "string" + }, + "attendeeId": { + "type": "integer", + "format": "int64" + } + } + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -19865,4 +20302,4 @@ } }, "tags": [] -} \ No newline at end of file +} diff --git a/openapi.json b/openapi.json index 790fac8963e..86294c350d6 100644 --- a/openapi.json +++ b/openapi.json @@ -1510,20 +1510,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "darkTheme", - "in": "query", - "description": "Theme used for background", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "darkTheme": { + "type": "boolean", + "default": false, + "description": "Theme used for background" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1668,25 +1672,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "emoji", - "in": "query", - "description": "Emoji", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "color", - "in": "query", - "description": "Color of the emoji", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "emoji" + ], + "properties": { + "emoji": { + "type": "string", + "description": "Emoji" + }, + "color": { + "type": "string", + "nullable": true, + "description": "Color of the emoji" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -1872,39 +1882,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "actorType", - "in": "query", - "description": "Type of actor to ban, or `ip` when banning a clients remote address", - "required": true, - "schema": { - "type": "string", - "enum": [ - "users", - "guests", - "ip" - ] - } - }, - { - "name": "actorId", - "in": "query", - "description": "Actor ID or the IP address or range in case of type `ip`", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "internalNote", - "in": "query", - "description": "Optional internal note (max. 4000 characters)", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "actorType", + "actorId" + ], + "properties": { + "actorType": { + "type": "string", + "enum": [ + "users", + "guests", + "ip" + ], + "description": "Type of actor to ban, or `ip` when banning a clients remote address" + }, + "actorId": { + "type": "string", + "description": "Actor ID or the IP address or range in case of type `ip`" + }, + "internalNote": { + "type": "string", + "default": "", + "description": "Optional internal note (max. 4000 characters)" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -2583,44 +2595,46 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "mode", - "in": "query", - "description": "Mode of the breakout rooms", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1, - 2, - 3 - ] - } - }, - { - "name": "amount", - "in": "query", - "description": "Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT}", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 1, - "maximum": 20 - } - }, - { - "name": "attendeeMap", - "in": "query", - "description": "Mapping of the attendees to breakout rooms", - "schema": { - "type": "string", - "default": "[]" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mode", + "amount" + ], + "properties": { + "mode": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1, + 2, + 3 + ], + "description": "Mode of the breakout rooms" + }, + "amount": { + "type": "integer", + "format": "int64", + "description": "Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT}", + "minimum": 1, + "maximum": 20 + }, + "attendeeMap": { + "type": "string", + "default": "[]", + "description": "Mapping of the attendees to breakout rooms" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -2823,16 +2837,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "message", - "in": "query", - "description": "Message to broadcast", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "Message to broadcast" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -2993,16 +3017,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeMap", - "in": "query", - "description": "JSON encoded mapping of the attendees to breakout rooms `array`", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeMap" + ], + "properties": { + "attendeeMap": { + "type": "string", + "description": "JSON encoded mapping of the attendees to breakout rooms `array`" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -3607,16 +3641,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "target", - "in": "query", - "description": "Target breakout room", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "target" + ], + "properties": { + "target": { + "type": "string", + "description": "Target breakout room" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -3821,57 +3865,45 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "flags", - "in": "query", - "description": "In-Call flags", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0, - "maximum": 15 - } - }, - { - "name": "forcePermissions", - "in": "query", - "description": "In-call permissions", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0, - "maximum": 255 - } - }, - { - "name": "silent", - "in": "query", - "description": "Join the call silently", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "recordingConsent", - "in": "query", - "description": "When the user ticked a checkbox and agreed with being recorded (Only needed when the `config => call => recording-consent` capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} and the conversation `recordingConsent` value is {@see RecordingService::CONSENT_REQUIRED_YES} )", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "flags": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "In-Call flags", + "minimum": 0, + "maximum": 15 + }, + "forcePermissions": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "In-call permissions", + "minimum": 0, + "maximum": 255 + }, + "silent": { + "type": "boolean", + "default": false, + "description": "Join the call silently" + }, + "recordingConsent": { + "type": "boolean", + "default": false, + "description": "When the user ticked a checkbox and agreed with being recorded\n (Only needed when the `config => call => recording-consent` capability is set to {@see RecordingService::CONSENT_REQUIRED_YES}\n or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL}\n and the conversation `recordingConsent` value is {@see RecordingService::CONSENT_REQUIRED_YES} )" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -4013,19 +4045,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "flags", - "in": "query", - "description": "New flags", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 15 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "flags" + ], + "properties": { + "flags": { + "type": "integer", + "format": "int64", + "description": "New flags", + "minimum": 0, + "maximum": 15 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -4160,20 +4202,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "all", - "in": "query", - "description": "whether to also terminate the call for all participants", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "all": { + "type": "boolean", + "default": false, + "description": "whether to also terminate the call for all participants" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -4655,137 +4701,115 @@ "basic_auth": [] } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "lookIntoFuture" + ], + "properties": { + "lookIntoFuture": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "Polling for new messages (1) or getting the history of the chat (0)" + }, + "limit": { + "type": "integer", + "format": "int64", + "default": 100, + "description": "Number of chat messages to receive (100 by default, 200 at most)" + }, + "lastKnownMessageId": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "The last known message (serves as offset)", + "minimum": 0 + }, + "lastCommonReadId": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "The last known common read message\n (so the response is 200 instead of 304 when\n it changes even when there are no messages)", + "minimum": 0 + }, + "timeout": { + "type": "integer", + "format": "int64", + "default": 30, + "description": "Number of seconds to wait for new messages (30 by default, 30 at most)", + "minimum": 0, + "maximum": 30 + }, + "setReadMarker": { + "type": "integer", + "format": "int64", + "default": 1, + "enum": [ + 0, + 1 + ], + "description": "Automatically set the last read marker when 1,\n if your client does this itself via chat/{token}/read set to 0" + }, + "includeLastKnown": { + "type": "integer", + "format": "int64", + "default": 0, + "enum": [ + 0, + 1 + ], + "description": "Include the $lastKnownMessageId in the messages when 1 (default 0)" + }, + "noStatusUpdate": { + "type": "integer", + "format": "int64", + "default": 0, + "enum": [ + 0, + 1 + ], + "description": "When the user status should not be automatically set to online set to 1 (default 0)" + }, + "markNotificationsAsRead": { + "type": "integer", + "format": "int64", + "default": 1, + "enum": [ + 0, + 1 + ], + "description": "Set to 0 when notifications should not be marked as read (default 1)" + } + } + } + } + } + }, "parameters": [ { - "name": "lookIntoFuture", - "in": "query", - "description": "Polling for new messages (1) or getting the history of the chat (0)", + "name": "apiVersion", + "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int64", + "type": "string", "enum": [ - 0, - 1 - ] + "v1" + ], + "default": "v1" } }, { - "name": "limit", - "in": "query", - "description": "Number of chat messages to receive (100 by default, 200 at most)", - "schema": { - "type": "integer", - "format": "int64", - "default": 100 - } - }, - { - "name": "lastKnownMessageId", - "in": "query", - "description": "The last known message (serves as offset)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 - } - }, - { - "name": "lastCommonReadId", - "in": "query", - "description": "The last known common read message (so the response is 200 instead of 304 when it changes even when there are no messages)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 - } - }, - { - "name": "timeout", - "in": "query", - "description": "Number of seconds to wait for new messages (30 by default, 30 at most)", - "schema": { - "type": "integer", - "format": "int64", - "default": 30, - "minimum": 0, - "maximum": 30 - } - }, - { - "name": "setReadMarker", - "in": "query", - "description": "Automatically set the last read marker when 1, if your client does this itself via chat/{token}/read set to 0", - "schema": { - "type": "integer", - "format": "int64", - "default": 1, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "includeLastKnown", - "in": "query", - "description": "Include the $lastKnownMessageId in the messages when 1 (default 0)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "noStatusUpdate", - "in": "query", - "description": "When the user status should not be automatically set to online set to 1 (default 0)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "markNotificationsAsRead", - "in": "query", - "description": "Set to 0 when notifications should not be marked as read (default 1)", - "schema": { - "type": "integer", - "format": "int64", - "default": 1, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "apiVersion", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "v1" - ], - "default": "v1" - } - }, - { - "name": "token", - "in": "path", - "required": true, + "name": "token", + "in": "path", + "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{4,30}$" @@ -4869,58 +4893,48 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "message", - "in": "query", - "description": "the message to send", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "actorDisplayName", - "in": "query", - "description": "for guests", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "referenceId", - "in": "query", - "description": "for the message to be able to later identify it again", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "replyTo", - "in": "query", - "description": "Parent id which this message is a reply to", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 - } - }, - { - "name": "silent", - "in": "query", - "description": "If sent silent the chat message will not create any notifications", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "the message to send" + }, + "actorDisplayName": { + "type": "string", + "default": "", + "description": "for guests" + }, + "referenceId": { + "type": "string", + "default": "", + "description": "for the message to be able to later identify it again" + }, + "replyTo": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Parent id which this message is a reply to", + "minimum": 0 + }, + "silent": { + "type": "boolean", + "default": false, + "description": "If sent silent the chat message will not create any notifications" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -5523,16 +5537,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "message", - "in": "query", - "description": "the message to send", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "the message to send" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -5820,19 +5844,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Number of chat messages to receive in both directions (50 by default, 100 at most, might return 201 messages)", - "schema": { - "type": "integer", - "format": "int64", - "default": 50, - "minimum": 1, - "maximum": 100 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "format": "int64", + "default": 50, + "description": "Number of chat messages to receive in both directions (50 by default, 100 at most, might return 201 messages)", + "minimum": 1, + "maximum": 100 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -5943,18 +5975,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "timestamp", - "in": "query", - "description": "Timestamp of the reminder", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "timestamp" + ], + "properties": { + "timestamp": { + "type": "integer", + "format": "int64", + "description": "Timestamp of the reminder", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6340,18 +6382,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "lastReadMessage", - "in": "query", - "description": "ID if the last read message (Optional only with `chat-read-last` capability)", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "lastReadMessage": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "ID if the last read message (Optional only with `chat-read-last` capability)", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6529,39 +6579,37 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Text to search for", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Maximum number of results", - "schema": { - "type": "integer", - "format": "int64", - "default": 20 - } - }, - { - "name": "includeStatus", - "in": "query", - "description": "Include the user statuses", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "search" + ], + "properties": { + "search": { + "type": "string", + "description": "Text to search for" + }, + "limit": { + "type": "integer", + "format": "int64", + "default": 20, + "description": "Maximum number of results" + }, + "includeStatus": { + "type": "boolean", + "default": false, + "description": "Include the user statuses" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6648,52 +6696,46 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "objectType", - "in": "query", - "description": "Type of the object", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "objectId", - "in": "query", - "description": "ID of the object", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "metaData", - "in": "query", - "description": "Additional metadata", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "actorDisplayName", - "in": "query", - "description": "Guest name", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "referenceId", - "in": "query", - "description": "Reference ID", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "objectType", + "objectId" + ], + "properties": { + "objectType": { + "type": "string", + "description": "Type of the object" + }, + "objectId": { + "type": "string", + "description": "ID of the object" + }, + "metaData": { + "type": "string", + "default": "", + "description": "Additional metadata" + }, + "actorDisplayName": { + "type": "string", + "default": "", + "description": "Guest name" + }, + "referenceId": { + "type": "string", + "default": "", + "description": "Reference ID" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6866,39 +6908,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "objectType", - "in": "query", - "description": "Type of the objects", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "lastKnownMessageId", - "in": "query", - "description": "ID of the last known message", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 - } - }, - { - "name": "limit", - "in": "query", - "description": "Maximum number of objects", - "schema": { - "type": "integer", - "format": "int64", - "default": 100, - "minimum": 1, - "maximum": 200 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "objectType" + ], + "properties": { + "objectType": { + "type": "string", + "description": "Type of the objects" + }, + "lastKnownMessageId": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "ID of the last known message", + "minimum": 0 + }, + "limit": { + "type": "integer", + "format": "int64", + "default": 100, + "description": "Maximum number of objects", + "minimum": 1, + "maximum": 200 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -6991,19 +7035,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Maximum number of objects", - "schema": { - "type": "integer", - "format": "int64", - "default": 7, - "minimum": 1, - "maximum": 20 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "format": "int64", + "default": 7, + "description": "Maximum number of objects", + "minimum": 1, + "maximum": 20 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -7397,16 +7449,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "displayName", - "in": "query", - "description": "New display name", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "displayName" + ], + "properties": { + "displayName": { + "type": "string", + "description": "New display name" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -7622,28 +7684,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "enabled", - "in": "query", - "description": "If the bridge should be enabled", - "required": true, - "schema": { - "type": "integer", - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "parts", - "in": "query", - "description": "New parts", - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "If the bridge should be enabled" + }, + "parts": { + "$ref": "#/components/schemas/MatterbridgeConfigFields", + "default": [], + "description": "New parts" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -7964,52 +8029,50 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "question", - "in": "query", - "description": "Question of the poll", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "options[]", - "in": "query", - "description": "Options of the poll", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "resultMode", - "in": "query", - "description": "Mode how the results will be shown", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "maxVotes", - "in": "query", - "description": "Number of maximum votes per voter", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "question", + "options", + "resultMode", + "maxVotes" + ], + "properties": { + "question": { + "type": "string", + "description": "Question of the poll" + }, + "options": { + "type": "array", + "description": "Options of the poll", + "items": { + "type": "string" + } + }, + "resultMode": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "Mode how the results will be shown" + }, + "maxVotes": { + "type": "integer", + "format": "int64", + "description": "Number of maximum votes per voter" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -8240,20 +8303,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "optionIds[]", - "in": "query", - "description": "IDs of the selected options", - "schema": { - "type": "array", - "default": [], - "items": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "optionIds": { + "type": "array", + "default": [], + "description": "IDs of the selected options", + "items": { + "type": "integer", + "format": "int64" + } + } + } } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -8608,16 +8679,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "shareToken", - "in": "query", - "description": "Token of the file share", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "shareToken" + ], + "properties": { + "shareToken": { + "type": "string", + "description": "Token of the file share" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -8735,16 +8816,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Emoji to add", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reaction" + ], + "properties": { + "reaction": { + "type": "string", + "description": "Emoji to add" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -8934,16 +9025,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Emoji to remove", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reaction" + ], + "properties": { + "reaction": { + "type": "string", + "description": "Emoji to remove" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9097,16 +9198,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "reaction", - "in": "query", - "description": "Emoji to filter", - "schema": { - "type": "string", - "nullable": true + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reaction": { + "type": "string", + "nullable": true, + "description": "Emoji to filter" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9233,17 +9342,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Type of the recording", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "status" + ], + "properties": { + "status": { + "type": "integer", + "format": "int64", + "description": "Type of the recording" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9477,18 +9596,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "timestamp", - "in": "query", - "description": "Timestamp of the notification to be dismissed", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "timestamp" + ], + "properties": { + "timestamp": { + "type": "integer", + "format": "int64", + "description": "Timestamp of the notification to be dismissed", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9606,29 +9735,35 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "fileId", - "in": "query", - "description": "ID of the file", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 - } - }, - { - "name": "timestamp", - "in": "query", - "description": "Timestamp of the notification to be dismissed", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "fileId", + "timestamp" + ], + "properties": { + "fileId": { + "type": "integer", + "format": "int64", + "description": "ID of the file", + "minimum": 0 + }, + "timestamp": { + "type": "integer", + "format": "int64", + "description": "Timestamp of the notification to be dismissed", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9746,45 +9881,41 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "noStatusUpdate", - "in": "query", - "description": "When the user status should not be automatically set to online set to 1 (default 0)", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "includeStatus", - "in": "query", - "description": "Include the user status", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] - } - }, - { - "name": "modifiedSince", - "in": "query", - "description": "Filter rooms modified after a timestamp", - "schema": { - "type": "integer", - "format": "int64", - "default": 0, - "minimum": 0 + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "noStatusUpdate": { + "type": "integer", + "format": "int64", + "default": 0, + "enum": [ + 0, + 1 + ], + "description": "When the user status should not be automatically set to online set to 1 (default 0)" + }, + "includeStatus": { + "type": "boolean", + "default": false, + "description": "Include the user status" + }, + "modifiedSince": { + "type": "integer", + "format": "int64", + "default": 0, + "description": "Filter rooms modified after a timestamp", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -9875,62 +10006,52 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "roomType", - "in": "query", - "description": "Type of the room", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "invite", - "in": "query", - "description": "User, group, … ID to invite", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "roomName", - "in": "query", - "description": "Name of the room", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "source", - "in": "query", - "description": "Source of the invite ID ('circles' to create a room with a circle, etc.)", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "objectType", - "in": "query", - "description": "Type of the object", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "objectId", - "in": "query", - "description": "ID of the object", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "roomType" + ], + "properties": { + "roomType": { + "type": "integer", + "format": "int64", + "description": "Type of the room" + }, + "invite": { + "type": "string", + "default": "", + "description": "User, group, … ID to invite" + }, + "roomName": { + "type": "string", + "default": "", + "description": "Name of the room" + }, + "source": { + "type": "string", + "default": "", + "description": "Source of the invite ID ('circles' to create a room with a circle, etc.)" + }, + "objectType": { + "type": "string", + "default": "", + "description": "Type of the object" + }, + "objectId": { + "type": "string", + "default": "", + "description": "ID of the object" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -10124,16 +10245,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "searchTerm", - "in": "query", - "description": "search term", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "searchTerm": { + "type": "string", + "default": "", + "description": "search term" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -10439,17 +10568,27 @@ { "basic_auth": [] } - ], + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "roomName" + ], + "properties": { + "roomName": { + "type": "string", + "description": "New name" + } + } + } + } + } + }, "parameters": [ - { - "name": "roomName", - "in": "query", - "description": "New name", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "apiVersion", "in": "path", @@ -11003,16 +11142,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "description", - "in": "query", - "description": "New description", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "description" + ], + "properties": { + "description": { + "type": "string", + "description": "New description" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11120,21 +11269,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "state", - "in": "query", - "description": "New read-only state", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "New read-only state" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11242,22 +11401,32 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "scope", - "in": "query", - "description": "Scope where the room is listable", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1, - 2 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "scope" + ], + "properties": { + "scope": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1, + 2 + ], + "description": "Scope where the room is listable" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11366,16 +11535,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "password", - "in": "query", - "description": "New password", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "password" + ], + "properties": { + "password": { + "type": "string", + "description": "New password" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11519,19 +11698,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "permissions", - "in": "query", - "description": "New permissions", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 255 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "permissions" + ], + "properties": { + "permissions": { + "type": "integer", + "format": "int64", + "description": "New permissions", + "minimum": 0, + "maximum": 255 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11656,20 +11845,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "includeStatus", - "in": "query", - "description": "Include the user statuses", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "includeStatus": { + "type": "boolean", + "default": false, + "description": "Include the user statuses" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -11787,33 +11980,39 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "newParticipant", - "in": "query", - "description": "New participant", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "source", - "in": "query", - "description": "Source of the participant", - "schema": { - "type": "string", - "default": "users", - "enum": [ - "users", - "groups", - "circles", - "emails", - "federated_users", - "phones" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "newParticipant" + ], + "properties": { + "newParticipant": { + "type": "string", + "description": "New participant" + }, + "source": { + "type": "string", + "default": "users", + "enum": [ + "users", + "groups", + "circles", + "emails", + "federated_users", + "phones" + ], + "description": "Source of the participant" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12004,20 +12203,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "includeStatus", - "in": "query", - "description": "Include the user statuses", - "schema": { - "type": "integer", - "default": 0, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "includeStatus": { + "type": "boolean", + "default": false, + "description": "Include the user statuses" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12312,18 +12515,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeId" + ], + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "description": "ID of the attendee", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12488,44 +12701,46 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 - } - }, - { - "name": "method", - "in": "query", - "description": "Method of updating permissions ('set', 'remove', 'add')", - "required": true, - "schema": { - "type": "string", - "enum": [ - "set", - "remove", - "add" - ] - } - }, - { - "name": "permissions", - "in": "query", - "description": "New permissions", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 255 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeId", + "method", + "permissions" + ], + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "description": "ID of the attendee", + "minimum": 0 + }, + "method": { + "type": "string", + "enum": [ + "set", + "remove", + "add" + ], + "description": "Method of updating permissions ('set', 'remove', 'add')" + }, + "permissions": { + "type": "integer", + "format": "int64", + "description": "New permissions", + "minimum": 0, + "maximum": 255 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12690,33 +12905,39 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "method", - "in": "query", - "description": "Method of updating permissions ('set', 'remove', 'add')", - "required": true, - "schema": { - "type": "string", - "enum": [ - "set", - "remove", - "add" - ] - } - }, - { - "name": "permissions", - "in": "query", - "description": "New permissions", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 255 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "method", + "permissions" + ], + "properties": { + "method": { + "type": "string", + "enum": [ + "set", + "remove", + "add" + ], + "description": "Method of updating permissions ('set', 'remove', 'add')" + }, + "permissions": { + "type": "integer", + "format": "int64", + "description": "New permissions", + "minimum": 0, + "maximum": 255 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -12827,29 +13048,29 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "password", - "in": "query", - "description": "Password of the room", - "schema": { - "type": "string", - "default": "" - } - }, - { - "name": "force", - "in": "query", - "description": "Create a new session if necessary", - "schema": { - "type": "integer", - "default": 1, - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "password": { + "type": "string", + "default": "", + "description": "Password of the room" + }, + "force": { + "type": "boolean", + "default": true, + "description": "Create a new session if necessary" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13136,19 +13357,27 @@ { "basic_auth": [] } - ], + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "ID of the attendee", + "minimum": 0 + } + } + } + } + } + }, "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0 - } - }, { "name": "apiVersion", "in": "path", @@ -13257,21 +13486,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "state", - "in": "query", - "description": "of the room", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "of the room" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13410,18 +13649,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeId" + ], + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "description": "ID of the attendee", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13584,18 +13833,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "attendeeId", - "in": "query", - "description": "ID of the attendee", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "attendeeId" + ], + "properties": { + "attendeeId": { + "type": "integer", + "format": "int64", + "description": "ID of the attendee", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -13917,17 +14176,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "level", - "in": "query", - "description": "New level", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "level" + ], + "properties": { + "level": { + "type": "integer", + "format": "int64", + "description": "New level" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14035,17 +14304,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "level", - "in": "query", - "description": "New level", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "level" + ], + "properties": { + "level": { + "type": "integer", + "format": "int64", + "description": "New level" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14153,28 +14432,34 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "state", - "in": "query", - "description": "New state", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "timer", - "in": "query", - "description": "Timer when the lobby will be removed", - "schema": { - "type": "integer", - "format": "int64", - "nullable": true, - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "integer", + "format": "int64", + "description": "New state" + }, + "timer": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "Timer when the lobby will be removed", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14284,22 +14569,32 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "state", - "in": "query", - "description": "New state", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1, - 2 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1, + 2 + ], + "description": "New state" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14493,17 +14788,27 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "recordingConsent", - "in": "query", - "description": "New consent setting for the conversation (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.)", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "recordingConsent" + ], + "properties": { + "recordingConsent": { + "type": "integer", + "format": "int64", + "description": "New consent setting for the conversation\n (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.)" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14652,18 +14957,28 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "seconds", - "in": "query", - "description": "New time", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 0 + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "seconds" + ], + "properties": { + "seconds": { + "type": "integer", + "format": "int64", + "description": "New time", + "minimum": 0 + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -14882,21 +15197,31 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "mentionPermissions", - "in": "query", - "description": "New mention permissions", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "enum": [ - 0, - 1 - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mentionPermissions" + ], + "properties": { + "mentionPermissions": { + "type": "integer", + "format": "int64", + "enum": [ + 0, + 1 + ], + "description": "New mention permissions" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15006,39 +15331,45 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "key", - "in": "query", - "description": "Key to update", - "required": true, - "schema": { - "type": "string", - "enum": [ - "attachment_folder", - "read_status_privacy", - "typing_privacy", - "play_sounds" - ] - } - }, - { - "name": "value", - "in": "query", - "description": "New value for the key", - "schema": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "format": "int64" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "enum": [ + "attachment_folder", + "read_status_privacy", + "typing_privacy", + "play_sounds" + ], + "description": "Key to update" + }, + "value": { + "nullable": true, + "description": "New value for the key", + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer", + "format": "int64" + } + ] + } } - ] + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15139,16 +15470,24 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "token", - "in": "query", - "description": "Token of the room", - "schema": { - "type": "string", - "default": "" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "default": "", + "description": "Token of the room" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15278,16 +15617,26 @@ "basic_auth": [] } ], - "parameters": [ - { - "name": "messages", - "in": "query", - "description": "JSON encoded messages", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "messages" + ], + "properties": { + "messages": { + "type": "string", + "description": "JSON encoded messages" + } + } + } } - }, + } + }, + "parameters": [ { "name": "apiVersion", "in": "path", @@ -15814,4 +16163,4 @@ } }, "tags": [] -} \ No newline at end of file +} diff --git a/src/services/banService.ts b/src/services/banService.ts index 5ca754ecf7f..2649ed51e2f 100644 --- a/src/services/banService.ts +++ b/src/services/banService.ts @@ -10,7 +10,6 @@ import type { getBansResponse, banActorParams, banActorResponse, - unbanActorParams, unbanActorResponse, } from '../types' diff --git a/src/types/index.ts b/src/types/index.ts index e733416a64a..3685c9416ed 100644 --- a/src/types/index.ts +++ b/src/types/index.ts @@ -5,7 +5,6 @@ import type { components, operations } from './openapi/openapi-full.ts' // General -type ApiOptions = { params: T } type ApiResponse = Promise<{ data: T }> type ApiResponseHeaders = { [K in keyof T['headers'] as Lowercase]: T['headers'][K]; @@ -67,25 +66,25 @@ export type File = RichObject<'size'|'path'|'link'|'mimetype'|'preview-available 'height': string, } export type ChatMessage = components['schemas']['ChatMessageWithParent'] -export type receiveMessagesParams = ApiOptions['params'] +export type receiveMessagesParams = Required['requestBody']['content']['application/json'] export type receiveMessagesResponse = ApiResponse -export type getMessageContextParams = ApiOptions['params'] +export type getMessageContextParams = Required['requestBody']['content']['application/json'] export type getMessageContextResponse = ApiResponse -export type postNewMessageParams = ApiOptions['params'] +export type postNewMessageParams = Required['requestBody']['content']['application/json'] export type postNewMessageResponse = ApiResponse export type clearHistoryResponse = ApiResponse export type deleteMessageResponse = ApiResponse -export type editMessageParams = ApiOptions['params'] +export type editMessageParams = Required['requestBody']['content']['application/json'] export type editMessageResponse = ApiResponse -export type postRichObjectParams = ApiOptions['params'] +export type postRichObjectParams = Required['requestBody']['content']['application/json'] export type postRichObjectResponse = ApiResponse -export type setReadMarkerParams = ApiOptions['params'] +export type setReadMarkerParams = Required['requestBody']['content']['application/json'] export type setReadMarkerResponse = ApiResponse export type markUnreadResponse = ApiResponse // Avatars export type setFileAvatarResponse = ApiResponse -export type setEmojiAvatarParams = ApiOptions['params'] +export type setEmojiAvatarParams = Required['requestBody']['content']['application/json'] export type setEmojiAvatarResponse = ApiResponse export type deleteAvatarResponse = ApiResponse @@ -93,9 +92,8 @@ export type deleteAvatarResponse = ApiResponse -export type banActorParams = ApiOptions['params'] +export type banActorParams = Required['requestBody']['content']['application/json'] export type banActorResponse = ApiResponse -export type unbanActorParams = ApiOptions['params'] export type unbanActorResponse = ApiResponse // Bots @@ -121,11 +119,10 @@ export type acceptShareResponse = ApiResponse // Reactions -export type getReactionsParams = ApiOptions['params'] export type getReactionsResponse = ApiResponse -export type addReactionParams = ApiOptions['params'] +export type addReactionParams = Required['requestBody']['content']['application/json'] export type addReactionResponse = ApiResponse -export type deleteReactionParams = ApiOptions['params'] +export type deleteReactionParams = Required['requestBody']['content']['application/json'] export type deleteReactionResponse = ApiResponse // Breakout rooms @@ -133,18 +130,18 @@ export type BreakoutRoom = components['schemas']['Room'] & { objectType: 'room', } -export type configureBreakoutRoomsParams = ApiOptions['params'] +export type configureBreakoutRoomsParams = Required['requestBody']['content']['application/json'] export type configureBreakoutRoomsResponse = ApiResponse export type deleteBreakoutRoomsResponse = ApiResponse -export type reorganizeAttendeesParams = ApiOptions['params'] +export type reorganizeAttendeesParams = Required['requestBody']['content']['application/json'] export type reorganizeAttendeesResponse = ApiResponse export type getBreakoutRoomsResponse = ApiResponse export type startBreakoutRoomsResponse = ApiResponse export type stopBreakoutRoomsResponse = ApiResponse -export type broadcastChatMessageParams = ApiOptions['params'] +export type broadcastChatMessageParams = Required['requestBody']['content']['application/json'] export type broadcastChatMessageResponse = ApiResponse export type getBreakoutRoomsParticipantsResponse = ApiResponse export type requestAssistanceResponse = ApiResponse export type resetRequestAssistanceResponse = ApiResponse -export type switchToBreakoutRoomParams = ApiOptions['params'] +export type switchToBreakoutRoomParams = Required['requestBody']['content']['application/json'] export type switchToBreakoutRoomResponse = ApiResponse diff --git a/src/types/openapi/openapi-administration.ts b/src/types/openapi/openapi-administration.ts index 3e51b002245..26e8966d3e5 100644 --- a/src/types/openapi/openapi-administration.ts +++ b/src/types/openapi/openapi-administration.ts @@ -313,10 +313,7 @@ export interface operations { }; "certificate-get-certificate-expiration": { parameters: { - query: { - /** @description Host to check */ - host: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -326,7 +323,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Host to check */ + host: string; + }; + }; + }; responses: { /** @description Certificate expiration returned */ 200: { @@ -365,18 +369,7 @@ export interface operations { }; "hosted_signaling_server-request-trial": { parameters: { - query: { - /** @description Server URL */ - url: string; - /** @description Display name of the user */ - name: string; - /** @description Email of the user */ - email: string; - /** @description Language of the user */ - language: string; - /** @description Country of the user */ - country: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -386,7 +379,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Server URL */ + url: string; + /** @description Display name of the user */ + name: string; + /** @description Email of the user */ + email: string; + /** @description Language of the user */ + language: string; + /** @description Country of the user */ + country: string; + }; + }; + }; responses: { /** @description Trial requested successfully */ 200: { @@ -651,14 +659,7 @@ export interface operations { }; "settings-setsip-settings": { parameters: { - query?: { - /** @description New SIP groups */ - "sipGroups[]"?: string[]; - /** @description New dial info */ - dialInInfo?: string; - /** @description New shared secret */ - sharedSecret?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -668,7 +669,27 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description New SIP groups + * @default [] + */ + sipGroups?: string[]; + /** + * @description New dial info + * @default + */ + dialInInfo?: string; + /** + * @description New shared secret + * @default + */ + sharedSecret?: string; + }; + }; + }; responses: { /** @description Successfully set new SIP settings */ 200: { diff --git a/src/types/openapi/openapi-backend-recording.ts b/src/types/openapi/openapi-backend-recording.ts index bb69e6f8865..44a855289f2 100644 --- a/src/types/openapi/openapi-backend-recording.ts +++ b/src/types/openapi/openapi-backend-recording.ts @@ -207,10 +207,7 @@ export interface operations { }; "recording-store": { parameters: { - query?: { - /** @description User that will own the recording file. `null` is actually not allowed and will always result in a "400 Bad Request". It's only allowed code-wise to handle requests where the post data exceeded the limits, so we can return a proper error instead of "500 Internal Server Error". */ - owner?: string | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -221,7 +218,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description User that will own the recording file. `null` is actually not allowed and will always result in a "400 Bad Request". It's only allowed code-wise to handle requests where the post data exceeded the limits, so we can return a proper error instead of "500 Internal Server Error". */ + owner?: string | null; + }; + }; + }; responses: { /** @description Recording stored successfully */ 200: { diff --git a/src/types/openapi/openapi-backend-sipbridge.ts b/src/types/openapi/openapi-backend-sipbridge.ts index 60fea67f2de..503d32e7126 100644 --- a/src/types/openapi/openapi-backend-sipbridge.ts +++ b/src/types/openapi/openapi-backend-sipbridge.ts @@ -478,10 +478,7 @@ export interface operations { }; "room-verify-dial-in-pin": { parameters: { - query: { - /** @description PIN the participant used to dial-in */ - pin: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -492,7 +489,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description PIN the participant used to dial-in */ + pin: string; + }; + }; + }; responses: { /** @description Participant returned */ 200: { @@ -554,12 +558,7 @@ export interface operations { }; "room-verify-dial-out-number": { parameters: { - query: { - /** @description E164 formatted phone number */ - number: string; - /** @description Additional details to verify the validity of the request */ - options?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -570,7 +569,24 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description E164 formatted phone number */ + number: string; + /** + * @description Additional details to verify the validity of the request + * @default [] + */ + options?: { + actorId?: string; + actorType?: string; + /** Format: int64 */ + attendeeId?: number; + }; + }; + }; + }; responses: { /** @description Participant created successfully */ 200: { @@ -705,12 +721,7 @@ export interface operations { }; "room-rejected-dial-out-request": { parameters: { - query: { - /** @description The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate */ - callId: string; - /** @description Additional details to verify the validity of the request */ - options?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -721,7 +732,24 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate */ + callId: string; + /** + * @description Additional details to verify the validity of the request + * @default [] + */ + options?: { + actorId?: string; + actorType?: string; + /** Format: int64 */ + attendeeId?: number; + }; + }; + }; + }; responses: { /** @description Call ID reset */ 200: { diff --git a/src/types/openapi/openapi-bots.ts b/src/types/openapi/openapi-bots.ts index 0192673503f..9d81ad30d28 100644 --- a/src/types/openapi/openapi-bots.ts +++ b/src/types/openapi/openapi-bots.ts @@ -121,16 +121,7 @@ export type $defs = Record; export interface operations { "bot-send-message": { parameters: { - query: { - /** @description The message to send */ - message: string; - /** @description For the message to be able to later identify it again */ - referenceId?: string; - /** @description Parent id which this message is a reply to */ - replyTo?: number; - /** @description If sent silent the chat message will not create any notifications */ - silent?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -142,7 +133,30 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The message to send */ + message: string; + /** + * @description For the message to be able to later identify it again + * @default + */ + referenceId?: string; + /** + * Format: int64 + * @description Parent id which this message is a reply to + * @default 0 + */ + replyTo?: number; + /** + * @description If sent silent the chat message will not create any notifications + * @default false + */ + silent?: boolean; + }; + }; + }; responses: { /** @description Message sent successfully */ 201: { @@ -204,10 +218,7 @@ export interface operations { }; "bot-react": { parameters: { - query: { - /** @description Reaction to add */ - reaction: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -221,7 +232,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Reaction to add */ + reaction: string; + }; + }; + }; responses: { /** @description Reaction already exists */ 200: { @@ -297,10 +315,7 @@ export interface operations { }; "bot-delete-reaction": { parameters: { - query: { - /** @description Reaction to delete */ - reaction: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -314,7 +329,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Reaction to delete */ + reaction: string; + }; + }; + }; responses: { /** @description Reaction deleted successfully */ 200: { diff --git a/src/types/openapi/openapi-federation.ts b/src/types/openapi/openapi-federation.ts index b558303de44..35b06381e27 100644 --- a/src/types/openapi/openapi-federation.ts +++ b/src/types/openapi/openapi-federation.ts @@ -385,12 +385,7 @@ export type $defs = Record; export interface operations { "avatar-get-user-proxy-avatar-without-room": { parameters: { - query: { - /** @description Federation CloudID to get the avatar for */ - cloudId: string; - /** @description Theme used for background */ - darkTheme?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -402,7 +397,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Federation CloudID to get the avatar for */ + cloudId: string; + /** + * @description Theme used for background + * @default false + */ + darkTheme?: boolean; + }; + }; + }; responses: { /** @description User avatar returned */ 200: { @@ -417,10 +424,7 @@ export interface operations { }; "avatar-get-user-proxy-avatar-dark-without-room": { parameters: { - query: { - /** @description Federation CloudID to get the avatar for */ - cloudId: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -432,7 +436,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Federation CloudID to get the avatar for */ + cloudId: string; + }; + }; + }; responses: { /** @description User avatar returned */ 200: { @@ -447,12 +458,7 @@ export interface operations { }; "avatar-get-user-proxy-avatar": { parameters: { - query: { - /** @description Federation CloudID to get the avatar for */ - cloudId: string; - /** @description Theme used for background */ - darkTheme?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -465,7 +471,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Federation CloudID to get the avatar for */ + cloudId: string; + /** + * @description Theme used for background + * @default false + */ + darkTheme?: boolean; + }; + }; + }; responses: { /** @description User avatar returned */ 200: { @@ -480,10 +498,7 @@ export interface operations { }; "avatar-get-user-proxy-avatar-dark": { parameters: { - query: { - /** @description Federation CloudID to get the avatar for */ - cloudId: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -496,7 +511,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Federation CloudID to get the avatar for */ + cloudId: string; + }; + }; + }; responses: { /** @description User avatar returned */ 200: { diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts index b1412694208..60f16a8c050 100644 --- a/src/types/openapi/openapi-full.ts +++ b/src/types/openapi/openapi-full.ts @@ -2189,10 +2189,7 @@ export type $defs = Record; export interface operations { "avatar-get-avatar": { parameters: { - query?: { - /** @description Theme used for background */ - darkTheme?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2203,7 +2200,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Theme used for background + * @default false + */ + darkTheme?: boolean; + }; + }; + }; responses: { /** @description Room avatar returned */ 200: { @@ -2296,12 +2303,7 @@ export interface operations { }; "avatar-emoji-avatar": { parameters: { - query: { - /** @description Emoji */ - emoji: string; - /** @description Color of the emoji */ - color?: string | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2312,7 +2314,16 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Emoji */ + emoji: string; + /** @description Color of the emoji */ + color?: string | null; + }; + }; + }; responses: { /** @description Avatar set successfully */ 200: { @@ -2405,14 +2416,7 @@ export interface operations { }; "ban-ban-actor": { parameters: { - query: { - /** @description Type of actor to ban, or `ip` when banning a clients remote address */ - actorType: "users" | "guests" | "ip"; - /** @description Actor ID or the IP address or range in case of type `ip` */ - actorId: string; - /** @description Optional internal note (max. 4000 characters) */ - internalNote?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2423,7 +2427,24 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description Type of actor to ban, or `ip` when banning a clients remote address + * @enum {string} + */ + actorType: "users" | "guests" | "ip"; + /** @description Actor ID or the IP address or range in case of type `ip` */ + actorId: string; + /** + * @description Optional internal note (max. 4000 characters) + * @default + */ + internalNote?: string; + }; + }; + }; responses: { /** @description Ban successfully */ 200: { @@ -2636,14 +2657,7 @@ export interface operations { }; "breakout_room-configure-breakout-rooms": { parameters: { - query: { - /** @description Mode of the breakout rooms */ - mode: 0 | 1 | 2 | 3; - /** @description Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT} */ - amount: number; - /** @description Mapping of the attendees to breakout rooms */ - attendeeMap?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2654,7 +2668,28 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Mode of the breakout rooms + * @enum {integer} + */ + mode: 0 | 1 | 2 | 3; + /** + * Format: int64 + * @description Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT} + */ + amount: number; + /** + * @description Mapping of the attendees to breakout rooms + * @default [] + */ + attendeeMap?: string; + }; + }; + }; responses: { /** @description Breakout rooms configured successfully */ 200: { @@ -2721,10 +2756,7 @@ export interface operations { }; "breakout_room-broadcast-chat-message": { parameters: { - query: { - /** @description Message to broadcast */ - message: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2735,7 +2767,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Message to broadcast */ + message: string; + }; + }; + }; responses: { /** @description Chat message broadcasted successfully */ 201: { @@ -2787,10 +2826,7 @@ export interface operations { }; "breakout_room-apply-attendee-map": { parameters: { - query: { - /** @description JSON encoded mapping of the attendees to breakout rooms `array` */ - attendeeMap: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2801,7 +2837,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description JSON encoded mapping of the attendees to breakout rooms `array` */ + attendeeMap: string; + }; + }; + }; responses: { /** @description Attendee map applied successfully */ 200: { @@ -3025,10 +3068,7 @@ export interface operations { }; "breakout_room-switch-breakout-room": { parameters: { - query: { - /** @description Target breakout room */ - target: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3039,7 +3079,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Target breakout room */ + target: string; + }; + }; + }; responses: { /** @description Switched to breakout room successfully */ 200: { @@ -3106,10 +3153,7 @@ export interface operations { }; "call-update-call-flags": { parameters: { - query: { - /** @description New flags */ - flags: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3120,7 +3164,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New flags + */ + flags: number; + }; + }; + }; responses: { /** @description In-call flags updated successfully */ 200: { @@ -3168,16 +3222,7 @@ export interface operations { }; "call-join-call": { parameters: { - query?: { - /** @description In-Call flags */ - flags?: number | null; - /** @description In-call permissions */ - forcePermissions?: number | null; - /** @description Join the call silently */ - silent?: 0 | 1; - /** @description When the user ticked a checkbox and agreed with being recorded (Only needed when the `config => call => recording-consent` capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} and the conversation `recordingConsent` value is {@see RecordingService::CONSENT_REQUIRED_YES} ) */ - recordingConsent?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3188,7 +3233,35 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description In-Call flags + */ + flags?: number | null; + /** + * Format: int64 + * @description In-call permissions + */ + forcePermissions?: number | null; + /** + * @description Join the call silently + * @default false + */ + silent?: boolean; + /** + * @description When the user ticked a checkbox and agreed with being recorded + * (Only needed when the `config => call => recording-consent` capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} + * or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} + * and the conversation `recordingConsent` value is {@see RecordingService::CONSENT_REQUIRED_YES} ) + * @default false + */ + recordingConsent?: boolean; + }; + }; + }; responses: { /** @description Call joined successfully */ 200: { @@ -3238,10 +3311,7 @@ export interface operations { }; "call-leave-call": { parameters: { - query?: { - /** @description whether to also terminate the call for all participants */ - all?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3252,7 +3322,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description whether to also terminate the call for all participants + * @default false + */ + all?: boolean; + }; + }; + }; responses: { /** @description Call left successfully */ 200: { @@ -3436,26 +3516,7 @@ export interface operations { }; "chat-receive-messages": { parameters: { - query: { - /** @description Polling for new messages (1) or getting the history of the chat (0) */ - lookIntoFuture: 0 | 1; - /** @description Number of chat messages to receive (100 by default, 200 at most) */ - limit?: number; - /** @description The last known message (serves as offset) */ - lastKnownMessageId?: number; - /** @description The last known common read message (so the response is 200 instead of 304 when it changes even when there are no messages) */ - lastCommonReadId?: number; - /** @description Number of seconds to wait for new messages (30 by default, 30 at most) */ - timeout?: number; - /** @description Automatically set the last read marker when 1, if your client does this itself via chat/{token}/read set to 0 */ - setReadMarker?: 0 | 1; - /** @description Include the $lastKnownMessageId in the messages when 1 (default 0) */ - includeLastKnown?: 0 | 1; - /** @description When the user status should not be automatically set to online set to 1 (default 0) */ - noStatusUpdate?: 0 | 1; - /** @description Set to 0 when notifications should not be marked as read (default 1) */ - markNotificationsAsRead?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3466,7 +3527,73 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Polling for new messages (1) or getting the history of the chat (0) + * @enum {integer} + */ + lookIntoFuture: 0 | 1; + /** + * Format: int64 + * @description Number of chat messages to receive (100 by default, 200 at most) + * @default 100 + */ + limit?: number; + /** + * Format: int64 + * @description The last known message (serves as offset) + * @default 0 + */ + lastKnownMessageId?: number; + /** + * Format: int64 + * @description The last known common read message + * (so the response is 200 instead of 304 when + * it changes even when there are no messages) + * @default 0 + */ + lastCommonReadId?: number; + /** + * Format: int64 + * @description Number of seconds to wait for new messages (30 by default, 30 at most) + * @default 30 + */ + timeout?: number; + /** + * Format: int64 + * @description Automatically set the last read marker when 1, + * if your client does this itself via chat/{token}/read set to 0 + * @default 1 + * @enum {integer} + */ + setReadMarker?: 0 | 1; + /** + * Format: int64 + * @description Include the $lastKnownMessageId in the messages when 1 (default 0) + * @default 0 + * @enum {integer} + */ + includeLastKnown?: 0 | 1; + /** + * Format: int64 + * @description When the user status should not be automatically set to online set to 1 (default 0) + * @default 0 + * @enum {integer} + */ + noStatusUpdate?: 0 | 1; + /** + * Format: int64 + * @description Set to 0 when notifications should not be marked as read (default 1) + * @default 1 + * @enum {integer} + */ + markNotificationsAsRead?: 0 | 1; + }; + }; + }; responses: { /** @description Messages returned */ 200: { @@ -3495,18 +3622,7 @@ export interface operations { }; "chat-send-message": { parameters: { - query: { - /** @description the message to send */ - message: string; - /** @description for guests */ - actorDisplayName?: string; - /** @description for the message to be able to later identify it again */ - referenceId?: string; - /** @description Parent id which this message is a reply to */ - replyTo?: number; - /** @description If sent silent the chat message will not create any notifications */ - silent?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3517,7 +3633,35 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description the message to send */ + message: string; + /** + * @description for guests + * @default + */ + actorDisplayName?: string; + /** + * @description for the message to be able to later identify it again + * @default + */ + referenceId?: string; + /** + * Format: int64 + * @description Parent id which this message is a reply to + * @default 0 + */ + replyTo?: number; + /** + * @description If sent silent the chat message will not create any notifications + * @default false + */ + silent?: boolean; + }; + }; + }; responses: { /** @description Message sent successfully */ 201: { @@ -3655,10 +3799,7 @@ export interface operations { }; "chat-edit-message": { parameters: { - query: { - /** @description the message to send */ - message: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3671,7 +3812,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description the message to send */ + message: string; + }; + }; + }; responses: { /** @description Message edited successfully */ 200: { @@ -3884,10 +4032,7 @@ export interface operations { }; "chat-get-message-context": { parameters: { - query?: { - /** @description Number of chat messages to receive in both directions (50 by default, 100 at most, might return 201 messages) */ - limit?: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3900,7 +4045,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description Number of chat messages to receive in both directions (50 by default, 100 at most, might return 201 messages) + * @default 50 + */ + limit?: number; + }; + }; + }; responses: { /** @description Message context returned */ 200: { @@ -3978,10 +4134,7 @@ export interface operations { }; "chat-set-reminder": { parameters: { - query: { - /** @description Timestamp of the reminder */ - timestamp: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3994,7 +4147,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Timestamp of the reminder + */ + timestamp: number; + }; + }; + }; responses: { /** @description Reminder created successfully */ 201: { @@ -4081,10 +4244,7 @@ export interface operations { }; "chat-set-read-marker": { parameters: { - query?: { - /** @description ID if the last read message (Optional only with `chat-read-last` capability) */ - lastReadMessage?: number | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4095,7 +4255,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID if the last read message (Optional only with `chat-read-last` capability) + */ + lastReadMessage?: number | null; + }; + }; + }; responses: { /** @description Read marker set successfully */ 200: { @@ -4148,14 +4318,7 @@ export interface operations { }; "chat-mentions": { parameters: { - query: { - /** @description Text to search for */ - search: string; - /** @description Maximum number of results */ - limit?: number; - /** @description Include the user statuses */ - includeStatus?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4166,7 +4329,25 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Text to search for */ + search: string; + /** + * Format: int64 + * @description Maximum number of results + * @default 20 + */ + limit?: number; + /** + * @description Include the user statuses + * @default false + */ + includeStatus?: boolean; + }; + }; + }; responses: { /** @description List of mention suggestions returned */ 200: { @@ -4186,14 +4367,7 @@ export interface operations { }; "chat-get-objects-shared-in-room": { parameters: { - query: { - /** @description Type of the objects */ - objectType: string; - /** @description ID of the last known message */ - lastKnownMessageId?: number; - /** @description Maximum number of objects */ - limit?: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4204,7 +4378,26 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Type of the objects */ + objectType: string; + /** + * Format: int64 + * @description ID of the last known message + * @default 0 + */ + lastKnownMessageId?: number; + /** + * Format: int64 + * @description Maximum number of objects + * @default 100 + */ + limit?: number; + }; + }; + }; responses: { /** @description List of shared objects messages returned */ 200: { @@ -4225,18 +4418,7 @@ export interface operations { }; "chat-share-object-to-chat": { parameters: { - query: { - /** @description Type of the object */ - objectType: string; - /** @description ID of the object */ - objectId: string; - /** @description Additional metadata */ - metaData?: string; - /** @description Guest name */ - actorDisplayName?: string; - /** @description Reference ID */ - referenceId?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4247,7 +4429,31 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Type of the object */ + objectType: string; + /** @description ID of the object */ + objectId: string; + /** + * @description Additional metadata + * @default + */ + metaData?: string; + /** + * @description Guest name + * @default + */ + actorDisplayName?: string; + /** + * @description Reference ID + * @default + */ + referenceId?: string; + }; + }; + }; responses: { /** @description Object shared successfully */ 201: { @@ -4310,10 +4516,7 @@ export interface operations { }; "chat-get-objects-shared-in-room-overview": { parameters: { - query?: { - /** @description Maximum number of objects */ - limit?: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4324,7 +4527,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description Maximum number of objects + * @default 7 + */ + limit?: number; + }; + }; + }; responses: { /** @description List of shared objects messages of each type returned */ 200: { @@ -4472,10 +4686,7 @@ export interface operations { }; "guest-set-display-name": { parameters: { - query: { - /** @description New display name */ - displayName: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4486,7 +4697,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New display name */ + displayName: string; + }; + }; + }; responses: { /** @description Display name updated successfully */ 200: { @@ -4565,12 +4783,7 @@ export interface operations { }; "matterbridge-edit-bridge-of-room": { parameters: { - query: { - /** @description If the bridge should be enabled */ - enabled: 0 | 1; - /** @description New parts */ - parts?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4581,7 +4794,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description If the bridge should be enabled */ + enabled: boolean; + /** + * @description New parts + * @default [] + */ + parts?: components["schemas"]["MatterbridgeConfigFields"]; + }; + }; + }; responses: { /** @description Bridge edited successfully */ 200: { @@ -4695,16 +4920,7 @@ export interface operations { }; "poll-create-poll": { parameters: { - query: { - /** @description Question of the poll */ - question: string; - /** @description Options of the poll */ - "options[]": string[]; - /** @description Mode how the results will be shown */ - resultMode: 0 | 1; - /** @description Number of maximum votes per voter */ - maxVotes: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4715,7 +4931,27 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Question of the poll */ + question: string; + /** @description Options of the poll */ + options: string[]; + /** + * Format: int64 + * @description Mode how the results will be shown + * @enum {integer} + */ + resultMode: 0 | 1; + /** + * Format: int64 + * @description Number of maximum votes per voter + */ + maxVotes: number; + }; + }; + }; responses: { /** @description Poll created successfully */ 201: { @@ -4796,10 +5032,7 @@ export interface operations { }; "poll-vote-poll": { parameters: { - query?: { - /** @description IDs of the selected options */ - "optionIds[]"?: number[]; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4812,7 +5045,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description IDs of the selected options + * @default [] + */ + optionIds?: number[]; + }; + }; + }; responses: { /** @description Voted successfully */ 200: { @@ -4948,10 +5191,7 @@ export interface operations { }; "public_share_auth-create-room": { parameters: { - query: { - /** @description Token of the file share */ - shareToken: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4961,7 +5201,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Token of the file share */ + shareToken: string; + }; + }; + }; responses: { /** @description Room created successfully */ 201: { @@ -4999,10 +5246,7 @@ export interface operations { }; "reaction-get-reactions": { parameters: { - query?: { - /** @description Emoji to filter */ - reaction?: string | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5015,7 +5259,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description Emoji to filter */ + reaction?: string | null; + }; + }; + }; responses: { /** @description Reactions returned */ 200: { @@ -5051,10 +5302,7 @@ export interface operations { }; "reaction-react": { parameters: { - query: { - /** @description Emoji to add */ - reaction: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5067,7 +5315,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Emoji to add */ + reaction: string; + }; + }; + }; responses: { /** @description Reaction already existed */ 200: { @@ -5133,10 +5388,7 @@ export interface operations { }; "reaction-delete": { parameters: { - query: { - /** @description Emoji to remove */ - reaction: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5149,7 +5401,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Emoji to remove */ + reaction: string; + }; + }; + }; responses: { /** @description Reaction deleted successfully */ 200: { @@ -5199,10 +5458,7 @@ export interface operations { }; "recording-start": { parameters: { - query: { - /** @description Type of the recording */ - status: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5213,7 +5469,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Type of the recording + */ + status: number; + }; + }; + }; responses: { /** @description Recording started successfully */ 200: { @@ -5296,10 +5562,7 @@ export interface operations { }; "recording-notification-dismiss": { parameters: { - query: { - /** @description Timestamp of the notification to be dismissed */ - timestamp: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5310,7 +5573,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Timestamp of the notification to be dismissed + */ + timestamp: number; + }; + }; + }; responses: { /** @description Notification dismissed successfully */ 200: { @@ -5346,12 +5619,7 @@ export interface operations { }; "recording-share-to-chat": { parameters: { - query: { - /** @description ID of the file */ - fileId: number; - /** @description Timestamp of the notification to be dismissed */ - timestamp: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5362,7 +5630,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the file + */ + fileId: number; + /** + * Format: int64 + * @description Timestamp of the notification to be dismissed + */ + timestamp: number; + }; + }; + }; responses: { /** @description Recording shared to chat successfully */ 200: { @@ -5398,14 +5681,7 @@ export interface operations { }; "room-get-rooms": { parameters: { - query?: { - /** @description When the user status should not be automatically set to online set to 1 (default 0) */ - noStatusUpdate?: 0 | 1; - /** @description Include the user status */ - includeStatus?: 0 | 1; - /** @description Filter rooms modified after a timestamp */ - modifiedSince?: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5415,7 +5691,30 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description When the user status should not be automatically set to online set to 1 (default 0) + * @default 0 + * @enum {integer} + */ + noStatusUpdate?: 0 | 1; + /** + * @description Include the user status + * @default false + */ + includeStatus?: boolean; + /** + * Format: int64 + * @description Filter rooms modified after a timestamp + * @default 0 + */ + modifiedSince?: number; + }; + }; + }; responses: { /** @description Return list of rooms */ 200: { @@ -5438,20 +5737,7 @@ export interface operations { }; "room-create-room": { parameters: { - query: { - /** @description Type of the room */ - roomType: number; - /** @description User, group, … ID to invite */ - invite?: string; - /** @description Name of the room */ - roomName?: string; - /** @description Source of the invite ID ('circles' to create a room with a circle, etc.) */ - source?: string; - /** @description Type of the object */ - objectType?: string; - /** @description ID of the object */ - objectId?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5461,7 +5747,42 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Type of the room + */ + roomType: number; + /** + * @description User, group, … ID to invite + * @default + */ + invite?: string; + /** + * @description Name of the room + * @default + */ + roomName?: string; + /** + * @description Source of the invite ID ('circles' to create a room with a circle, etc.) + * @default + */ + source?: string; + /** + * @description Type of the object + * @default + */ + objectType?: string; + /** + * @description ID of the object + * @default + */ + objectId?: string; + }; + }; + }; responses: { /** @description Room already existed */ 200: { @@ -5539,10 +5860,7 @@ export interface operations { }; "room-get-listed-rooms": { parameters: { - query?: { - /** @description search term */ - searchTerm?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5552,7 +5870,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description search term + * @default + */ + searchTerm?: string; + }; + }; + }; responses: { /** @description Return list of matching rooms */ 200: { @@ -5801,10 +6129,7 @@ export interface operations { }; "room-set-description": { parameters: { - query: { - /** @description New description */ - description: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5815,7 +6140,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New description */ + description: string; + }; + }; + }; responses: { /** @description Description updated successfully */ 200: { @@ -5849,10 +6181,7 @@ export interface operations { }; "room-set-read-only": { parameters: { - query: { - /** @description New read-only state */ - state: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5863,7 +6192,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New read-only state + * @enum {integer} + */ + state: 0 | 1; + }; + }; + }; responses: { /** @description Read-only state updated successfully */ 200: { @@ -5897,10 +6237,7 @@ export interface operations { }; "room-set-listable": { parameters: { - query: { - /** @description Scope where the room is listable */ - scope: 0 | 1 | 2; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5911,7 +6248,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Scope where the room is listable + * @enum {integer} + */ + scope: 0 | 1 | 2; + }; + }; + }; responses: { /** @description Made room listable successfully */ 200: { @@ -5945,10 +6293,7 @@ export interface operations { }; "room-set-password": { parameters: { - query: { - /** @description New password */ - password: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5959,7 +6304,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New password */ + password: string; + }; + }; + }; responses: { /** @description Password set successfully */ 200: { @@ -6009,10 +6361,7 @@ export interface operations { }; "room-set-permissions": { parameters: { - query: { - /** @description New permissions */ - permissions: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6025,7 +6374,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New permissions + */ + permissions: number; + }; + }; + }; responses: { /** @description Permissions updated successfully */ 200: { @@ -6059,10 +6418,7 @@ export interface operations { }; "room-get-participants": { parameters: { - query?: { - /** @description Include the user statuses */ - includeStatus?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6073,7 +6429,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Include the user statuses + * @default false + */ + includeStatus?: boolean; + }; + }; + }; responses: { /** @description Participants returned */ 200: { @@ -6108,12 +6474,7 @@ export interface operations { }; "room-add-participant-to-room": { parameters: { - query: { - /** @description New participant */ - newParticipant: string; - /** @description Source of the participant */ - source?: "users" | "groups" | "circles" | "emails" | "federated_users" | "phones"; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6124,7 +6485,20 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New participant */ + newParticipant: string; + /** + * @description Source of the participant + * @default users + * @enum {string} + */ + source?: "users" | "groups" | "circles" | "emails" | "federated_users" | "phones"; + }; + }; + }; responses: { /** @description Participant successfully added */ 200: { @@ -6191,10 +6565,7 @@ export interface operations { }; "room-get-breakout-room-participants": { parameters: { - query?: { - /** @description Include the user statuses */ - includeStatus?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6205,7 +6576,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Include the user statuses + * @default false + */ + includeStatus?: boolean; + }; + }; + }; responses: { /** @description Breakout room participants returned */ 200: { @@ -6315,10 +6696,7 @@ export interface operations { }; "room-remove-attendee-from-room": { parameters: { - query: { - /** @description ID of the attendee */ - attendeeId: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6329,7 +6707,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId: number; + }; + }; + }; responses: { /** @description Attendee removed successfully */ 200: { @@ -6391,14 +6779,7 @@ export interface operations { }; "room-set-attendee-permissions": { parameters: { - query: { - /** @description ID of the attendee */ - attendeeId: number; - /** @description Method of updating permissions ('set', 'remove', 'add') */ - method: "set" | "remove" | "add"; - /** @description New permissions */ - permissions: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6409,7 +6790,27 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId: number; + /** + * @description Method of updating permissions ('set', 'remove', 'add') + * @enum {string} + */ + method: "set" | "remove" | "add"; + /** + * Format: int64 + * @description New permissions + */ + permissions: number; + }; + }; + }; responses: { /** @description Permissions updated successfully */ 200: { @@ -6471,12 +6872,7 @@ export interface operations { }; "room-set-all-attendees-permissions": { parameters: { - query: { - /** @description Method of updating permissions ('set', 'remove', 'add') */ - method: "set" | "remove" | "add"; - /** @description New permissions */ - permissions: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6487,7 +6883,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description Method of updating permissions ('set', 'remove', 'add') + * @enum {string} + */ + method: "set" | "remove" | "add"; + /** + * Format: int64 + * @description New permissions + */ + permissions: number; + }; + }; + }; responses: { /** @description Permissions updated successfully */ 200: { @@ -6521,12 +6932,7 @@ export interface operations { }; "room-join-room": { parameters: { - query?: { - /** @description Password of the room */ - password?: string; - /** @description Create a new session if necessary */ - force?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6538,7 +6944,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Password of the room + * @default + */ + password?: string; + /** + * @description Create a new session if necessary + * @default true + */ + force?: boolean; + }; + }; + }; responses: { /** @description Room joined successfully */ 200: { @@ -6642,10 +7063,7 @@ export interface operations { }; "room-resend-invitations": { parameters: { - query?: { - /** @description ID of the attendee */ - attendeeId?: number | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6656,7 +7074,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId?: number | null; + }; + }; + }; responses: { /** @description Invitation resent successfully */ 200: { @@ -6690,10 +7118,7 @@ export interface operations { }; "room-set-session-state": { parameters: { - query: { - /** @description of the room */ - state: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6704,7 +7129,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description of the room + * @enum {integer} + */ + state: 0 | 1; + }; + }; + }; responses: { /** @description Session state set successfully */ 200: { @@ -6752,10 +7188,7 @@ export interface operations { }; "room-promote-moderator": { parameters: { - query: { - /** @description ID of the attendee */ - attendeeId: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6766,7 +7199,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId: number; + }; + }; + }; responses: { /** @description Attendee promoted to moderator successfully */ 200: { @@ -6828,10 +7271,7 @@ export interface operations { }; "room-demote-moderator": { parameters: { - query: { - /** @description ID of the attendee */ - attendeeId: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6842,7 +7282,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId: number; + }; + }; + }; responses: { /** @description Attendee demoted from moderator successfully */ 200: { @@ -6966,10 +7416,7 @@ export interface operations { }; "room-set-notification-level": { parameters: { - query: { - /** @description New level */ - level: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6980,7 +7427,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New level + */ + level: number; + }; + }; + }; responses: { /** @description Notification level updated successfully */ 200: { @@ -7014,10 +7471,7 @@ export interface operations { }; "room-set-notification-calls": { parameters: { - query: { - /** @description New level */ - level: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7028,7 +7482,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New level + */ + level: number; + }; + }; + }; responses: { /** @description Call notification level updated successfully */ 200: { @@ -7062,12 +7526,7 @@ export interface operations { }; "room-set-lobby": { parameters: { - query: { - /** @description New state */ - state: number; - /** @description Timer when the lobby will be removed */ - timer?: number | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7078,7 +7537,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New state + */ + state: number; + /** + * Format: int64 + * @description Timer when the lobby will be removed + */ + timer?: number | null; + }; + }; + }; responses: { /** @description Lobby state updated successfully */ 200: { @@ -7112,10 +7586,7 @@ export interface operations { }; "room-setsip-enabled": { parameters: { - query: { - /** @description New state */ - state: 0 | 1 | 2; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7126,7 +7597,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New state + * @enum {integer} + */ + state: 0 | 1 | 2; + }; + }; + }; responses: { /** @description SIP enabled state updated successfully */ 200: { @@ -7202,10 +7684,7 @@ export interface operations { }; "room-set-recording-consent": { parameters: { - query: { - /** @description New consent setting for the conversation (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.) */ - recordingConsent: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7216,7 +7695,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New consent setting for the conversation + * (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.) + */ + recordingConsent: number; + }; + }; + }; responses: { /** @description Recording consent requirement set successfully */ 200: { @@ -7266,10 +7756,7 @@ export interface operations { }; "room-set-message-expiration": { parameters: { - query: { - /** @description New time */ - seconds: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7280,7 +7767,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New time + */ + seconds: number; + }; + }; + }; responses: { /** @description Message expiration time updated successfully */ 200: { @@ -7349,10 +7846,7 @@ export interface operations { }; "room-set-mention-permissions": { parameters: { - query: { - /** @description New mention permissions */ - mentionPermissions: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7363,7 +7857,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New mention permissions + * @enum {integer} + */ + mentionPermissions: 0 | 1; + }; + }; + }; responses: { /** @description Permissions updated successfully */ 200: { @@ -7397,12 +7902,7 @@ export interface operations { }; "settings-set-user-setting": { parameters: { - query: { - /** @description Key to update */ - key: "attachment_folder" | "read_status_privacy" | "typing_privacy" | "play_sounds"; - /** @description New value for the key */ - value?: (string | number) | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7412,7 +7912,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description Key to update + * @enum {string} + */ + key: "attachment_folder" | "read_status_privacy" | "typing_privacy" | "play_sounds"; + /** @description New value for the key */ + value?: (string | number) | null; + }; + }; + }; responses: { /** @description User setting updated successfully */ 200: { @@ -7446,10 +7958,7 @@ export interface operations { }; "signaling-get-settings": { parameters: { - query?: { - /** @description Token of the room */ - token?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7459,7 +7968,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Token of the room + * @default + */ + token?: string; + }; + }; + }; responses: { /** @description Signaling settings returned */ 200: { @@ -7590,10 +8109,7 @@ export interface operations { }; "signaling-send-messages": { parameters: { - query: { - /** @description JSON encoded messages */ - messages: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7605,7 +8121,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description JSON encoded messages */ + messages: string; + }; + }; + }; responses: { /** @description Signaling message sent successfully */ 200: { @@ -7725,12 +8248,7 @@ export interface operations { }; "avatar-get-user-proxy-avatar-without-room": { parameters: { - query: { - /** @description Federation CloudID to get the avatar for */ - cloudId: string; - /** @description Theme used for background */ - darkTheme?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7742,7 +8260,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Federation CloudID to get the avatar for */ + cloudId: string; + /** + * @description Theme used for background + * @default false + */ + darkTheme?: boolean; + }; + }; + }; responses: { /** @description User avatar returned */ 200: { @@ -7757,10 +8287,7 @@ export interface operations { }; "avatar-get-user-proxy-avatar-dark-without-room": { parameters: { - query: { - /** @description Federation CloudID to get the avatar for */ - cloudId: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7772,7 +8299,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Federation CloudID to get the avatar for */ + cloudId: string; + }; + }; + }; responses: { /** @description User avatar returned */ 200: { @@ -7787,12 +8321,7 @@ export interface operations { }; "avatar-get-user-proxy-avatar": { parameters: { - query: { - /** @description Federation CloudID to get the avatar for */ - cloudId: string; - /** @description Theme used for background */ - darkTheme?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7805,7 +8334,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Federation CloudID to get the avatar for */ + cloudId: string; + /** + * @description Theme used for background + * @default false + */ + darkTheme?: boolean; + }; + }; + }; responses: { /** @description User avatar returned */ 200: { @@ -7820,10 +8361,7 @@ export interface operations { }; "avatar-get-user-proxy-avatar-dark": { parameters: { - query: { - /** @description Federation CloudID to get the avatar for */ - cloudId: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7836,7 +8374,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Federation CloudID to get the avatar for */ + cloudId: string; + }; + }; + }; responses: { /** @description User avatar returned */ 200: { @@ -8072,16 +8617,7 @@ export interface operations { }; "bot-send-message": { parameters: { - query: { - /** @description The message to send */ - message: string; - /** @description For the message to be able to later identify it again */ - referenceId?: string; - /** @description Parent id which this message is a reply to */ - replyTo?: number; - /** @description If sent silent the chat message will not create any notifications */ - silent?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -8093,7 +8629,30 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The message to send */ + message: string; + /** + * @description For the message to be able to later identify it again + * @default + */ + referenceId?: string; + /** + * Format: int64 + * @description Parent id which this message is a reply to + * @default 0 + */ + replyTo?: number; + /** + * @description If sent silent the chat message will not create any notifications + * @default false + */ + silent?: boolean; + }; + }; + }; responses: { /** @description Message sent successfully */ 201: { @@ -8155,10 +8714,7 @@ export interface operations { }; "bot-react": { parameters: { - query: { - /** @description Reaction to add */ - reaction: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -8172,7 +8728,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Reaction to add */ + reaction: string; + }; + }; + }; responses: { /** @description Reaction already exists */ 200: { @@ -8248,10 +8811,7 @@ export interface operations { }; "bot-delete-reaction": { parameters: { - query: { - /** @description Reaction to delete */ - reaction: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -8265,7 +8825,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Reaction to delete */ + reaction: string; + }; + }; + }; responses: { /** @description Reaction deleted successfully */ 200: { @@ -8357,10 +8924,7 @@ export interface operations { }; "certificate-get-certificate-expiration": { parameters: { - query: { - /** @description Host to check */ - host: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -8370,7 +8934,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Host to check */ + host: string; + }; + }; + }; responses: { /** @description Certificate expiration returned */ 200: { @@ -8409,18 +8980,7 @@ export interface operations { }; "hosted_signaling_server-request-trial": { parameters: { - query: { - /** @description Server URL */ - url: string; - /** @description Display name of the user */ - name: string; - /** @description Email of the user */ - email: string; - /** @description Language of the user */ - language: string; - /** @description Country of the user */ - country: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -8430,7 +8990,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Server URL */ + url: string; + /** @description Display name of the user */ + name: string; + /** @description Email of the user */ + email: string; + /** @description Language of the user */ + language: string; + /** @description Country of the user */ + country: string; + }; + }; + }; responses: { /** @description Trial requested successfully */ 200: { @@ -8695,14 +9270,7 @@ export interface operations { }; "settings-setsip-settings": { parameters: { - query?: { - /** @description New SIP groups */ - "sipGroups[]"?: string[]; - /** @description New dial info */ - dialInInfo?: string; - /** @description New shared secret */ - sharedSecret?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -8712,7 +9280,27 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description New SIP groups + * @default [] + */ + sipGroups?: string[]; + /** + * @description New dial info + * @default + */ + dialInInfo?: string; + /** + * @description New shared secret + * @default + */ + sharedSecret?: string; + }; + }; + }; responses: { /** @description Successfully set new SIP settings */ 200: { @@ -8886,10 +9474,7 @@ export interface operations { }; "recording-store": { parameters: { - query?: { - /** @description User that will own the recording file. `null` is actually not allowed and will always result in a "400 Bad Request". It's only allowed code-wise to handle requests where the post data exceeded the limits, so we can return a proper error instead of "500 Internal Server Error". */ - owner?: string | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -8900,7 +9485,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description User that will own the recording file. `null` is actually not allowed and will always result in a "400 Bad Request". It's only allowed code-wise to handle requests where the post data exceeded the limits, so we can return a proper error instead of "500 Internal Server Error". */ + owner?: string | null; + }; + }; + }; responses: { /** @description Recording stored successfully */ 200: { @@ -9031,10 +9623,7 @@ export interface operations { }; "room-verify-dial-in-pin": { parameters: { - query: { - /** @description PIN the participant used to dial-in */ - pin: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -9045,7 +9634,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description PIN the participant used to dial-in */ + pin: string; + }; + }; + }; responses: { /** @description Participant returned */ 200: { @@ -9107,12 +9703,7 @@ export interface operations { }; "room-verify-dial-out-number": { parameters: { - query: { - /** @description E164 formatted phone number */ - number: string; - /** @description Additional details to verify the validity of the request */ - options?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -9123,7 +9714,24 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description E164 formatted phone number */ + number: string; + /** + * @description Additional details to verify the validity of the request + * @default [] + */ + options?: { + actorId?: string; + actorType?: string; + /** Format: int64 */ + attendeeId?: number; + }; + }; + }; + }; responses: { /** @description Participant created successfully */ 200: { @@ -9258,12 +9866,7 @@ export interface operations { }; "room-rejected-dial-out-request": { parameters: { - query: { - /** @description The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate */ - callId: string; - /** @description Additional details to verify the validity of the request */ - options?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -9274,7 +9877,24 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The call ID provided by the SIP bridge earlier to uniquely identify the call to terminate */ + callId: string; + /** + * @description Additional details to verify the validity of the request + * @default [] + */ + options?: { + actorId?: string; + actorType?: string; + /** Format: int64 */ + attendeeId?: number; + }; + }; + }; + }; responses: { /** @description Call ID reset */ 200: { diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts index 4f36d9b9ef2..854ed99dc72 100644 --- a/src/types/openapi/openapi.ts +++ b/src/types/openapi/openapi.ts @@ -1674,10 +1674,7 @@ export type $defs = Record; export interface operations { "avatar-get-avatar": { parameters: { - query?: { - /** @description Theme used for background */ - darkTheme?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -1688,7 +1685,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Theme used for background + * @default false + */ + darkTheme?: boolean; + }; + }; + }; responses: { /** @description Room avatar returned */ 200: { @@ -1781,12 +1788,7 @@ export interface operations { }; "avatar-emoji-avatar": { parameters: { - query: { - /** @description Emoji */ - emoji: string; - /** @description Color of the emoji */ - color?: string | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -1797,7 +1799,16 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Emoji */ + emoji: string; + /** @description Color of the emoji */ + color?: string | null; + }; + }; + }; responses: { /** @description Avatar set successfully */ 200: { @@ -1890,14 +1901,7 @@ export interface operations { }; "ban-ban-actor": { parameters: { - query: { - /** @description Type of actor to ban, or `ip` when banning a clients remote address */ - actorType: "users" | "guests" | "ip"; - /** @description Actor ID or the IP address or range in case of type `ip` */ - actorId: string; - /** @description Optional internal note (max. 4000 characters) */ - internalNote?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -1908,7 +1912,24 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description Type of actor to ban, or `ip` when banning a clients remote address + * @enum {string} + */ + actorType: "users" | "guests" | "ip"; + /** @description Actor ID or the IP address or range in case of type `ip` */ + actorId: string; + /** + * @description Optional internal note (max. 4000 characters) + * @default + */ + internalNote?: string; + }; + }; + }; responses: { /** @description Ban successfully */ 200: { @@ -2121,14 +2142,7 @@ export interface operations { }; "breakout_room-configure-breakout-rooms": { parameters: { - query: { - /** @description Mode of the breakout rooms */ - mode: 0 | 1 | 2 | 3; - /** @description Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT} */ - amount: number; - /** @description Mapping of the attendees to breakout rooms */ - attendeeMap?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2139,7 +2153,28 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Mode of the breakout rooms + * @enum {integer} + */ + mode: 0 | 1 | 2 | 3; + /** + * Format: int64 + * @description Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT} + */ + amount: number; + /** + * @description Mapping of the attendees to breakout rooms + * @default [] + */ + attendeeMap?: string; + }; + }; + }; responses: { /** @description Breakout rooms configured successfully */ 200: { @@ -2206,10 +2241,7 @@ export interface operations { }; "breakout_room-broadcast-chat-message": { parameters: { - query: { - /** @description Message to broadcast */ - message: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2220,7 +2252,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Message to broadcast */ + message: string; + }; + }; + }; responses: { /** @description Chat message broadcasted successfully */ 201: { @@ -2272,10 +2311,7 @@ export interface operations { }; "breakout_room-apply-attendee-map": { parameters: { - query: { - /** @description JSON encoded mapping of the attendees to breakout rooms `array` */ - attendeeMap: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2286,7 +2322,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description JSON encoded mapping of the attendees to breakout rooms `array` */ + attendeeMap: string; + }; + }; + }; responses: { /** @description Attendee map applied successfully */ 200: { @@ -2510,10 +2553,7 @@ export interface operations { }; "breakout_room-switch-breakout-room": { parameters: { - query: { - /** @description Target breakout room */ - target: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2524,7 +2564,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Target breakout room */ + target: string; + }; + }; + }; responses: { /** @description Switched to breakout room successfully */ 200: { @@ -2591,10 +2638,7 @@ export interface operations { }; "call-update-call-flags": { parameters: { - query: { - /** @description New flags */ - flags: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2605,7 +2649,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New flags + */ + flags: number; + }; + }; + }; responses: { /** @description In-call flags updated successfully */ 200: { @@ -2653,16 +2707,7 @@ export interface operations { }; "call-join-call": { parameters: { - query?: { - /** @description In-Call flags */ - flags?: number | null; - /** @description In-call permissions */ - forcePermissions?: number | null; - /** @description Join the call silently */ - silent?: 0 | 1; - /** @description When the user ticked a checkbox and agreed with being recorded (Only needed when the `config => call => recording-consent` capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} and the conversation `recordingConsent` value is {@see RecordingService::CONSENT_REQUIRED_YES} ) */ - recordingConsent?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2673,7 +2718,35 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description In-Call flags + */ + flags?: number | null; + /** + * Format: int64 + * @description In-call permissions + */ + forcePermissions?: number | null; + /** + * @description Join the call silently + * @default false + */ + silent?: boolean; + /** + * @description When the user ticked a checkbox and agreed with being recorded + * (Only needed when the `config => call => recording-consent` capability is set to {@see RecordingService::CONSENT_REQUIRED_YES} + * or the capability is {@see RecordingService::CONSENT_REQUIRED_OPTIONAL} + * and the conversation `recordingConsent` value is {@see RecordingService::CONSENT_REQUIRED_YES} ) + * @default false + */ + recordingConsent?: boolean; + }; + }; + }; responses: { /** @description Call joined successfully */ 200: { @@ -2723,10 +2796,7 @@ export interface operations { }; "call-leave-call": { parameters: { - query?: { - /** @description whether to also terminate the call for all participants */ - all?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2737,7 +2807,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description whether to also terminate the call for all participants + * @default false + */ + all?: boolean; + }; + }; + }; responses: { /** @description Call left successfully */ 200: { @@ -2921,26 +3001,7 @@ export interface operations { }; "chat-receive-messages": { parameters: { - query: { - /** @description Polling for new messages (1) or getting the history of the chat (0) */ - lookIntoFuture: 0 | 1; - /** @description Number of chat messages to receive (100 by default, 200 at most) */ - limit?: number; - /** @description The last known message (serves as offset) */ - lastKnownMessageId?: number; - /** @description The last known common read message (so the response is 200 instead of 304 when it changes even when there are no messages) */ - lastCommonReadId?: number; - /** @description Number of seconds to wait for new messages (30 by default, 30 at most) */ - timeout?: number; - /** @description Automatically set the last read marker when 1, if your client does this itself via chat/{token}/read set to 0 */ - setReadMarker?: 0 | 1; - /** @description Include the $lastKnownMessageId in the messages when 1 (default 0) */ - includeLastKnown?: 0 | 1; - /** @description When the user status should not be automatically set to online set to 1 (default 0) */ - noStatusUpdate?: 0 | 1; - /** @description Set to 0 when notifications should not be marked as read (default 1) */ - markNotificationsAsRead?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -2951,7 +3012,73 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Polling for new messages (1) or getting the history of the chat (0) + * @enum {integer} + */ + lookIntoFuture: 0 | 1; + /** + * Format: int64 + * @description Number of chat messages to receive (100 by default, 200 at most) + * @default 100 + */ + limit?: number; + /** + * Format: int64 + * @description The last known message (serves as offset) + * @default 0 + */ + lastKnownMessageId?: number; + /** + * Format: int64 + * @description The last known common read message + * (so the response is 200 instead of 304 when + * it changes even when there are no messages) + * @default 0 + */ + lastCommonReadId?: number; + /** + * Format: int64 + * @description Number of seconds to wait for new messages (30 by default, 30 at most) + * @default 30 + */ + timeout?: number; + /** + * Format: int64 + * @description Automatically set the last read marker when 1, + * if your client does this itself via chat/{token}/read set to 0 + * @default 1 + * @enum {integer} + */ + setReadMarker?: 0 | 1; + /** + * Format: int64 + * @description Include the $lastKnownMessageId in the messages when 1 (default 0) + * @default 0 + * @enum {integer} + */ + includeLastKnown?: 0 | 1; + /** + * Format: int64 + * @description When the user status should not be automatically set to online set to 1 (default 0) + * @default 0 + * @enum {integer} + */ + noStatusUpdate?: 0 | 1; + /** + * Format: int64 + * @description Set to 0 when notifications should not be marked as read (default 1) + * @default 1 + * @enum {integer} + */ + markNotificationsAsRead?: 0 | 1; + }; + }; + }; responses: { /** @description Messages returned */ 200: { @@ -2980,18 +3107,7 @@ export interface operations { }; "chat-send-message": { parameters: { - query: { - /** @description the message to send */ - message: string; - /** @description for guests */ - actorDisplayName?: string; - /** @description for the message to be able to later identify it again */ - referenceId?: string; - /** @description Parent id which this message is a reply to */ - replyTo?: number; - /** @description If sent silent the chat message will not create any notifications */ - silent?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3002,7 +3118,35 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description the message to send */ + message: string; + /** + * @description for guests + * @default + */ + actorDisplayName?: string; + /** + * @description for the message to be able to later identify it again + * @default + */ + referenceId?: string; + /** + * Format: int64 + * @description Parent id which this message is a reply to + * @default 0 + */ + replyTo?: number; + /** + * @description If sent silent the chat message will not create any notifications + * @default false + */ + silent?: boolean; + }; + }; + }; responses: { /** @description Message sent successfully */ 201: { @@ -3140,10 +3284,7 @@ export interface operations { }; "chat-edit-message": { parameters: { - query: { - /** @description the message to send */ - message: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3156,7 +3297,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description the message to send */ + message: string; + }; + }; + }; responses: { /** @description Message edited successfully */ 200: { @@ -3369,10 +3517,7 @@ export interface operations { }; "chat-get-message-context": { parameters: { - query?: { - /** @description Number of chat messages to receive in both directions (50 by default, 100 at most, might return 201 messages) */ - limit?: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3385,7 +3530,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description Number of chat messages to receive in both directions (50 by default, 100 at most, might return 201 messages) + * @default 50 + */ + limit?: number; + }; + }; + }; responses: { /** @description Message context returned */ 200: { @@ -3463,10 +3619,7 @@ export interface operations { }; "chat-set-reminder": { parameters: { - query: { - /** @description Timestamp of the reminder */ - timestamp: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3479,7 +3632,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Timestamp of the reminder + */ + timestamp: number; + }; + }; + }; responses: { /** @description Reminder created successfully */ 201: { @@ -3566,10 +3729,7 @@ export interface operations { }; "chat-set-read-marker": { parameters: { - query?: { - /** @description ID if the last read message (Optional only with `chat-read-last` capability) */ - lastReadMessage?: number | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3580,7 +3740,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID if the last read message (Optional only with `chat-read-last` capability) + */ + lastReadMessage?: number | null; + }; + }; + }; responses: { /** @description Read marker set successfully */ 200: { @@ -3633,14 +3803,7 @@ export interface operations { }; "chat-mentions": { parameters: { - query: { - /** @description Text to search for */ - search: string; - /** @description Maximum number of results */ - limit?: number; - /** @description Include the user statuses */ - includeStatus?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3651,7 +3814,25 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Text to search for */ + search: string; + /** + * Format: int64 + * @description Maximum number of results + * @default 20 + */ + limit?: number; + /** + * @description Include the user statuses + * @default false + */ + includeStatus?: boolean; + }; + }; + }; responses: { /** @description List of mention suggestions returned */ 200: { @@ -3671,14 +3852,7 @@ export interface operations { }; "chat-get-objects-shared-in-room": { parameters: { - query: { - /** @description Type of the objects */ - objectType: string; - /** @description ID of the last known message */ - lastKnownMessageId?: number; - /** @description Maximum number of objects */ - limit?: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3689,7 +3863,26 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Type of the objects */ + objectType: string; + /** + * Format: int64 + * @description ID of the last known message + * @default 0 + */ + lastKnownMessageId?: number; + /** + * Format: int64 + * @description Maximum number of objects + * @default 100 + */ + limit?: number; + }; + }; + }; responses: { /** @description List of shared objects messages returned */ 200: { @@ -3710,18 +3903,7 @@ export interface operations { }; "chat-share-object-to-chat": { parameters: { - query: { - /** @description Type of the object */ - objectType: string; - /** @description ID of the object */ - objectId: string; - /** @description Additional metadata */ - metaData?: string; - /** @description Guest name */ - actorDisplayName?: string; - /** @description Reference ID */ - referenceId?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3732,7 +3914,31 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Type of the object */ + objectType: string; + /** @description ID of the object */ + objectId: string; + /** + * @description Additional metadata + * @default + */ + metaData?: string; + /** + * @description Guest name + * @default + */ + actorDisplayName?: string; + /** + * @description Reference ID + * @default + */ + referenceId?: string; + }; + }; + }; responses: { /** @description Object shared successfully */ 201: { @@ -3795,10 +4001,7 @@ export interface operations { }; "chat-get-objects-shared-in-room-overview": { parameters: { - query?: { - /** @description Maximum number of objects */ - limit?: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3809,7 +4012,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description Maximum number of objects + * @default 7 + */ + limit?: number; + }; + }; + }; responses: { /** @description List of shared objects messages of each type returned */ 200: { @@ -3957,10 +4171,7 @@ export interface operations { }; "guest-set-display-name": { parameters: { - query: { - /** @description New display name */ - displayName: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -3971,7 +4182,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New display name */ + displayName: string; + }; + }; + }; responses: { /** @description Display name updated successfully */ 200: { @@ -4050,12 +4268,7 @@ export interface operations { }; "matterbridge-edit-bridge-of-room": { parameters: { - query: { - /** @description If the bridge should be enabled */ - enabled: 0 | 1; - /** @description New parts */ - parts?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4066,7 +4279,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description If the bridge should be enabled */ + enabled: boolean; + /** + * @description New parts + * @default [] + */ + parts?: components["schemas"]["MatterbridgeConfigFields"]; + }; + }; + }; responses: { /** @description Bridge edited successfully */ 200: { @@ -4180,16 +4405,7 @@ export interface operations { }; "poll-create-poll": { parameters: { - query: { - /** @description Question of the poll */ - question: string; - /** @description Options of the poll */ - "options[]": string[]; - /** @description Mode how the results will be shown */ - resultMode: 0 | 1; - /** @description Number of maximum votes per voter */ - maxVotes: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4200,7 +4416,27 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Question of the poll */ + question: string; + /** @description Options of the poll */ + options: string[]; + /** + * Format: int64 + * @description Mode how the results will be shown + * @enum {integer} + */ + resultMode: 0 | 1; + /** + * Format: int64 + * @description Number of maximum votes per voter + */ + maxVotes: number; + }; + }; + }; responses: { /** @description Poll created successfully */ 201: { @@ -4281,10 +4517,7 @@ export interface operations { }; "poll-vote-poll": { parameters: { - query?: { - /** @description IDs of the selected options */ - "optionIds[]"?: number[]; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4297,7 +4530,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description IDs of the selected options + * @default [] + */ + optionIds?: number[]; + }; + }; + }; responses: { /** @description Voted successfully */ 200: { @@ -4433,10 +4676,7 @@ export interface operations { }; "public_share_auth-create-room": { parameters: { - query: { - /** @description Token of the file share */ - shareToken: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4446,7 +4686,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Token of the file share */ + shareToken: string; + }; + }; + }; responses: { /** @description Room created successfully */ 201: { @@ -4484,10 +4731,7 @@ export interface operations { }; "reaction-get-reactions": { parameters: { - query?: { - /** @description Emoji to filter */ - reaction?: string | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4500,7 +4744,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description Emoji to filter */ + reaction?: string | null; + }; + }; + }; responses: { /** @description Reactions returned */ 200: { @@ -4536,10 +4787,7 @@ export interface operations { }; "reaction-react": { parameters: { - query: { - /** @description Emoji to add */ - reaction: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4552,7 +4800,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Emoji to add */ + reaction: string; + }; + }; + }; responses: { /** @description Reaction already existed */ 200: { @@ -4618,10 +4873,7 @@ export interface operations { }; "reaction-delete": { parameters: { - query: { - /** @description Emoji to remove */ - reaction: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4634,7 +4886,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Emoji to remove */ + reaction: string; + }; + }; + }; responses: { /** @description Reaction deleted successfully */ 200: { @@ -4684,10 +4943,7 @@ export interface operations { }; "recording-start": { parameters: { - query: { - /** @description Type of the recording */ - status: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4698,7 +4954,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Type of the recording + */ + status: number; + }; + }; + }; responses: { /** @description Recording started successfully */ 200: { @@ -4781,10 +5047,7 @@ export interface operations { }; "recording-notification-dismiss": { parameters: { - query: { - /** @description Timestamp of the notification to be dismissed */ - timestamp: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4795,7 +5058,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Timestamp of the notification to be dismissed + */ + timestamp: number; + }; + }; + }; responses: { /** @description Notification dismissed successfully */ 200: { @@ -4831,12 +5104,7 @@ export interface operations { }; "recording-share-to-chat": { parameters: { - query: { - /** @description ID of the file */ - fileId: number; - /** @description Timestamp of the notification to be dismissed */ - timestamp: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4847,7 +5115,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the file + */ + fileId: number; + /** + * Format: int64 + * @description Timestamp of the notification to be dismissed + */ + timestamp: number; + }; + }; + }; responses: { /** @description Recording shared to chat successfully */ 200: { @@ -4883,14 +5166,7 @@ export interface operations { }; "room-get-rooms": { parameters: { - query?: { - /** @description When the user status should not be automatically set to online set to 1 (default 0) */ - noStatusUpdate?: 0 | 1; - /** @description Include the user status */ - includeStatus?: 0 | 1; - /** @description Filter rooms modified after a timestamp */ - modifiedSince?: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4900,7 +5176,30 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description When the user status should not be automatically set to online set to 1 (default 0) + * @default 0 + * @enum {integer} + */ + noStatusUpdate?: 0 | 1; + /** + * @description Include the user status + * @default false + */ + includeStatus?: boolean; + /** + * Format: int64 + * @description Filter rooms modified after a timestamp + * @default 0 + */ + modifiedSince?: number; + }; + }; + }; responses: { /** @description Return list of rooms */ 200: { @@ -4923,20 +5222,7 @@ export interface operations { }; "room-create-room": { parameters: { - query: { - /** @description Type of the room */ - roomType: number; - /** @description User, group, … ID to invite */ - invite?: string; - /** @description Name of the room */ - roomName?: string; - /** @description Source of the invite ID ('circles' to create a room with a circle, etc.) */ - source?: string; - /** @description Type of the object */ - objectType?: string; - /** @description ID of the object */ - objectId?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -4946,7 +5232,42 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Type of the room + */ + roomType: number; + /** + * @description User, group, … ID to invite + * @default + */ + invite?: string; + /** + * @description Name of the room + * @default + */ + roomName?: string; + /** + * @description Source of the invite ID ('circles' to create a room with a circle, etc.) + * @default + */ + source?: string; + /** + * @description Type of the object + * @default + */ + objectType?: string; + /** + * @description ID of the object + * @default + */ + objectId?: string; + }; + }; + }; responses: { /** @description Room already existed */ 200: { @@ -5024,10 +5345,7 @@ export interface operations { }; "room-get-listed-rooms": { parameters: { - query?: { - /** @description search term */ - searchTerm?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5037,7 +5355,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description search term + * @default + */ + searchTerm?: string; + }; + }; + }; responses: { /** @description Return list of matching rooms */ 200: { @@ -5149,10 +5477,7 @@ export interface operations { }; "room-rename-room": { parameters: { - query: { - /** @description New name */ - roomName: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5163,7 +5488,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New name */ + roomName: string; + }; + }; + }; responses: { /** @description Room renamed successfully */ 200: { @@ -5379,10 +5711,7 @@ export interface operations { }; "room-set-description": { parameters: { - query: { - /** @description New description */ - description: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5393,7 +5722,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New description */ + description: string; + }; + }; + }; responses: { /** @description Description updated successfully */ 200: { @@ -5427,10 +5763,7 @@ export interface operations { }; "room-set-read-only": { parameters: { - query: { - /** @description New read-only state */ - state: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5441,7 +5774,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New read-only state + * @enum {integer} + */ + state: 0 | 1; + }; + }; + }; responses: { /** @description Read-only state updated successfully */ 200: { @@ -5475,10 +5819,7 @@ export interface operations { }; "room-set-listable": { parameters: { - query: { - /** @description Scope where the room is listable */ - scope: 0 | 1 | 2; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5489,7 +5830,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description Scope where the room is listable + * @enum {integer} + */ + scope: 0 | 1 | 2; + }; + }; + }; responses: { /** @description Made room listable successfully */ 200: { @@ -5523,10 +5875,7 @@ export interface operations { }; "room-set-password": { parameters: { - query: { - /** @description New password */ - password: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5537,7 +5886,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New password */ + password: string; + }; + }; + }; responses: { /** @description Password set successfully */ 200: { @@ -5587,10 +5943,7 @@ export interface operations { }; "room-set-permissions": { parameters: { - query: { - /** @description New permissions */ - permissions: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5603,7 +5956,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New permissions + */ + permissions: number; + }; + }; + }; responses: { /** @description Permissions updated successfully */ 200: { @@ -5637,10 +6000,7 @@ export interface operations { }; "room-get-participants": { parameters: { - query?: { - /** @description Include the user statuses */ - includeStatus?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5651,7 +6011,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Include the user statuses + * @default false + */ + includeStatus?: boolean; + }; + }; + }; responses: { /** @description Participants returned */ 200: { @@ -5686,12 +6056,7 @@ export interface operations { }; "room-add-participant-to-room": { parameters: { - query: { - /** @description New participant */ - newParticipant: string; - /** @description Source of the participant */ - source?: "users" | "groups" | "circles" | "emails" | "federated_users" | "phones"; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5702,7 +6067,20 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description New participant */ + newParticipant: string; + /** + * @description Source of the participant + * @default users + * @enum {string} + */ + source?: "users" | "groups" | "circles" | "emails" | "federated_users" | "phones"; + }; + }; + }; responses: { /** @description Participant successfully added */ 200: { @@ -5769,10 +6147,7 @@ export interface operations { }; "room-get-breakout-room-participants": { parameters: { - query?: { - /** @description Include the user statuses */ - includeStatus?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5783,7 +6158,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Include the user statuses + * @default false + */ + includeStatus?: boolean; + }; + }; + }; responses: { /** @description Breakout room participants returned */ 200: { @@ -5893,10 +6278,7 @@ export interface operations { }; "room-remove-attendee-from-room": { parameters: { - query: { - /** @description ID of the attendee */ - attendeeId: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5907,7 +6289,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId: number; + }; + }; + }; responses: { /** @description Attendee removed successfully */ 200: { @@ -5969,14 +6361,7 @@ export interface operations { }; "room-set-attendee-permissions": { parameters: { - query: { - /** @description ID of the attendee */ - attendeeId: number; - /** @description Method of updating permissions ('set', 'remove', 'add') */ - method: "set" | "remove" | "add"; - /** @description New permissions */ - permissions: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -5987,7 +6372,27 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId: number; + /** + * @description Method of updating permissions ('set', 'remove', 'add') + * @enum {string} + */ + method: "set" | "remove" | "add"; + /** + * Format: int64 + * @description New permissions + */ + permissions: number; + }; + }; + }; responses: { /** @description Permissions updated successfully */ 200: { @@ -6049,12 +6454,7 @@ export interface operations { }; "room-set-all-attendees-permissions": { parameters: { - query: { - /** @description Method of updating permissions ('set', 'remove', 'add') */ - method: "set" | "remove" | "add"; - /** @description New permissions */ - permissions: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6065,7 +6465,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description Method of updating permissions ('set', 'remove', 'add') + * @enum {string} + */ + method: "set" | "remove" | "add"; + /** + * Format: int64 + * @description New permissions + */ + permissions: number; + }; + }; + }; responses: { /** @description Permissions updated successfully */ 200: { @@ -6099,12 +6514,7 @@ export interface operations { }; "room-join-room": { parameters: { - query?: { - /** @description Password of the room */ - password?: string; - /** @description Create a new session if necessary */ - force?: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6116,7 +6526,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Password of the room + * @default + */ + password?: string; + /** + * @description Create a new session if necessary + * @default true + */ + force?: boolean; + }; + }; + }; responses: { /** @description Room joined successfully */ 200: { @@ -6220,10 +6645,7 @@ export interface operations { }; "room-resend-invitations": { parameters: { - query?: { - /** @description ID of the attendee */ - attendeeId?: number | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6234,7 +6656,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId?: number | null; + }; + }; + }; responses: { /** @description Invitation resent successfully */ 200: { @@ -6268,10 +6700,7 @@ export interface operations { }; "room-set-session-state": { parameters: { - query: { - /** @description of the room */ - state: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6282,7 +6711,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description of the room + * @enum {integer} + */ + state: 0 | 1; + }; + }; + }; responses: { /** @description Session state set successfully */ 200: { @@ -6330,10 +6770,7 @@ export interface operations { }; "room-promote-moderator": { parameters: { - query: { - /** @description ID of the attendee */ - attendeeId: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6344,7 +6781,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId: number; + }; + }; + }; responses: { /** @description Attendee promoted to moderator successfully */ 200: { @@ -6406,10 +6853,7 @@ export interface operations { }; "room-demote-moderator": { parameters: { - query: { - /** @description ID of the attendee */ - attendeeId: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6420,7 +6864,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description ID of the attendee + */ + attendeeId: number; + }; + }; + }; responses: { /** @description Attendee demoted from moderator successfully */ 200: { @@ -6544,10 +6998,7 @@ export interface operations { }; "room-set-notification-level": { parameters: { - query: { - /** @description New level */ - level: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6558,7 +7009,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New level + */ + level: number; + }; + }; + }; responses: { /** @description Notification level updated successfully */ 200: { @@ -6592,10 +7053,7 @@ export interface operations { }; "room-set-notification-calls": { parameters: { - query: { - /** @description New level */ - level: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6606,7 +7064,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New level + */ + level: number; + }; + }; + }; responses: { /** @description Call notification level updated successfully */ 200: { @@ -6640,12 +7108,7 @@ export interface operations { }; "room-set-lobby": { parameters: { - query: { - /** @description New state */ - state: number; - /** @description Timer when the lobby will be removed */ - timer?: number | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6656,7 +7119,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New state + */ + state: number; + /** + * Format: int64 + * @description Timer when the lobby will be removed + */ + timer?: number | null; + }; + }; + }; responses: { /** @description Lobby state updated successfully */ 200: { @@ -6690,10 +7168,7 @@ export interface operations { }; "room-setsip-enabled": { parameters: { - query: { - /** @description New state */ - state: 0 | 1 | 2; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6704,7 +7179,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New state + * @enum {integer} + */ + state: 0 | 1 | 2; + }; + }; + }; responses: { /** @description SIP enabled state updated successfully */ 200: { @@ -6780,10 +7266,7 @@ export interface operations { }; "room-set-recording-consent": { parameters: { - query: { - /** @description New consent setting for the conversation (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.) */ - recordingConsent: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6794,7 +7277,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New consent setting for the conversation + * (Only {@see RecordingService::CONSENT_REQUIRED_NO} and {@see RecordingService::CONSENT_REQUIRED_YES} are allowed here.) + */ + recordingConsent: number; + }; + }; + }; responses: { /** @description Recording consent requirement set successfully */ 200: { @@ -6844,10 +7338,7 @@ export interface operations { }; "room-set-message-expiration": { parameters: { - query: { - /** @description New time */ - seconds: number; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6858,7 +7349,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New time + */ + seconds: number; + }; + }; + }; responses: { /** @description Message expiration time updated successfully */ 200: { @@ -6927,10 +7428,7 @@ export interface operations { }; "room-set-mention-permissions": { parameters: { - query: { - /** @description New mention permissions */ - mentionPermissions: 0 | 1; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6941,7 +7439,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * Format: int64 + * @description New mention permissions + * @enum {integer} + */ + mentionPermissions: 0 | 1; + }; + }; + }; responses: { /** @description Permissions updated successfully */ 200: { @@ -6975,12 +7484,7 @@ export interface operations { }; "settings-set-user-setting": { parameters: { - query: { - /** @description Key to update */ - key: "attachment_folder" | "read_status_privacy" | "typing_privacy" | "play_sounds"; - /** @description New value for the key */ - value?: (string | number) | null; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -6990,7 +7494,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description Key to update + * @enum {string} + */ + key: "attachment_folder" | "read_status_privacy" | "typing_privacy" | "play_sounds"; + /** @description New value for the key */ + value?: (string | number) | null; + }; + }; + }; responses: { /** @description User setting updated successfully */ 200: { @@ -7024,10 +7540,7 @@ export interface operations { }; "signaling-get-settings": { parameters: { - query?: { - /** @description Token of the room */ - token?: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7037,7 +7550,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description Token of the room + * @default + */ + token?: string; + }; + }; + }; responses: { /** @description Signaling settings returned */ 200: { @@ -7168,10 +7691,7 @@ export interface operations { }; "signaling-send-messages": { parameters: { - query: { - /** @description JSON encoded messages */ - messages: string; - }; + query?: never; header: { /** @description Required to be true for the API request to pass */ "OCS-APIRequest": boolean; @@ -7183,7 +7703,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description JSON encoded messages */ + messages: string; + }; + }; + }; responses: { /** @description Signaling message sent successfully */ 200: { diff --git a/vendor-bin/openapi-extractor/composer.lock b/vendor-bin/openapi-extractor/composer.lock index a36c00c7e12..6bcb467cdae 100644 --- a/vendor-bin/openapi-extractor/composer.lock +++ b/vendor-bin/openapi-extractor/composer.lock @@ -83,12 +83,12 @@ "source": { "type": "git", "url": "https://github.com/nextcloud/openapi-extractor.git", - "reference": "50acc06715d9ac182e40d31d19aa3e4de517e1da" + "reference": "944c6a64e428705eea138dcfce4e5b95b126448d" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/nextcloud/openapi-extractor/zipball/50acc06715d9ac182e40d31d19aa3e4de517e1da", - "reference": "50acc06715d9ac182e40d31d19aa3e4de517e1da", + "url": "https://api.github.com/repos/nextcloud/openapi-extractor/zipball/944c6a64e428705eea138dcfce4e5b95b126448d", + "reference": "944c6a64e428705eea138dcfce4e5b95b126448d", "shasum": "" }, "require": { @@ -99,7 +99,8 @@ "phpstan/phpdoc-parser": "^1.28" }, "require-dev": { - "nextcloud/coding-standard": "^1.2" + "nextcloud/coding-standard": "^1.2", + "nextcloud/ocp": "dev-master" }, "default-branch": true, "bin": [ @@ -130,7 +131,7 @@ "source": "https://github.com/nextcloud/openapi-extractor/tree/main", "issues": "https://github.com/nextcloud/openapi-extractor/issues" }, - "time": "2024-04-15T07:08:14+00:00" + "time": "2024-07-06T04:06:45+00:00" }, { "name": "nikic/php-parser",