Mercurial > prosody-modules

comparison mod_rest/res/openapi.yaml @ 5220:d03448560acf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Point URLs to mod_http_oauth2 in demo mode
author Kim Alvefur <zash@zash.se>
date Tue, 07 Mar 2023 14:59:45 +0100
parents 5784ff4f3b76
children 5268049915d8
comparison
equal deleted inserted replaced
5219:25e824f64fd3 5220:d03448560acf
19 tags: 19 tags:
20 - generic 20 - generic
21 security: 21 security:
22 - basic: [] 22 - basic: []
23 - token: [] 23 - token: []
24 - oauth2: []
24 requestBody: 25 requestBody:
25 $ref: '#/components/requestBodies/common' 26 $ref: '#/components/requestBodies/common'
26 responses: 27 responses:
27 '200': 28 '200':
28 $ref: '#/components/responses/success' 29 $ref: '#/components/responses/success'
35 tags: 36 tags:
36 - generic 37 - generic
37 security: 38 security:
38 - basic: [] 39 - basic: []
39 - token: [] 40 - token: []
41 - oauth2: []
40 parameters: 42 parameters:
41 - $ref: '#/components/parameters/kind' 43 - $ref: '#/components/parameters/kind'
42 - $ref: '#/components/parameters/type' 44 - $ref: '#/components/parameters/type'
43 - $ref: '#/components/parameters/to' 45 - $ref: '#/components/parameters/to'
44 requestBody: 46 requestBody:
53 tags: 55 tags:
54 - debug 56 - debug
55 security: 57 security:
56 - basic: [] 58 - basic: []
57 - token: [] 59 - token: []
60 - oauth2: []
58 requestBody: 61 requestBody:
59 $ref: '#/components/requestBodies/common' 62 $ref: '#/components/requestBodies/common'
60 responses: 63 responses:
61 '200': 64 '200':
62 $ref: '#/components/responses/success' 65 $ref: '#/components/responses/success'
67 - query 70 - query
68 summary: Ping a local or remote server or other entity 71 summary: Ping a local or remote server or other entity
69 security: 72 security:
70 - basic: [] 73 - basic: []
71 - token: [] 74 - token: []
75 - oauth2: []
72 parameters: 76 parameters:
73 - $ref: '#/components/parameters/to' 77 - $ref: '#/components/parameters/to'
74 responses: 78 responses:
75 '200': 79 '200':
76 description: Test reachability of some address 80 description: Test reachability of some address
89 - query 93 - query
90 summary: Ask what software version is used. 94 summary: Ask what software version is used.
91 security: 95 security:
92 - basic: [] 96 - basic: []
93 - token: [] 97 - token: []
98 - oauth2: []
94 parameters: 99 parameters:
95 - $ref: '#/components/parameters/to' 100 - $ref: '#/components/parameters/to'
96 responses: 101 responses:
97 '200': 102 '200':
98 description: Version query response 103 description: Version query response
110 - query 115 - query
111 summary: Query a remote entity for supported features 116 summary: Query a remote entity for supported features
112 security: 117 security:
113 - basic: [] 118 - basic: []
114 - token: [] 119 - token: []
120 - oauth2: []
115 parameters: 121 parameters:
116 - $ref: '#/components/parameters/to' 122 - $ref: '#/components/parameters/to'
117 responses: 123 responses:
118 '200': 124 '200':
119 $ref: '#/components/responses/success' 125 $ref: '#/components/responses/success'
124 - query 130 - query
125 summary: Query an entity for related services, chat rooms or other items 131 summary: Query an entity for related services, chat rooms or other items
126 security: 132 security:
127 - basic: [] 133 - basic: []
128 - token: [] 134 - token: []
135 - oauth2: []
129 parameters: 136 parameters:
130 - $ref: '#/components/parameters/to' 137 - $ref: '#/components/parameters/to'
131 responses: 138 responses:
132 '200': 139 '200':
133 $ref: '#/components/responses/success' 140 $ref: '#/components/responses/success'
138 - query 145 - query
139 summary: Query for external services (usually STUN and TURN) 146 summary: Query for external services (usually STUN and TURN)
140 security: 147 security:
141 - basic: [] 148 - basic: []
142 - token: [] 149 - token: []
150 - oauth2: []
143 parameters: 151 parameters:
144 - $ref: '#/components/parameters/to' 152 - $ref: '#/components/parameters/to'
145 - name: type 153 - name: type
146 in: query 154 in: query
147 schema: 155 schema:
158 - query 166 - query
159 summary: Query a message archive 167 summary: Query a message archive
160 security: 168 security:
161 - basic: [] 169 - basic: []
162 - token: [] 170 - token: []
171 - oauth2: []
163 parameters: 172 parameters:
164 - $ref: '#/components/parameters/to' 173 - $ref: '#/components/parameters/to'
165 - name: with 174 - name: with
166 in: query 175 in: query
167 schema: 176 schema:
209 - query 218 - query
210 summary: Query last activity of an entity. Sometimes used as "uptime" for servers. 219 summary: Query last activity of an entity. Sometimes used as "uptime" for servers.
211 security: 220 security:
212 - basic: [] 221 - basic: []
213 - token: [] 222 - token: []
223 - oauth2: []
214 parameters: 224 parameters:
215 - $ref: '#/components/parameters/to' 225 - $ref: '#/components/parameters/to'
216 responses: 226 responses:
217 '200': 227 '200':
218 $ref: '#/components/responses/success' 228 $ref: '#/components/responses/success'
223 - query 233 - query
224 summary: Query an entity for statistics 234 summary: Query an entity for statistics
225 security: 235 security:
226 - basic: [] 236 - basic: []
227 - token: [] 237 - token: []
238 - oauth2: []
228 parameters: 239 parameters:
229 - $ref: '#/components/parameters/to' 240 - $ref: '#/components/parameters/to'
230 responses: 241 responses:
231 '200': 242 '200':
232 $ref: '#/components/responses/success' 243 $ref: '#/components/responses/success'
237 - query 248 - query
238 summary: Lorem ipsum 249 summary: Lorem ipsum
239 security: 250 security:
240 - basic: [] 251 - basic: []
241 - token: [] 252 - token: []
253 - oauth2: []
242 parameters: 254 parameters:
243 - $ref: '#/components/parameters/to' 255 - $ref: '#/components/parameters/to'
244 responses: 256 responses:
245 '200': 257 '200':
246 $ref: '#/components/responses/success' 258 $ref: '#/components/responses/success'
1409 type: http 1421 type: http
1410 basic: 1422 basic:
1411 description: Use JID as username. 1423 description: Use JID as username.
1412 scheme: Basic 1424 scheme: Basic
1413 type: http 1425 type: http
1426 oauth2:
1427 description: Needs mod_http_oauth2
1428 type: oauth2
1429 flows:
1430 authorizationCode:
1431 authorizationUrl: https://example.com/oauth2/authorize
1432 tokenUrl: https://example.com/oauth2/token
1433 scopes:
1434 prosody:restricted: Restricted account
1435 prosody:user: Regular user privileges
1436 prosody:admin: Administrator privileges
1437 prosody:operator: Server operator privileges
1414 1438
1415 requestBodies: 1439 requestBodies:
1416 common: 1440 common:
1417 required: true 1441 required: true
1418 content: 1442 content: