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