Mercurial > prosody-modules
annotate mod_rest/res/openapi.yaml @ 4606:d6eb2b722b90
mod_conversejs: Update description
The module browser was still using the first commit message
(6f5c99c9f6cc) as description.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Tue, 29 Jun 2021 12:48:42 +0200 |
parents | 38d80dbfee88 |
children | fae4e1335593 |
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: |
4548
c50fac0f3cbf
mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4547
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' |
4548
c50fac0f3cbf
mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4547
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: |
4548
c50fac0f3cbf
mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4547
diff
changeset
|
47 '200': |
4487
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 |
4529
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
50 /rest/echo: |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
51 post: |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
52 summary: Build as stanza and return it for inspection. |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
53 tags: |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
54 - debug |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
55 security: |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
56 - basic: [] |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
57 - token: [] |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
58 requestBody: |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
59 $ref: '#/components/requestBodies/common' |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
60 responses: |
4548
c50fac0f3cbf
mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4547
diff
changeset
|
61 '200': |
4529
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
62 $ref: '#/components/responses/success' |
c6d44e1fb4d9
mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents:
4528
diff
changeset
|
63 |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
64 /rest/ping/{to}: |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
65 get: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
66 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
67 - query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
68 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
|
69 security: |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
70 - basic: [] |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
71 - token: [] |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
72 parameters: |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
73 - $ref: '#/components/parameters/to' |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
74 responses: |
4548
c50fac0f3cbf
mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4547
diff
changeset
|
75 '200': |
4495
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
76 description: Test reachability of some address |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
77 content: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
78 application/json: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
79 schema: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
80 $ref: '#/components/schemas/iq_pong' |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
81 application/xmpp+xml: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
82 schema: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
83 $ref: '#/components/schemas/iq_pong' |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
84 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
85 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
86 /rest/version/{to}: |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
87 get: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
88 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
89 - query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
90 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
|
91 security: |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
92 - basic: [] |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
93 - token: [] |
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
94 parameters: |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
95 - $ref: '#/components/parameters/to' |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
96 responses: |
4548
c50fac0f3cbf
mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4547
diff
changeset
|
97 '200': |
4493
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
98 description: Version query response |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
99 content: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
100 application/json: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
101 schema: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
102 $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
|
103 application/xmpp+xml: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
104 schema: |
89571a20196f
mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents:
4492
diff
changeset
|
105 $ref: '#/components/schemas/iq_result_version' |
4494
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/disco/{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 a remote entity for supported features |
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: [] |
4478
7ab0c423688a
mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents:
4477
diff
changeset
|
115 parameters: |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
116 - $ref: '#/components/parameters/to' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
117 responses: |
4548
c50fac0f3cbf
mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4547
diff
changeset
|
118 '200': |
4494
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 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
121 /rest/items/{to}: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
122 get: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
123 tags: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
124 - query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
125 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
|
126 security: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
127 - basic: [] |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
128 - token: [] |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
129 parameters: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
130 - $ref: '#/components/parameters/to' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
131 responses: |
4548
c50fac0f3cbf
mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4547
diff
changeset
|
132 '200': |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
133 $ref: '#/components/responses/success' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
134 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
135 components: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
136 schemas: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
137 stanza: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
138 type: object |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
139 example: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
140 body: Hello |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
141 type: chat |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
142 kind: message |
4476 | 143 to: alice@example.com |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
144 state: active |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
145 oneOf: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
146 - $ref: '#/components/schemas/message' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
147 - $ref: '#/components/schemas/presence' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
148 - $ref: '#/components/schemas/iq' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
149 |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
150 message: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
151 type: object |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
152 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
153 name: message |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
154 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
155 kind: |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
156 description: Which kind of stanza |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
157 type: string |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
158 enum: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
159 - message |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
160 type: |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
161 type: string |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
162 enum: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
163 - chat |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
164 - error |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
165 - groupchat |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
166 - headline |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
167 - normal |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
168 to: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
169 $ref: '#/components/schemas/to' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
170 from: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
171 $ref: '#/components/schemas/from' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
172 id: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
173 $ref: '#/components/schemas/id' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
174 lang: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
175 $ref: '#/components/schemas/lang' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
176 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
177 body: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
178 $ref: '#/components/schemas/body' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
179 subject: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
180 $ref: '#/components/schemas/subject' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
181 thread: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
182 $ref: '#/components/schemas/thread' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
183 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
184 state: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
185 $ref: '#/components/schemas/state' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
186 nick: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
187 $ref: '#/components/schemas/nick' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
188 delay: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
189 $ref: '#/components/schemas/delay' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
190 replace: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
191 $ref: '#/components/schemas/replace' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
192 |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
193 html: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
194 $ref: '#/components/schemas/html' |
4547
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
195 oob: |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
196 $ref: '#/components/schemas/oob' |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
197 |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
198 error: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
199 $ref: '#/components/schemas/error' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
200 |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
201 presence: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
202 type: object |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
203 properties: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
204 kind: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
205 kind: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
206 description: Which kind of stanza |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
207 type: string |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
208 enum: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
209 - presence |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
210 type: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
211 type: string |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
212 enum: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
213 - available |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
214 - unavailable |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
215 - subscribe |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
216 - subscribed |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
217 - unsubscribe |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
218 - unsubscribed |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
219 - error |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
220 to: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
221 $ref: '#/components/schemas/to' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
222 from: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
223 $ref: '#/components/schemas/from' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
224 id: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
225 $ref: '#/components/schemas/id' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
226 lang: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
227 $ref: '#/components/schemas/lang' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
228 |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
229 show: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
230 $ref: '#/components/schemas/show' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
231 status: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
232 $ref: '#/components/schemas/status' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
233 priority: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
234 $ref: '#/components/schemas/priority' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
235 |
4572
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
236 caps: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
237 $ref: '#/components/schemas/caps' |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
238 nick: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
239 $ref: '#/components/schemas/nick' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
240 delay: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
241 $ref: '#/components/schemas/delay' |
4573
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
242 vcard_update: |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
243 $ref: '#/components/schemas/vcard_update' |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
244 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
245 join: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
246 $ref: '#/components/schemas/join' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
247 |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
248 error: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
249 $ref: '#/components/schemas/error' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
250 |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
251 iq: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
252 type: object |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
253 properties: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
254 kind: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
255 description: Which kind of stanza |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
256 type: string |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
257 enum: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
258 - iq |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
259 type: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
260 type: string |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
261 enum: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
262 - get |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
263 - set |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
264 - result |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
265 - error |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
266 to: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
267 $ref: '#/components/schemas/to' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
268 from: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
269 $ref: '#/components/schemas/from' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
270 id: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
271 $ref: '#/components/schemas/id' |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
272 lang: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
273 $ref: '#/components/schemas/lang' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
274 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
275 ping: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
276 $ref: '#/components/schemas/ping' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
277 version: |
4527
9a6aaba3d5ef
mod_rest: Reflect XEP-0092 queries no longer taking booleans in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4497
diff
changeset
|
278 $ref: '#/components/schemas/version' |
4574
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
279 lastactivity: |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
280 $ref: '#/components/schemas/lastactivity' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
281 disco: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
282 $ref: '#/components/schemas/disco' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
283 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
284 $ref: '#/components/schemas/items' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
285 command: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
286 $ref: '#/components/schemas/command' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
287 |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
288 stats: |
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
289 $ref: '#/components/schemas/stats' |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
290 payload: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
291 $ref: '#/components/schemas/payload' |
4546
cfe196f88e96
mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents:
4529
diff
changeset
|
292 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
293 error: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
294 $ref: '#/components/schemas/error' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
295 |
4495
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
296 iq_pong: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
297 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
|
298 type: object |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
299 xml: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
300 name: iq |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
301 properties: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
302 type: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
303 type: string |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
304 enum: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
305 - result |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
306 xml: |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
307 attribute: true |
cdc530ec76d6
mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents:
4494
diff
changeset
|
308 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
309 iq_result_version: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
310 description: Version query response |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
311 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
312 xml: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
313 name: iq |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
314 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
315 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
316 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
317 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
318 - result |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
319 xml: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
320 attribute: true |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
321 version: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
322 $ref: '#/components/schemas/version' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
323 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
324 kind: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
325 description: Which kind of stanza |
4476 | 326 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
327 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
328 - message |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
329 - presence |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
330 - iq |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
331 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
332 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
333 description: Stanza type |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
334 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
335 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
336 - chat |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
337 - normal |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
338 - headline |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
339 - groupchat |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
340 - get |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
341 - set |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
342 - result |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
343 - available |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
344 - unavailable |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
345 - subscribe |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
346 - subscribed |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
347 - unsubscribe |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
348 - unsubscribed |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
349 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
350 to: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
351 description: recipient |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
352 example: alice@example.com |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
353 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
354 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
355 from: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
356 description: the sender |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
357 example: bob@localhost.example |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
358 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
359 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
360 id: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
361 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
|
362 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
363 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
364 lang: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
365 description: Language code |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
366 example: en |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
367 type: string |
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 body: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
370 description: Human-readable chat message |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
371 example: Hello, World! |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
372 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
373 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
374 subject: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
375 description: Subject of message or group chat |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
376 example: Talking about stuff |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
377 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
378 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
379 thread: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
380 description: Message thread identifier |
4571
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
381 properties: |
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
382 parent: |
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
383 type: string |
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
384 xml: |
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
385 attribute: true |
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
386 id: |
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
387 type: string |
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
388 xml: |
913fcb5efc77
mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents:
4570
diff
changeset
|
389 text: true |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
390 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
391 show: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
392 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
|
393 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
394 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
395 - away |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
396 - chat |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
397 - dnd |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
398 - xa |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
399 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
400 status: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
401 description: Textual status message. |
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 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
404 priority: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
405 description: Presence priority |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
406 type: integer |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
407 maximum: 127 |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
408 minimum: -128 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
409 |
4476 | 410 state: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
411 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
|
412 type: string |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
413 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
414 namespace: http://jabber.org/protocol/chatstates |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
415 x_name_is_value: true |
4476 | 416 enum: |
417 - active | |
418 - inactive | |
419 - gone | |
420 - composing | |
421 - paused | |
422 example: composing | |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
423 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
424 nick: |
4476 | 425 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
426 description: Nickname of the sender |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
427 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
428 name: nick |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
429 namespace: http://jabber.org/protocol/nick |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
430 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
431 delay: |
4476 | 432 type: string |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
433 format: date-time |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
434 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
|
435 format. |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
436 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
437 name: delay |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
438 namespace: urn:xmpp:delay |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
439 x_single_attribute: stamp |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
440 |
4476 | 441 replace: |
442 type: string | |
443 description: ID of message being replaced (e.g. for corrections) | |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
444 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
445 name: replace |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
446 namespace: urn:xmpp:message-correct:0 |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
447 x_single_attribute: id |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
448 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
449 join: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
450 description: For joining Multi-User-Chats |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
451 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
452 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
453 - true |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
454 |
4549
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
455 invite: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
456 type: object |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
457 description: Invite to a group chat |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
458 required: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
459 - jid |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
460 xml: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
461 name: x |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
462 namespace: jabber:x:conference |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
463 properties: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
464 jid: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
465 type: string |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
466 description: Address of the group chat |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
467 format: xmpp-jid |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
468 xml: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
469 attribute: true |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
470 reason: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
471 type: string |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
472 description: Optional message by the inviter |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
473 xml: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
474 attribute: true |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
475 password: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
476 type: string |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
477 description: Password for the group chat, if required |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
478 xml: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
479 attribute: true |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
480 thread: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
481 type: string |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
482 xml: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
483 attribute: true |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
484 continue: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
485 type: boolean |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
486 description: Whether the group chat continues a one-to-one chat |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
487 xml: |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
488 attribute: true |
cce0e1ec8a74
mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents:
4548
diff
changeset
|
489 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
490 html: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
491 description: HTML version of 'body' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
492 example: <body><p>Hello!</p></body> |
4476 | 493 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
494 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
495 ping: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
496 description: A ping. |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
497 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
498 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
499 - true |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
500 xml: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
501 name: ping |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
502 namespace: urn:xmpp:ping |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
503 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
504 version: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
505 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
506 description: Software version query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
507 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
508 name: |
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 example: My Software |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
511 version: |
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 example: 1.0.0 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
514 os: |
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 example: Linux |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
517 required: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
518 - name |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
519 - version |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
520 xml: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
521 name: query |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
522 namespace: jabber:iq:version |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
523 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
524 disco: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
525 description: Discover supported features |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
526 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
527 - description: A full response |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
528 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
529 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
530 features: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
531 description: List of URIs indicating supported features |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
532 type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
533 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
534 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
535 identities: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
536 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
|
537 entity |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
538 type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
539 example: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
540 - name: Prosody |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
541 type: im |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
542 category: server |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
543 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
544 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
545 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
546 name: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
547 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
548 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
549 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
550 category: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
551 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
552 node: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
553 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
554 extensions: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
555 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
556 - 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
|
557 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
558 - 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
|
559 type: boolean |
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 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
562 description: List of references to other entities |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
563 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
564 - description: List of items referenced |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
565 type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
566 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
567 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
568 jid: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
569 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
570 description: Address of item |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
571 node: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
572 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
573 name: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
574 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
575 description: Descriptive name |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
576 required: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
577 - jid |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
578 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
579 - type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
580 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
|
581 - description: An items query or empty list |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
582 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
583 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
584 - true |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
585 |
4476 | 586 command: |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
587 description: Ad-hoc commands. |
4476 | 588 oneOf: |
589 - type: object | |
590 properties: | |
591 data: | |
4486
4f41678ba00d
mod_rest/openapi: Fix dataform references
Kim Alvefur <zash@zash.se>
parents:
4479
diff
changeset
|
592 $ref: '#/components/schemas/formdata' |
4476 | 593 action: |
594 type: string | |
595 note: | |
596 type: object | |
597 properties: | |
598 text: | |
599 type: string | |
600 type: | |
601 type: string | |
602 enum: | |
603 - info | |
604 - warn | |
605 - error | |
606 form: | |
4486
4f41678ba00d
mod_rest/openapi: Fix dataform references
Kim Alvefur <zash@zash.se>
parents:
4479
diff
changeset
|
607 $ref: '#/components/schemas/dataform' |
4476 | 608 sessionid: |
609 type: string | |
610 status: | |
611 type: string | |
612 node: | |
613 type: string | |
614 actions: | |
615 type: object | |
616 properties: | |
617 complete: | |
618 type: boolean | |
619 prev: | |
620 type: boolean | |
621 next: | |
622 type: boolean | |
623 execute: | |
624 type: string | |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
625 - type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
626 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
|
627 |
4547
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
628 oob: |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
629 type: object |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
630 description: Reference a media file |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
631 xml: |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
632 name: x |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
633 namespace: jabber:x:oob |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
634 properties: |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
635 url: |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
636 type: string |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
637 description: URL of the attached media file |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
638 example: https://media.example.net/thisfile.jpg |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
639 format: uri |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
640 desc: |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
641 description: Optional description |
a9e997d5eb94
mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents:
4546
diff
changeset
|
642 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
643 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
644 payload: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
645 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
|
646 type: object |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
647 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
648 name: payload |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
649 namespace: urn:xmpp:json-msg:0 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
650 required: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
651 - datatype |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
652 - data |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
653 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
654 data: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
655 example: '{"some":"json"}' |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
656 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
657 datatype: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
658 example: urn:example:my-json#payload |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
659 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
660 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
661 dataform: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
662 description: Data form |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
663 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
664 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
665 title: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
666 description: Title of the form |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
667 example: TPS Report |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
668 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
669 fields: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
670 type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
671 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
672 description: Form field |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
673 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
674 properties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
675 value: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
676 description: Field value |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
677 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
678 - type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
679 - type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
680 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
681 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
682 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
683 description: Type of form field |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
684 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
685 label: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
686 description: Descriptive label for the field |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
687 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
688 desc: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
689 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
|
690 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
691 required: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
692 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
|
693 type: boolean |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
694 var: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
695 description: Internal name of the field |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
696 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
697 type: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
698 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
699 enum: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
700 - form |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
701 - submit |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
702 - cancel |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
703 - result |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
704 instructions: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
705 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
706 |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
707 formdata: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
708 description: Simplified data form carrying only values |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
709 type: object |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
710 additionalProperties: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
711 oneOf: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
712 - type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
713 - type: array |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
714 items: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
715 type: string |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
716 |
4476 | 717 stats: |
718 description: Statistics | |
719 type: array | |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
720 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
721 name: query |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
722 namespace: http://jabber.org/protocol/stats |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
723 wrapped: true |
4476 | 724 items: |
725 type: object | |
726 properties: | |
727 name: | |
728 type: string | |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
729 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
730 attribute: true |
4476 | 731 unit: |
732 type: string | |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
733 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
734 attribute: true |
4476 | 735 value: |
736 type: string | |
4570
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
737 xml: |
82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4549
diff
changeset
|
738 attribute: true |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
739 |
4574
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
740 lastactivity: |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
741 type: object |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
742 xml: |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
743 name: query |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
744 namespace: jabber:iq:last |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
745 properties: |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
746 seconds: |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
747 type: integer |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
748 minimum: 0 |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
749 xml: |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
750 attribute: true |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
751 status: |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
752 type: string |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
753 xml: |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
754 text: true |
38d80dbfee88
mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4573
diff
changeset
|
755 |
4572
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
756 caps: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
757 type: object |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
758 xml: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
759 name: c |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
760 namespace: http://jabber.org/protocol/caps |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
761 properties: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
762 ver: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
763 type: string |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
764 xml: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
765 attribute: true |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
766 hash: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
767 type: string |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
768 xml: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
769 attribute: true |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
770 node: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
771 type: string |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
772 xml: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
773 attribute: true |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
774 ext: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
775 type: string |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
776 xml: |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
777 attribute: true |
2395d68af879
mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4571
diff
changeset
|
778 |
4573
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
779 vcard_update: |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
780 type: object |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
781 xml: |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
782 name: x |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
783 namespace: vcard-temp:x:update |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
784 properties: |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
785 photo: |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
786 type: string |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
787 example: adc83b19e793491b1c6ea0fd8b46cd9f32e592fc |
766883d8fc9e
mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents:
4572
diff
changeset
|
788 |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
789 error: |
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
790 description: Description of something gone wrong. See the Stanza Errors section in RFC 6120. |
4476 | 791 type: object |
4479
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
792 properties: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
793 type: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
794 description: General category of error |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
795 type: string |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
796 enum: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
797 - auth |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
798 - cancel |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
799 - continue |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
800 - modify |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
801 - wait |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
802 condition: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
803 description: Specific error condition. |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
804 type: string |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
805 # enum: [ full list available in RFC 6120 ] |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
806 code: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
807 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
|
808 type: integer |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
809 text: |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
810 description: Description of error intended for human eyes. |
356b5ad521a5
mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents:
4478
diff
changeset
|
811 type: string |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
812 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
813 securitySchemes: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
814 token: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
815 description: Tokens from mod_http_oauth2. |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
816 scheme: Bearer |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
817 type: http |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
818 basic: |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
819 description: Use JID as username. |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
820 scheme: Basic |
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
821 type: http |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
822 |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
823 requestBodies: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
824 common: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
825 required: true |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
826 content: |
4497
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
827 application/json: |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
828 schema: |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
829 $ref: '#/components/schemas/stanza' |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
830 application/xmpp+xml: |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
831 schema: |
4c262e5a02b5
mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents:
4496
diff
changeset
|
832 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
|
833 application/x-www-form-urlencoded: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
834 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
835 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
|
836 |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
837 responses: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
838 success: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
839 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
|
840 content: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
841 application/json: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
842 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
843 $ref: '#/components/schemas/stanza' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
844 application/xmpp+xml: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
845 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
846 description: Single XMPP stanza in XML format. |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
847 example: <message><body>Hello</body></message> |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
848 application/x-www-form-urlencoded: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
849 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
850 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
|
851 example: body=Hello |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
852 text/plain: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
853 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
854 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
|
855 example: Hello |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
856 type: string |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
857 sent: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
858 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
|
859 so an empty reply. |
4494
aa4dcd4b39c8
mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents:
4493
diff
changeset
|
860 |
4487
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
861 parameters: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
862 to: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
863 name: to |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
864 in: path |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
865 required: true |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
866 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
867 $ref: '#/components/schemas/to' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
868 kind: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
869 name: kind |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
870 in: path |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
871 required: true |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
872 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
873 $ref: '#/components/schemas/kind' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
874 type: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
875 name: type |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
876 in: path |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
877 required: true |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
878 schema: |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
879 $ref: '#/components/schemas/type' |
f877a4d3770b
mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents:
4486
diff
changeset
|
880 |
4474
949db0714b5f
mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
881 ... |