Software /
code /
prosody-modules
Annotate
mod_rest/openapi.yaml @ 4519:ea1fd703bb27
mod_rest: Convert XEP-0039 to datamapping
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 22 Mar 2021 00:21:27 +0100 |
parent | 4497:4c262e5a02b5 |
child | 4527:9a6aaba3d5ef |
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 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
3 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 info: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 title: mod_rest API |
4497
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
6 version: 0.3.2 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 description: | |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 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
|
9 responding to webhooks. Multiple formats supported, including native XML |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 and a simplified JSON mapping. |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 license: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 name: MIT |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
13 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 paths: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
15 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 /rest: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 post: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
18 summary: Send stanzas and receive responses. Webhooks work the same way. |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
19 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
20 - generic |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 security: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 - basic: [] |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 - token: [] |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
24 requestBody: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
25 $ref: '#/components/requestBodies/common' |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 responses: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 200: |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
28 $ref: '#/components/responses/success' |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
29 202: |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
30 $ref: '#/components/responses/sent' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
31 |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
32 /rest/{kind}/{type}/{to}: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
33 post: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
34 summary: Even more RESTful mapping with certain components in the path. |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
35 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
36 - generic |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
37 security: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
38 - basic: [] |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
39 - token: [] |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
40 parameters: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
41 - $ref: '#/components/parameters/kind' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
42 - $ref: '#/components/parameters/type' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
43 - $ref: '#/components/parameters/to' |
4496
8e9bff3cde4f
mod_rest/openapi: Add missing body for POST /kind/type/to query
Kim Alvefur <zash@zash.se>
parents:
4495
diff
changeset
|
44 requestBody: |
8e9bff3cde4f
mod_rest/openapi: Add missing body for POST /kind/type/to query
Kim Alvefur <zash@zash.se>
parents:
4495
diff
changeset
|
45 $ref: '#/components/requestBodies/common' |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
46 responses: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
47 200: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
48 $ref: '#/components/responses/success' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
49 |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
50 /rest/ping/{to}: |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
51 get: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
52 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
53 - query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
54 summary: Ping a local or remote server or other entity |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
55 security: |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
56 - basic: [] |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
57 - token: [] |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
58 parameters: |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
59 - $ref: '#/components/parameters/to' |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
60 responses: |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
61 200: |
4495
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
62 description: Test reachability of some address |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
63 content: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
64 application/json: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
65 schema: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
66 $ref: '#/components/schemas/iq_pong' |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
67 application/xmpp+xml: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
68 schema: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
69 $ref: '#/components/schemas/iq_pong' |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
70 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
71 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
72 /rest/version/{to}: |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
73 get: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
74 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
75 - query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
76 summary: Ask what software version is used. |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
77 security: |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
78 - basic: [] |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
79 - token: [] |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
80 parameters: |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
81 - $ref: '#/components/parameters/to' |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
82 responses: |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
83 200: |
4493
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
84 description: Version query response |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
85 content: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
86 application/json: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
87 schema: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
88 $ref: '#/components/schemas/iq_result_version' |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
89 application/xmpp+xml: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
90 schema: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
91 $ref: '#/components/schemas/iq_result_version' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
92 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
93 /rest/disco/{to}: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
94 get: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
95 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
96 - query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
97 summary: Query a remote entity for supported features |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
98 security: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
99 - basic: [] |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
100 - token: [] |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
101 parameters: |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
102 - $ref: '#/components/parameters/to' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
103 responses: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
104 200: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
105 $ref: '#/components/responses/success' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
106 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
107 /rest/items/{to}: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
108 get: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
109 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
110 - query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
111 summary: Query an entity for related services, chat rooms or other items |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
112 security: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
113 - basic: [] |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
114 - token: [] |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
115 parameters: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
116 - $ref: '#/components/parameters/to' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
117 responses: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
118 200: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
119 $ref: '#/components/responses/success' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
120 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
121 components: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
122 schemas: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
123 stanza: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
124 type: object |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
125 example: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
126 body: Hello |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
127 type: chat |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
128 kind: message |
4476 | 129 to: alice@example.com |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
130 state: active |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
131 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
132 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
133 kind: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
134 $ref: '#/components/schemas/kind' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
135 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
136 $ref: '#/components/schemas/type' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
137 to: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
138 $ref: '#/components/schemas/to' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
139 from: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
140 $ref: '#/components/schemas/from' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
141 id: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
142 $ref: '#/components/schemas/id' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
143 lang: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
144 $ref: '#/components/schemas/lang' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
145 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
146 body: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
147 $ref: '#/components/schemas/body' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
148 subject: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
149 $ref: '#/components/schemas/subject' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
150 thread: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
151 $ref: '#/components/schemas/thread' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
152 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
153 show: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
154 $ref: '#/components/schemas/show' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
155 status: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
156 $ref: '#/components/schemas/status' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
157 priority: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
158 $ref: '#/components/schemas/priority' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
159 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
160 state: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
161 $ref: '#/components/schemas/state' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
162 nick: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
163 $ref: '#/components/schemas/nick' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
164 delay: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
165 $ref: '#/components/schemas/delay' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
166 replace: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
167 $ref: '#/components/schemas/replace' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
168 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
169 join: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
170 $ref: '#/components/schemas/join' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
171 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
172 html: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
173 $ref: '#/components/schemas/html' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
174 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
175 ping: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
176 $ref: '#/components/schemas/ping' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
177 version: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
178 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
179 - $ref: '#/components/schemas/version' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
180 - type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
181 disco: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
182 $ref: '#/components/schemas/disco' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
183 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
184 $ref: '#/components/schemas/items' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
185 command: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
186 $ref: '#/components/schemas/command' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
187 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
188 oob_url: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
189 $ref: '#/components/schemas/oob_url' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
190 payload: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
191 $ref: '#/components/schemas/payload' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
192 dataform: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
193 $ref: '#/components/schemas/dataform' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
194 formdata: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
195 $ref: '#/components/schemas/formdata' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
196 stats: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
197 $ref: '#/components/schemas/stats' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
198 error: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
199 $ref: '#/components/schemas/error' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
200 |
4495
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
201 iq_pong: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
202 description: Test reachability of some XMPP address |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
203 type: object |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
204 xml: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
205 name: iq |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
206 properties: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
207 type: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
208 type: string |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
209 enum: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
210 - result |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
211 xml: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
212 attribute: true |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
213 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
214 iq_result_version: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
215 description: Version query response |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
216 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
217 xml: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
218 name: iq |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
219 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
220 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
221 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
222 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
223 - result |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
224 xml: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
225 attribute: true |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
226 version: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
227 $ref: '#/components/schemas/version' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
228 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
229 kind: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
230 description: Which kind of stanza |
4476 | 231 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
232 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
233 - message |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
234 - presence |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
235 - iq |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
236 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
237 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
238 description: Stanza type |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
239 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
240 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
241 - chat |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
242 - normal |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
243 - headline |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
244 - groupchat |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
245 - get |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
246 - set |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
247 - result |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
248 - available |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
249 - unavailable |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
250 - subscribe |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
251 - subscribed |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
252 - unsubscribe |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
253 - unsubscribed |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
254 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
255 to: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
256 description: recipient |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
257 example: alice@example.com |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
258 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
259 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
260 from: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
261 description: the sender |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
262 example: bob@localhost.example |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
263 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
264 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
265 id: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
266 description: Reasonably unique id. mod_rest generates one if left out. |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
267 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
268 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
269 lang: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
270 description: Language code |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
271 example: en |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
272 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
273 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
274 body: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
275 description: Human-readable chat message |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
276 example: Hello, World! |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
277 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
278 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
279 subject: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
280 description: Subject of message or group chat |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
281 example: Talking about stuff |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
282 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
283 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
284 thread: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
285 description: Message thread identifier |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
286 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
287 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
288 show: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
289 description: indicator of availability, ie away or not |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
290 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
291 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
292 - away |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
293 - chat |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
294 - dnd |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
295 - xa |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
296 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
297 status: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
298 description: Textual status message. |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
299 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
300 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
301 priority: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
302 description: Presence priority |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
303 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
304 |
4476 | 305 state: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
306 description: Chat state notifications, e.g. "is typing..." |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
307 type: string |
4476 | 308 enum: |
309 - active | |
310 - inactive | |
311 - gone | |
312 - composing | |
313 - paused | |
314 example: composing | |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
315 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
316 nick: |
4476 | 317 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
318 description: Nickname of the sender |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
319 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
320 delay: |
4476 | 321 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
322 description: Timestamp of when a stanza was delayed, in ISO 8601 / XEP-0082 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
323 format. |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
324 |
4476 | 325 replace: |
326 type: string | |
327 description: ID of message being replaced (e.g. for corrections) | |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
328 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
329 join: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
330 description: For joining Multi-User-Chats |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
331 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
332 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
333 - true |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
334 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
335 html: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
336 description: HTML version of 'body' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
337 example: <body><p>Hello!</p></body> |
4476 | 338 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
339 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
340 ping: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
341 description: A ping. |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
342 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
343 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
344 - true |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
345 xml: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
346 name: ping |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
347 namespace: urn:xmpp:ping |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
348 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
349 version: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
350 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
351 description: Software version query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
352 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
353 name: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
354 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
355 example: My Software |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
356 version: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
357 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
358 example: 1.0.0 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
359 os: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
360 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
361 example: Linux |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
362 required: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
363 - name |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
364 - version |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
365 xml: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
366 name: query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
367 namespace: jabber:iq:version |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
368 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
369 disco: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
370 description: Discover supported features |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
371 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
372 - description: A full response |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
373 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
374 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
375 features: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
376 description: List of URIs indicating supported features |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
377 type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
378 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
379 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
380 identities: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
381 description: List of abstract identities or types that describe the |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
382 entity |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
383 type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
384 example: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
385 - name: Prosody |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
386 type: im |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
387 category: server |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
388 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
389 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
390 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
391 name: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
392 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
393 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
394 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
395 category: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
396 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
397 node: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
398 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
399 extensions: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
400 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
401 - description: A query with a node, or an empty response with a node |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
402 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
403 - description: Either a query, or an empty response |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
404 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
405 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
406 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
407 description: List of references to other entities |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
408 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
409 - description: List of items referenced |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
410 type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
411 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
412 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
413 jid: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
414 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
415 description: Address of item |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
416 node: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
417 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
418 name: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
419 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
420 description: Descriptive name |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
421 required: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
422 - jid |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
423 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
424 - type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
425 description: A query with a node, or an empty reply list with a node |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
426 - description: An items query or empty list |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
427 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
428 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
429 - true |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
430 |
4476 | 431 command: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
432 description: Ad-hoc commands. |
4476 | 433 oneOf: |
434 - type: object | |
435 properties: | |
436 data: | |
4486
4f41678ba00d
mod_rest/openapi: Fix dataform references
Kim Alvefur <zash@zash.se>
parents:
4479
diff
changeset
|
437 $ref: '#/components/schemas/formdata' |
4476 | 438 action: |
439 type: string | |
440 note: | |
441 type: object | |
442 properties: | |
443 text: | |
444 type: string | |
445 type: | |
446 type: string | |
447 enum: | |
448 - info | |
449 - warn | |
450 - error | |
451 form: | |
4486
4f41678ba00d
mod_rest/openapi: Fix dataform references
Kim Alvefur <zash@zash.se>
parents:
4479
diff
changeset
|
452 $ref: '#/components/schemas/dataform' |
4476 | 453 sessionid: |
454 type: string | |
455 status: | |
456 type: string | |
457 node: | |
458 type: string | |
459 actions: | |
460 type: object | |
461 properties: | |
462 complete: | |
463 type: boolean | |
464 prev: | |
465 type: boolean | |
466 next: | |
467 type: boolean | |
468 execute: | |
469 type: string | |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
470 - type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
471 description: Call a command by 'node' id, without arguments |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
472 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
473 oob_url: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
474 description: URL of an attached media file. |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
475 example: https://media.example.net/thisfile.jpg |
4476 | 476 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
477 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
478 payload: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
479 description: A piece of arbitrary JSON with a type field attached |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
480 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
481 required: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
482 - datatype |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
483 - data |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
484 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
485 data: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
486 example: '{"some":"json"}' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
487 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
488 datatype: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
489 example: urn:example:my-json#payload |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
490 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
491 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
492 dataform: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
493 description: Data form |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
494 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
495 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
496 title: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
497 description: Title of the form |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
498 example: TPS Report |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
499 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
500 fields: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
501 type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
502 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
503 description: Form field |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
504 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
505 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
506 value: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
507 description: Field value |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
508 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
509 - type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
510 - type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
511 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
512 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
513 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
514 description: Type of form field |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
515 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
516 label: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
517 description: Descriptive label for the field |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
518 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
519 desc: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
520 description: Longer description, i.e. that would go in a tooltip |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
521 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
522 required: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
523 description: Whether the field must be included in the form |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
524 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
525 var: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
526 description: Internal name of the field |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
527 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
528 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
529 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
530 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
531 - form |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
532 - submit |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
533 - cancel |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
534 - result |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
535 instructions: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
536 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
537 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
538 formdata: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
539 description: Simplified data form carrying only values |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
540 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
541 additionalProperties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
542 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
543 - type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
544 - type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
545 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
546 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
547 |
4476 | 548 stats: |
549 description: Statistics | |
550 type: array | |
551 items: | |
552 type: object | |
553 properties: | |
554 name: | |
555 type: string | |
556 unit: | |
557 type: string | |
558 value: | |
559 type: string | |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
560 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
561 error: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
562 description: Description of something gone wrong. See the Stanza Errors section in RFC 6120. |
4476 | 563 type: object |
4479
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
564 properties: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
565 type: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
566 description: General category of error |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
567 type: string |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
568 enum: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
569 - auth |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
570 - cancel |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
571 - continue |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
572 - modify |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
573 - wait |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
574 condition: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
575 description: Specific error condition. |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
576 type: string |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
577 # enum: [ full list available in RFC 6120 ] |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
578 code: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
579 description: Legacy numeric error code. Similar to HTTP status codes. |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
580 type: integer |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
581 text: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
582 description: Description of error intended for human eyes. |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
583 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
584 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
585 securitySchemes: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
586 token: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
587 description: Tokens from mod_http_oauth2. |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
588 scheme: Bearer |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
589 type: http |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
590 basic: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
591 description: Use JID as username. |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
592 scheme: Basic |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
593 type: http |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
594 |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
595 requestBodies: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
596 common: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
597 required: true |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
598 content: |
4497
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
599 application/json: |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
600 schema: |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
601 $ref: '#/components/schemas/stanza' |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
602 application/xmpp+xml: |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
603 schema: |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
604 description: Single XMPP stanza in XML format. |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
605 application/x-www-form-urlencoded: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
606 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
607 description: A subset of the JSON schema, only top level string fields. |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
608 |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
609 responses: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
610 success: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
611 description: The stanza was sent and returned a response. |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
612 content: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
613 application/json: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
614 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
615 $ref: '#/components/schemas/stanza' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
616 application/xmpp+xml: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
617 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
618 description: Single XMPP stanza in XML format. |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
619 example: <message><body>Hello</body></message> |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
620 application/x-www-form-urlencoded: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
621 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
622 description: A subset of the JSON schema, only top level string fields. |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
623 example: body=Hello |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
624 text/plain: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
625 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
626 description: Plain text response used as message body. |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
627 example: Hello |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
628 type: string |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
629 sent: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
630 description: The stanza was sent without problem, and without response, |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
631 so an empty reply. |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
632 |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
633 parameters: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
634 to: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
635 name: to |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
636 in: path |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
637 required: true |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
638 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
639 $ref: '#/components/schemas/to' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
640 kind: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
641 name: kind |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
642 in: path |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
643 required: true |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
644 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
645 $ref: '#/components/schemas/kind' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
646 type: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
647 name: type |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
648 in: path |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
649 required: true |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
650 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
651 $ref: '#/components/schemas/type' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
652 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
653 ... |