diff --git a/OpenAPI.json b/OpenAPI.json index 8eda2a3..e25a50c 100644 --- a/OpenAPI.json +++ b/OpenAPI.json @@ -1053,6 +1053,129 @@ ] } }, + "/bots/{bot_id}/discover": { + "get": { + "tags": [ + "Discover" + ], + "summary": "Get Discover request status", + "description": "Fetches the status of your Discover request. If it has been approved or denied, the reason will be provided (if applicable). This endpoint is ONLY USEFUL in production on stoat.chat/app .", + "operationId": "discover_discover_get_bot_discover_get_bot", + "parameters": [ + { + "name": "bot_id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Id" + } + } + ], + "responses": { + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DiscoverRequest" + } + } + } + } + }, + "security": [ + { + "Session Token": [] + } + ] + }, + "put": { + "tags": [ + "Discover" + ], + "summary": "Add bot to Discover", + "description": "This puts your bot into the Discover request queue. This endpoint is ONLY USEFUL in production on stoat.chat/app .", + "operationId": "discover_discover_add_bot_discover_add_bot", + "parameters": [ + { + "name": "bot_id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Id" + } + } + ], + "responses": { + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "204": { + "description": "Success" + } + }, + "security": [ + { + "Session Token": [] + } + ] + }, + "delete": { + "tags": [ + "Discover" + ], + "summary": "Delete Discover request", + "description": "This cannot be used if your request is no longer in the queue (ie approved or rejected). If you wish to reapply after a rejection, submit another POST. This endpoint is ONLY USEFUL in production on stoat.chat/app .", + "operationId": "discover_discover_remove_bot_discover_remove_bot", + "parameters": [ + { + "name": "bot_id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Id" + } + } + ], + "responses": { + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "204": { + "description": "Success" + } + }, + "security": [ + { + "Session Token": [] + } + ] + } + }, "/channels/{target}/ack/{message}": { "put": { "tags": [ @@ -4101,6 +4224,129 @@ ] } }, + "/servers/{server}/discover": { + "get": { + "tags": [ + "Discover" + ], + "summary": "Get Discover request status", + "description": "Fetches the status of your Discover request. If it has been approved or denied, the reason will be provided (if applicable). This endpoint is ONLY USEFUL in production on stoat.chat/app .", + "operationId": "discover_discover_get_discover_get", + "parameters": [ + { + "name": "server", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Id" + } + } + ], + "responses": { + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DiscoverRequest" + } + } + } + } + }, + "security": [ + { + "Session Token": [] + } + ] + }, + "put": { + "tags": [ + "Discover" + ], + "summary": "Add server to Discover", + "description": "This puts your server into the Discover request queue. This endpoint is ONLY USEFUL in production on stoat.chat/app .", + "operationId": "discover_discover_add_discover_add", + "parameters": [ + { + "name": "server", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Id" + } + } + ], + "responses": { + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "204": { + "description": "Success" + } + }, + "security": [ + { + "Session Token": [] + } + ] + }, + "delete": { + "tags": [ + "Discover" + ], + "summary": "Delete Discover request", + "description": "This cannot be used if your request is no longer in the queue (ie approved or rejected). If you wish to reapply after a rejection, submit another POST. This endpoint is ONLY USEFUL in production on stoat.chat/app .", + "operationId": "discover_discover_remove_discover_remove", + "parameters": [ + { + "name": "server", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Id" + } + } + ], + "responses": { + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "204": { + "description": "Success" + } + }, + "security": [ + { + "Session Token": [] + } + ] + } + }, "/invites/{target}": { "get": { "tags": [ @@ -6799,6 +7045,24 @@ } } }, + { + "type": "object", + "required": [ + "msg", + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "ContactSupport" + ] + }, + "msg": { + "type": "string" + } + } + }, { "type": "object", "required": [ @@ -9407,6 +9671,81 @@ "InteractionsURL" ] }, + "DiscoverRequest": { + "description": "Discover request", + "type": "object", + "required": [ + "request_id", + "status", + "type" + ], + "properties": { + "type": { + "description": "The type of request.", + "allOf": [ + { + "$ref": "#/components/schemas/DiscoverRequestType" + } + ] + }, + "request_id": { + "description": "The ID of the bot/server", + "type": "string" + }, + "status": { + "description": "status of the request", + "allOf": [ + { + "$ref": "#/components/schemas/DiscoverRequestStatus" + } + ] + } + } + }, + "DiscoverRequestType": { + "type": "string", + "enum": [ + "Bot", + "Server" + ] + }, + "DiscoverRequestStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Pending", + "UnderReview" + ] + }, + { + "type": "object", + "required": [ + "Denied" + ], + "properties": { + "Denied": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + { + "type": "object", + "required": [ + "Approved" + ], + "properties": { + "Approved": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + } + ] + }, "DataEditChannel": { "description": "New webhook information", "type": "object",