-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
176 lines (168 loc) · 4.39 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
openapi: 3.1.0
info:
title: Black Mesa Public API v1
description: |-
This is the Black Mesa Public API. You can find out more about Black Mesa at [blackmesa.bot](https://blackmesa.bot).
version: 1.0.0
termsOfService: http://blackmesa.dev/terms/
contact:
email: [email protected]
license:
name: MIT
url: https://opensource.org/license/mit/
externalDocs:
description: Black Mesa Website
url: https://blackmesa.bot/
servers:
- url: https://blackmesa.bot/api/v1
tags:
- name: guilds
description: Guild Configuration and Information
- name: appeals
description: Manage and view appeals as a User and an Admin
paths:
/guilds:
get:
tags:
- guilds
summary: Get a list of Guilds the User is in
description: Get a list of guilds that are mutual with the bot
operationId: get_guild_list
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Guilds'
application/xml:
schema:
$ref: '#/components/schemas/Guilds'
'404':
description: No guilds found
security:
- token: []
/guild/{guild_id}:
get:
tags:
- guilds
summary: Get the Configuration for a Guild
description: Get the Configuration for a Guild
operationId: get_guild_config
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
application/xml:
schema:
$ref: '#/components/schemas/Config'
'400':
description: Invalid request
'404':
description: Guild not found
security:
- token: []
post:
tags:
- guilds
summary: New Guild Configuration
description: Set a new Guild Configuration.
operationId: new_guild_config
responses:
'201':
description: Successful operation
'400':
description: Invalid request
'404':
description: Guild not found
'409':
description: Guild already exists
security:
- token: []
patch:
tags:
- guilds
summary: Update Guild Configuration
description: |-
Update a Guild Configuration. This allows for partial updates.
Omit fields you wish not to update, to remove a field, set it to null.
operationId: update_guild_config
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
'400':
description: Invalid request
'404':
description: Guild not found
security:
- token: []
delete:
tags:
- guilds
summary: Delete Guild Configuration
description: Delete a Guild Configuration.
operationId: delete_guild_config
responses:
'204':
description: Successful operation
'400':
description: Invalid request
'404':
description: Guild not found
security:
- token: []
components:
securitySchemes:
token:
type: http
scheme: bearer
bearerFormat: JWT
name: Authorization
in: header
schemas:
Guilds:
type: object
properties:
id:
type: string
description: The ID of the guild
examples: ['832311430019022848']
icon:
type: string
description: The icon hash of the guild
examples: ['389030ec9db118cb5b85a732333b7c98']
Config:
type: object
properties:
prefix:
type: string
description: The prefix for the guild
examples: ['!']
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
examples: ['{}']
User:
type: object
properties:
groups:
type: array
items:
type: string
permissions:
type: array
items:
type: string