Skip to content

Commit cb2a7ef

Browse files
committed
chore: generate OpenAPI specification
1 parent ee1d256 commit cb2a7ef

1 file changed

Lines changed: 339 additions & 0 deletions

File tree

‎OpenAPI.json‎

Lines changed: 339 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,6 +1053,129 @@
10531053
]
10541054
}
10551055
},
1056+
"/bots/{bot_id}/discover": {
1057+
"get": {
1058+
"tags": [
1059+
"Discover"
1060+
],
1061+
"summary": "Get Discover request status",
1062+
"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 .",
1063+
"operationId": "discover_discover_get_bot_discover_get_bot",
1064+
"parameters": [
1065+
{
1066+
"name": "bot_id",
1067+
"in": "path",
1068+
"required": true,
1069+
"schema": {
1070+
"$ref": "#/components/schemas/Id"
1071+
}
1072+
}
1073+
],
1074+
"responses": {
1075+
"default": {
1076+
"description": "An error occurred.",
1077+
"content": {
1078+
"application/json": {
1079+
"schema": {
1080+
"$ref": "#/components/schemas/Error"
1081+
}
1082+
}
1083+
}
1084+
},
1085+
"200": {
1086+
"description": "",
1087+
"content": {
1088+
"application/json": {
1089+
"schema": {
1090+
"$ref": "#/components/schemas/DiscoverRequest"
1091+
}
1092+
}
1093+
}
1094+
}
1095+
},
1096+
"security": [
1097+
{
1098+
"Session Token": []
1099+
}
1100+
]
1101+
},
1102+
"put": {
1103+
"tags": [
1104+
"Discover"
1105+
],
1106+
"summary": "Add bot to Discover",
1107+
"description": "This puts your bot into the Discover request queue. This endpoint is ONLY USEFUL in production on stoat.chat/app .",
1108+
"operationId": "discover_discover_add_bot_discover_add_bot",
1109+
"parameters": [
1110+
{
1111+
"name": "bot_id",
1112+
"in": "path",
1113+
"required": true,
1114+
"schema": {
1115+
"$ref": "#/components/schemas/Id"
1116+
}
1117+
}
1118+
],
1119+
"responses": {
1120+
"default": {
1121+
"description": "An error occurred.",
1122+
"content": {
1123+
"application/json": {
1124+
"schema": {
1125+
"$ref": "#/components/schemas/Error"
1126+
}
1127+
}
1128+
}
1129+
},
1130+
"204": {
1131+
"description": "Success"
1132+
}
1133+
},
1134+
"security": [
1135+
{
1136+
"Session Token": []
1137+
}
1138+
]
1139+
},
1140+
"delete": {
1141+
"tags": [
1142+
"Discover"
1143+
],
1144+
"summary": "Delete Discover request",
1145+
"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 .",
1146+
"operationId": "discover_discover_remove_bot_discover_remove_bot",
1147+
"parameters": [
1148+
{
1149+
"name": "bot_id",
1150+
"in": "path",
1151+
"required": true,
1152+
"schema": {
1153+
"$ref": "#/components/schemas/Id"
1154+
}
1155+
}
1156+
],
1157+
"responses": {
1158+
"default": {
1159+
"description": "An error occurred.",
1160+
"content": {
1161+
"application/json": {
1162+
"schema": {
1163+
"$ref": "#/components/schemas/Error"
1164+
}
1165+
}
1166+
}
1167+
},
1168+
"204": {
1169+
"description": "Success"
1170+
}
1171+
},
1172+
"security": [
1173+
{
1174+
"Session Token": []
1175+
}
1176+
]
1177+
}
1178+
},
10561179
"/channels/{target}/ack/{message}": {
10571180
"put": {
10581181
"tags": [
@@ -4101,6 +4224,129 @@
41014224
]
41024225
}
41034226
},
4227+
"/servers/{server}/discover": {
4228+
"get": {
4229+
"tags": [
4230+
"Discover"
4231+
],
4232+
"summary": "Get Discover request status",
4233+
"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 .",
4234+
"operationId": "discover_discover_get_discover_get",
4235+
"parameters": [
4236+
{
4237+
"name": "server",
4238+
"in": "path",
4239+
"required": true,
4240+
"schema": {
4241+
"$ref": "#/components/schemas/Id"
4242+
}
4243+
}
4244+
],
4245+
"responses": {
4246+
"default": {
4247+
"description": "An error occurred.",
4248+
"content": {
4249+
"application/json": {
4250+
"schema": {
4251+
"$ref": "#/components/schemas/Error"
4252+
}
4253+
}
4254+
}
4255+
},
4256+
"200": {
4257+
"description": "",
4258+
"content": {
4259+
"application/json": {
4260+
"schema": {
4261+
"$ref": "#/components/schemas/DiscoverRequest"
4262+
}
4263+
}
4264+
}
4265+
}
4266+
},
4267+
"security": [
4268+
{
4269+
"Session Token": []
4270+
}
4271+
]
4272+
},
4273+
"put": {
4274+
"tags": [
4275+
"Discover"
4276+
],
4277+
"summary": "Add server to Discover",
4278+
"description": "This puts your server into the Discover request queue. This endpoint is ONLY USEFUL in production on stoat.chat/app .",
4279+
"operationId": "discover_discover_add_discover_add",
4280+
"parameters": [
4281+
{
4282+
"name": "server",
4283+
"in": "path",
4284+
"required": true,
4285+
"schema": {
4286+
"$ref": "#/components/schemas/Id"
4287+
}
4288+
}
4289+
],
4290+
"responses": {
4291+
"default": {
4292+
"description": "An error occurred.",
4293+
"content": {
4294+
"application/json": {
4295+
"schema": {
4296+
"$ref": "#/components/schemas/Error"
4297+
}
4298+
}
4299+
}
4300+
},
4301+
"204": {
4302+
"description": "Success"
4303+
}
4304+
},
4305+
"security": [
4306+
{
4307+
"Session Token": []
4308+
}
4309+
]
4310+
},
4311+
"delete": {
4312+
"tags": [
4313+
"Discover"
4314+
],
4315+
"summary": "Delete Discover request",
4316+
"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 .",
4317+
"operationId": "discover_discover_remove_discover_remove",
4318+
"parameters": [
4319+
{
4320+
"name": "server",
4321+
"in": "path",
4322+
"required": true,
4323+
"schema": {
4324+
"$ref": "#/components/schemas/Id"
4325+
}
4326+
}
4327+
],
4328+
"responses": {
4329+
"default": {
4330+
"description": "An error occurred.",
4331+
"content": {
4332+
"application/json": {
4333+
"schema": {
4334+
"$ref": "#/components/schemas/Error"
4335+
}
4336+
}
4337+
}
4338+
},
4339+
"204": {
4340+
"description": "Success"
4341+
}
4342+
},
4343+
"security": [
4344+
{
4345+
"Session Token": []
4346+
}
4347+
]
4348+
}
4349+
},
41044350
"/invites/{target}": {
41054351
"get": {
41064352
"tags": [
@@ -6799,6 +7045,24 @@
67997045
}
68007046
}
68017047
},
7048+
{
7049+
"type": "object",
7050+
"required": [
7051+
"msg",
7052+
"type"
7053+
],
7054+
"properties": {
7055+
"type": {
7056+
"type": "string",
7057+
"enum": [
7058+
"ContactSupport"
7059+
]
7060+
},
7061+
"msg": {
7062+
"type": "string"
7063+
}
7064+
}
7065+
},
68027066
{
68037067
"type": "object",
68047068
"required": [
@@ -9407,6 +9671,81 @@
94079671
"InteractionsURL"
94089672
]
94099673
},
9674+
"DiscoverRequest": {
9675+
"description": "Discover request",
9676+
"type": "object",
9677+
"required": [
9678+
"request_id",
9679+
"status",
9680+
"type"
9681+
],
9682+
"properties": {
9683+
"type": {
9684+
"description": "The type of request.",
9685+
"allOf": [
9686+
{
9687+
"$ref": "#/components/schemas/DiscoverRequestType"
9688+
}
9689+
]
9690+
},
9691+
"request_id": {
9692+
"description": "The ID of the bot/server",
9693+
"type": "string"
9694+
},
9695+
"status": {
9696+
"description": "status of the request",
9697+
"allOf": [
9698+
{
9699+
"$ref": "#/components/schemas/DiscoverRequestStatus"
9700+
}
9701+
]
9702+
}
9703+
}
9704+
},
9705+
"DiscoverRequestType": {
9706+
"type": "string",
9707+
"enum": [
9708+
"Bot",
9709+
"Server"
9710+
]
9711+
},
9712+
"DiscoverRequestStatus": {
9713+
"oneOf": [
9714+
{
9715+
"type": "string",
9716+
"enum": [
9717+
"Pending",
9718+
"UnderReview"
9719+
]
9720+
},
9721+
{
9722+
"type": "object",
9723+
"required": [
9724+
"Denied"
9725+
],
9726+
"properties": {
9727+
"Denied": {
9728+
"type": "string",
9729+
"nullable": true
9730+
}
9731+
},
9732+
"additionalProperties": false
9733+
},
9734+
{
9735+
"type": "object",
9736+
"required": [
9737+
"Approved"
9738+
],
9739+
"properties": {
9740+
"Approved": {
9741+
"type": "string",
9742+
"nullable": true
9743+
}
9744+
},
9745+
"additionalProperties": false
9746+
}
9747+
]
9748+
},
94109749
"DataEditChannel": {
94119750
"description": "New webhook information",
94129751
"type": "object",

0 commit comments

Comments
 (0)