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