Mercurial > prosody-modules
annotate mod_rest/openapi.yaml @ 4476:125279f4a5b8
mod_rest: Restructure API spec
To make referencing individual fields easier, apparently some things
don't like references to individual properties of an object.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sun, 28 Feb 2021 18:55:18 +0100 |
| parents | 949db0714b5f |
| children | 8df6cc648963 |
| rev | line source |
|---|---|
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 --- |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 openapi: 3.0.1 |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 info: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 title: mod_rest API |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 description: | |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 API for sending and receiving stanzas, in a REST-ish fashion or by |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 responding to webhooks. Multiple formats supported, including native XML |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 and a simplified JSON mapping. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 version: 0.1.0 |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 license: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 name: MIT |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 paths: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 /rest: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 post: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 requestBody: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 required: true |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 content: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 application/x-www-form-urlencoded: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 schema: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 description: A subset of the JSON schema, only top level string fields. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 application/xmpp+xml: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 schema: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 description: Single XMPP stanza in XML format. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 application/json: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 schema: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 $ref: '#/components/schemas/stanza' |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 security: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
28 - basic: [] |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
29 - token: [] |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
30 summary: Send stanzas and receive responses. Webhooks work the same way. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
31 responses: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
32 200: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
33 content: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
34 text/plain: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 schema: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 description: Plain text response used as message body. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
37 example: Hello |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
38 type: string |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
39 application/x-www-form-urlencoded: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
40 schema: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
41 description: A subset of the JSON schema, only top level string fields. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
42 example: body=Hello |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
43 application/xmpp+xml: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
44 schema: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
45 description: Single XMPP stanza in XML format. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
46 example: <message><body>Hello</body></message> |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
47 application/json: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
48 schema: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
49 $ref: '#/components/schemas/stanza' |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
50 description: The stanza was sent and returned a response. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
51 401: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
52 description: No credentials or auth token were provided. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
53 202: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
54 description: The stanza was sent without problem, and without response, |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
55 so an empty reply. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
56 403: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
57 description: Provided credentials or token not accepted. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
58 400: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
59 description: There was a syntax problem in the payload. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
60 422: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
61 description: The was a problem with the format (but not the syntax) of the |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
62 payload. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
63 415: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
64 description: Unsupported mediatype. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
65 components: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
66 schemas: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
67 stanza: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
68 properties: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
69 delay: |
| 4476 | 70 $ref: '#/components/schemas/delay' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
71 state: |
| 4476 | 72 $ref: '#/components/schemas/state' |
| 73 type: | |
| 74 $ref: '#/components/schemas/type' | |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
75 status: |
| 4476 | 76 $ref: '#/components/schemas/status' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
77 id: |
| 4476 | 78 $ref: '#/components/schemas/id' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
79 replace: |
| 4476 | 80 $ref: '#/components/schemas/replace' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
81 from: |
| 4476 | 82 $ref: '#/components/schemas/from' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
83 body: |
| 4476 | 84 $ref: '#/components/schemas/body' |
| 85 kind: | |
| 86 $ref: '#/components/schemas/kind' | |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
87 show: |
| 4476 | 88 $ref: '#/components/schemas/show' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
89 stats: |
| 4476 | 90 $ref: '#/components/schemas/stats' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
91 priority: |
| 4476 | 92 $ref: '#/components/schemas/priority' |
| 93 nick: | |
| 94 $ref: '#/components/schemas/nick' | |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
95 to: |
| 4476 | 96 $ref: '#/components/schemas/to' |
| 97 ping: | |
| 98 $ref: '#/components/schemas/ping' | |
| 99 subject: | |
| 100 $ref: '#/components/schemas/subject' | |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
101 lang: |
| 4476 | 102 $ref: '#/components/schemas/lang' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
103 join: |
| 4476 | 104 $ref: '#/components/schemas/join' |
| 105 html: | |
| 106 $ref: '#/components/schemas/html' | |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
107 dataform: |
| 4476 | 108 $ref: '#/components/schemas/dataform' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
109 version: |
| 4476 | 110 $ref: '#/components/schemas/version' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
111 payload: |
| 4476 | 112 $ref: '#/components/schemas/payload' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
113 disco: |
| 4476 | 114 $ref: '#/components/schemas/disco' |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
115 oob_url: |
| 4476 | 116 $ref: '#/components/schemas/oob_url' |
| 117 items: | |
| 118 $ref: '#/components/schemas/items' | |
| 119 formdata: | |
| 120 $ref: '#/components/schemas/formdata' | |
| 121 thread: | |
| 122 $ref: '#/components/schemas/thread' | |
| 123 command: | |
| 124 $ref: '#/components/schemas/command' | |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
125 type: object |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
126 example: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
127 body: Hello |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
128 type: chat |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
129 kind: message |
| 4476 | 130 to: alice@example.com |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
131 state: active |
| 4476 | 132 delay: |
| 133 type: string | |
| 134 description: Timestamp of when a stanza was delayed, in ISO 8601 / XEP-0082 | |
| 135 format. | |
| 136 state: | |
| 137 enum: | |
| 138 - active | |
| 139 - inactive | |
| 140 - gone | |
| 141 - composing | |
| 142 - paused | |
| 143 description: Chat state notifications, e.g. "is typing..." | |
| 144 type: string | |
| 145 example: composing | |
| 146 thread: | |
| 147 type: string | |
| 148 description: Message thread identifier | |
| 149 status: | |
| 150 type: string | |
| 151 description: Textual status message. | |
| 152 id: | |
| 153 type: string | |
| 154 description: Reasonably unique id. mod_rest generates one if left out. | |
| 155 replace: | |
| 156 type: string | |
| 157 description: ID of message being replaced (e.g. for corrections) | |
| 158 from: | |
| 159 description: the sender | |
| 160 type: string | |
| 161 example: bob@localhost.example | |
| 162 body: | |
| 163 description: Human-readable chat message | |
| 164 type: string | |
| 165 example: Hello, World! | |
| 166 command: | |
| 167 oneOf: | |
| 168 - type: string | |
| 169 - type: object | |
| 170 properties: | |
| 171 data: | |
| 172 $ref: '#/components/schemas/stanza/properties/formdata' | |
| 173 action: | |
| 174 type: string | |
| 175 note: | |
| 176 type: object | |
| 177 properties: | |
| 178 text: | |
| 179 type: string | |
| 180 type: | |
| 181 type: string | |
| 182 enum: | |
| 183 - info | |
| 184 - warn | |
| 185 - error | |
| 186 form: | |
| 187 $ref: '#/components/schemas/stanza/properties/dataform' | |
| 188 sessionid: | |
| 189 type: string | |
| 190 status: | |
| 191 type: string | |
| 192 node: | |
| 193 type: string | |
| 194 actions: | |
| 195 type: object | |
| 196 properties: | |
| 197 complete: | |
| 198 type: boolean | |
| 199 prev: | |
| 200 type: boolean | |
| 201 next: | |
| 202 type: boolean | |
| 203 execute: | |
| 204 type: string | |
| 205 description: Ad-hoc commands. | |
| 206 show: | |
| 207 description: indicator of availability, ie away or not | |
| 208 type: string | |
| 209 enum: | |
| 210 - away | |
| 211 - chat | |
| 212 - dnd | |
| 213 - xa | |
| 214 stats: | |
| 215 description: Statistics | |
| 216 type: array | |
| 217 items: | |
| 218 type: object | |
| 219 properties: | |
| 220 name: | |
| 221 type: string | |
| 222 unit: | |
| 223 type: string | |
| 224 value: | |
| 225 type: string | |
| 226 priority: | |
| 227 type: string | |
| 228 description: presence priority | |
| 229 kind: | |
| 230 description: Which kind of stanza | |
| 231 type: string | |
| 232 enum: | |
| 233 - message | |
| 234 - presence | |
| 235 - iq | |
| 236 to: | |
| 237 description: recipient | |
| 238 type: string | |
| 239 example: alice@example.com | |
| 240 type: | |
| 241 description: Stanza type | |
| 242 type: string | |
| 243 enum: | |
| 244 - chat | |
| 245 - normal | |
| 246 - headline | |
| 247 - groupchat | |
| 248 - get | |
| 249 - set | |
| 250 - result | |
| 251 - available | |
| 252 - unavailable | |
| 253 - subscribe | |
| 254 - subscribed | |
| 255 - unsubscribe | |
| 256 - unsubscribed | |
| 257 lang: | |
| 258 description: Language code | |
| 259 type: string | |
| 260 example: en | |
| 261 formdata: | |
| 262 additionalProperties: | |
| 263 oneOf: | |
| 264 - type: string | |
| 265 - type: array | |
| 266 items: | |
| 267 type: string | |
| 268 type: object | |
| 269 description: Simplified data form | |
| 270 join: | |
| 271 description: For joining Multi-User-Chats | |
| 272 type: boolean | |
| 273 enum: | |
| 274 - true | |
| 275 dataform: | |
| 276 properties: | |
| 277 title: | |
| 278 type: string | |
| 279 fields: | |
| 280 type: array | |
| 281 items: | |
| 282 type: object | |
| 283 properties: | |
| 284 value: | |
| 285 oneOf: | |
| 286 - type: string | |
| 287 - type: array | |
| 288 items: | |
| 289 type: string | |
| 290 type: | |
| 291 type: string | |
| 292 label: | |
| 293 type: string | |
| 294 desc: | |
| 295 type: string | |
| 296 required: | |
| 297 type: boolean | |
| 298 var: | |
| 299 type: string | |
| 300 type: | |
| 301 type: string | |
| 302 enum: | |
| 303 - form | |
| 304 - submit | |
| 305 - cancel | |
| 306 - result | |
| 307 instructions: | |
| 308 type: string | |
| 309 description: Data form | |
| 310 type: object | |
| 311 items: | |
| 312 oneOf: | |
| 313 - description: An items query or empty list | |
| 314 type: boolean | |
| 315 enum: | |
| 316 - true | |
| 317 - type: string | |
| 318 description: A query with a node, or an empty reply list with a node | |
| 319 - description: List of items referenced | |
| 320 type: array | |
| 321 items: | |
| 322 properties: | |
| 323 jid: | |
| 324 type: string | |
| 325 description: Address of item | |
| 326 node: | |
| 327 type: string | |
| 328 name: | |
| 329 type: string | |
| 330 description: Descriptive name | |
| 331 required: | |
| 332 - jid | |
| 333 type: object | |
| 334 description: List of references to other entities | |
| 335 version: | |
| 336 oneOf: | |
| 337 - type: boolean | |
| 338 - properties: | |
| 339 version: | |
| 340 type: string | |
| 341 name: | |
| 342 type: string | |
| 343 os: | |
| 344 type: string | |
| 345 required: | |
| 346 - name | |
| 347 - version | |
| 348 type: object | |
| 349 description: Software version query | |
| 350 payload: | |
| 351 required: | |
| 352 - datatype | |
| 353 - data | |
| 354 properties: | |
| 355 data: | |
| 356 type: object | |
| 357 datatype: | |
| 358 type: string | |
| 359 description: A piece of arbitrary JSON with a type field attached | |
| 360 type: object | |
| 361 disco: | |
| 362 oneOf: | |
| 363 - type: boolean | |
| 364 description: Either a query, or an empty response | |
| 365 - type: string | |
| 366 description: A query with a node, or an empty response with a node | |
| 367 - properties: | |
| 368 features: | |
| 369 description: List of URIs indicating supported features | |
| 370 type: array | |
| 371 items: | |
| 372 type: string | |
| 373 identities: | |
| 374 items: | |
| 375 type: object | |
| 376 properties: | |
| 377 name: | |
| 378 type: string | |
| 379 type: | |
| 380 type: string | |
| 381 category: | |
| 382 type: string | |
| 383 description: List of abstract identities or types that describe the | |
| 384 entity | |
| 385 type: array | |
| 386 example: | |
| 387 - name: Prosody | |
| 388 type: im | |
| 389 category: server | |
| 390 node: | |
| 391 type: string | |
| 392 extensions: | |
| 393 type: object | |
| 394 description: A full response | |
| 395 type: object | |
| 396 description: Discover supported features | |
| 397 oob_url: | |
| 398 type: string | |
| 399 description: URL of an attached media file. | |
| 400 html: | |
| 401 description: HTML version of 'body' | |
| 402 type: string | |
| 403 example: <body><p>Hello!</p></body> | |
| 404 subject: | |
| 405 description: Subject of message or group chat | |
| 406 type: string | |
| 407 example: Talking about stuff | |
| 408 ping: | |
| 409 description: A ping. | |
| 410 type: boolean | |
| 411 enum: | |
| 412 - true | |
| 413 nick: | |
| 414 type: string | |
| 415 description: Nickname of the sender | |
|
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
416 securitySchemes: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
417 token: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
418 description: Tokens from mod_http_oauth2. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
419 scheme: Bearer |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
420 type: http |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
421 basic: |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
422 description: Use JID as username. |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
423 scheme: Basic |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
424 type: http |
|
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
425 ... |