prosody-modules
2735e29cf94b
mod_rest/res/openapi.yaml

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_rest/res/openapi.yaml @ 4958:2735e29cf94b

mod_rest: Add some descriptive details to schema
author Kim Alvefur <zash@zash.se>
date Sun, 05 Jun 2022 21:56:22 +0200
parent 4948:2ff1fa824c5d
child 4959:0989dea9b356
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 openapi: 3.0.1
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
3
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 info:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 title: mod_rest API
4497
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents: 4496
diff changeset
6 version: 0.3.2
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 description: |
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 API for sending and receiving stanzas, in a REST-ish fashion or by
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 responding to webhooks. Multiple formats supported, including native XML
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 and a simplified JSON mapping.
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 license:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 name: MIT
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
13
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 paths:
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
15
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 /rest:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 post:
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
18 summary: Send stanzas and receive responses. Webhooks work the same way.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
19 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
20 - generic
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 security:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 - basic: []
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 - token: []
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
24 requestBody:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
25 $ref: '#/components/requestBodies/common'
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 responses:
4548
c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4547
diff changeset
27 '200':
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
28 $ref: '#/components/responses/success'
4548
c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4547
diff changeset
29 '202':
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
30 $ref: '#/components/responses/sent'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
31
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
32 /rest/{kind}/{type}/{to}:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
33 post:
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
34 summary: Even more RESTful mapping with certain components in the path.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
35 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
36 - generic
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
37 security:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
38 - basic: []
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
39 - token: []
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
40 parameters:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
41 - $ref: '#/components/parameters/kind'
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
42 - $ref: '#/components/parameters/type'
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
43 - $ref: '#/components/parameters/to'
4496
8e9bff3cde4f mod_rest/openapi: Add missing body for POST /kind/type/to query
Kim Alvefur <zash@zash.se>
parents: 4495
diff changeset
44 requestBody:
8e9bff3cde4f mod_rest/openapi: Add missing body for POST /kind/type/to query
Kim Alvefur <zash@zash.se>
parents: 4495
diff changeset
45 $ref: '#/components/requestBodies/common'
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
46 responses:
4548
c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4547
diff changeset
47 '200':
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
48 $ref: '#/components/responses/success'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
49
4529
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
50 /rest/echo:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
51 post:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
52 summary: Build as stanza and return it for inspection.
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
53 tags:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
54 - debug
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
55 security:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
56 - basic: []
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
57 - token: []
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
58 requestBody:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
59 $ref: '#/components/requestBodies/common'
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
60 responses:
4548
c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4547
diff changeset
61 '200':
4529
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
62 $ref: '#/components/responses/success'
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec
Kim Alvefur <zash@zash.se>
parents: 4528
diff changeset
63
4478
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
64 /rest/ping/{to}:
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
65 get:
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
66 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
67 - query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
68 summary: Ping a local or remote server or other entity
4478
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
69 security:
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
70 - basic: []
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
71 - token: []
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
72 parameters:
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
73 - $ref: '#/components/parameters/to'
4478
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
74 responses:
4548
c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4547
diff changeset
75 '200':
4495
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
76 description: Test reachability of some address
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
77 content:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
78 application/json:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
79 schema:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
80 $ref: '#/components/schemas/iq_pong'
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
81 application/xmpp+xml:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
82 schema:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
83 $ref: '#/components/schemas/iq_pong'
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
84
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
85
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
86 /rest/version/{to}:
4478
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
87 get:
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
88 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
89 - query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
90 summary: Ask what software version is used.
4478
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
91 security:
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
92 - basic: []
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
93 - token: []
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
94 parameters:
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
95 - $ref: '#/components/parameters/to'
4478
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
96 responses:
4548
c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4547
diff changeset
97 '200':
4493
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents: 4492
diff changeset
98 description: Version query response
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents: 4492
diff changeset
99 content:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents: 4492
diff changeset
100 application/json:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents: 4492
diff changeset
101 schema:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents: 4492
diff changeset
102 $ref: '#/components/schemas/iq_result_version'
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents: 4492
diff changeset
103 application/xmpp+xml:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents: 4492
diff changeset
104 schema:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail
Kim Alvefur <zash@zash.se>
parents: 4492
diff changeset
105 $ref: '#/components/schemas/iq_result_version'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
106
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
107 /rest/disco/{to}:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
108 get:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
109 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
110 - query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
111 summary: Query a remote entity for supported features
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
112 security:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
113 - basic: []
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
114 - token: []
4478
7ab0c423688a mod_rest: Support GET for certain IQ queries
Kim Alvefur <zash@zash.se>
parents: 4477
diff changeset
115 parameters:
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
116 - $ref: '#/components/parameters/to'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
117 responses:
4548
c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4547
diff changeset
118 '200':
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
119 $ref: '#/components/responses/success'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
120
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
121 /rest/items/{to}:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
122 get:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
123 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
124 - query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
125 summary: Query an entity for related services, chat rooms or other items
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
126 security:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
127 - basic: []
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
128 - token: []
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
129 parameters:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
130 - $ref: '#/components/parameters/to'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
131 responses:
4548
c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4547
diff changeset
132 '200':
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
133 $ref: '#/components/responses/success'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
134
4801
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
135 /rest/extdisco/{to}:
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
136 get:
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
137 tags:
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
138 - query
4929
65438e4ba563 mod_rest: Fix description of extdisco endpoint (thanks MattJ)
Kim Alvefur <zash@zash.se>
parents: 4889
diff changeset
139 summary: Query for external services (usually STUN and TURN)
4801
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
140 security:
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
141 - basic: []
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
142 - token: []
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
143 parameters:
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
144 - $ref: '#/components/parameters/to'
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
145 - name: type
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
146 in: query
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
147 schema:
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
148 type: string
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
149 example: stun
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
150 responses:
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
151 '200':
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
152 $ref: '#/components/responses/success'
b65955c0abd8 mod_rest: Add GET method of invoking XEP-0215 to openapi spec
Kim Alvefur <zash@zash.se>
parents: 4800
diff changeset
153
4948
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
154
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
155 /rest/archive/{to}:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
156 get:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
157 tags:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
158 - query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
159 summary: Query a message archive
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
160 security:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
161 - basic: []
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
162 - token: []
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
163 parameters:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
164 - $ref: '#/components/parameters/to'
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
165 - name: with
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
166 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
167 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
168 type: string
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
169 - name: start
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
170 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
171 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
172 type: string
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
173 - name: end
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
174 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
175 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
176 type: string
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
177 - name: before-id
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
178 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
179 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
180 type: string
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
181 - name: after-id
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
182 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
183 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
184 type: string
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
185 - name: ids
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
186 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
187 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
188 type: string
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
189 description: comma-separated list of archive ids
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
190 - name: after
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
191 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
192 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
193 type: string
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
194 - name: before
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
195 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
196 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
197 type: string
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
198 - name: max
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
199 in: query
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
200 schema:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
201 type: integer
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
202 responses:
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
203 '200':
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
204 $ref: '#/components/responses/success'
2ff1fa824c5d mod_rest: Document /archive/ in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4935
diff changeset
205
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
206 components:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
207 schemas:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
208 stanza:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
209 type: object
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
210 example:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
211 body: Hello
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
212 type: chat
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
213 kind: message
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
214 to: alice@example.com
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
215 state: active
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
216 oneOf:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
217 - $ref: '#/components/schemas/message'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
218 - $ref: '#/components/schemas/presence'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
219 - $ref: '#/components/schemas/iq'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
220
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
221 message:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
222 type: object
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
223 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
224 name: message
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
225 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
226 kind:
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
227 description: Which kind of stanza
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
228 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
229 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
230 - message
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
231 type:
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
232 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
233 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
234 - chat
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
235 - error
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
236 - groupchat
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
237 - headline
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
238 - normal
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
239 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
240 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
241
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
242 to:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
243 $ref: '#/components/schemas/to'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
244 from:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
245 $ref: '#/components/schemas/from'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
246 id:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
247 $ref: '#/components/schemas/id'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
248 lang:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
249 $ref: '#/components/schemas/lang'
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 $ref: '#/components/schemas/body'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
253 subject:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
254 $ref: '#/components/schemas/subject'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
255 thread:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
256 $ref: '#/components/schemas/thread'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
257
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
258 state:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
259 $ref: '#/components/schemas/state'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
260 nick:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
261 $ref: '#/components/schemas/nick'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
262 delay:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
263 $ref: '#/components/schemas/delay'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
264 replace:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
265 $ref: '#/components/schemas/replace'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
266
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
267 html:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
268 $ref: '#/components/schemas/html'
4547
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
269 oob:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
270 $ref: '#/components/schemas/oob'
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
271 reactions:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
272 $ref: '#/components/schemas/reactions'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
273 occupant_id:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
274 $ref: '#/components/schemas/occupant_id'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
275 attach_to:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
276 $ref: '#/components/schemas/attach_to'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
277 fallback:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
278 $ref: '#/components/schemas/fallback'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
279 stanza_ids:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
280 $ref: '#/components/schemas/stanza_ids'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
281 reference:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
282 $ref: '#/components/schemas/reference'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
283 markable:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
284 $ref: '#/components/schemas/markable'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
285 displayed:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
286 $ref: '#/components/schemas/displayed'
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
287
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
288 error:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
289 $ref: '#/components/schemas/error'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
290
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
291 presence:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
292 type: object
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
293 properties:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
294 kind:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
295 description: Which kind of stanza
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
296 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
297 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
298 - presence
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
299 type:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
300 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
301 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
302 - available
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
303 - unavailable
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
304 - subscribe
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
305 - subscribed
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
306 - unsubscribe
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
307 - unsubscribed
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
308 - error
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
309 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
310 attribute: true
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
311 to:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
312 $ref: '#/components/schemas/to'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
313 from:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
314 $ref: '#/components/schemas/from'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
315 id:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
316 $ref: '#/components/schemas/id'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
317 lang:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
318 $ref: '#/components/schemas/lang'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
319
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
320 show:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
321 $ref: '#/components/schemas/show'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
322 status:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
323 $ref: '#/components/schemas/status'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
324 priority:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
325 $ref: '#/components/schemas/priority'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
326
4572
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
327 caps:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
328 $ref: '#/components/schemas/caps'
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
329 nick:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
330 $ref: '#/components/schemas/nick'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
331 delay:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
332 $ref: '#/components/schemas/delay'
4573
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
333 vcard_update:
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
334 $ref: '#/components/schemas/vcard_update'
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
335 idle_since:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
336 $ref: '#/components/schemas/idle_since'
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
337
4935
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
338 muc:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
339 $ref: '#/components/schemas/muc'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
340
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
341 error:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
342 $ref: '#/components/schemas/error'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
343
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
344 iq:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
345 type: object
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
346 properties:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
347 kind:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
348 description: Which kind of stanza
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
349 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
350 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
351 - iq
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
352 type:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
353 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
354 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
355 - get
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
356 - set
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
357 - result
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
358 - error
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
359 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
360 attribute: true
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
361 to:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
362 $ref: '#/components/schemas/to'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
363 from:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
364 $ref: '#/components/schemas/from'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
365 id:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
366 $ref: '#/components/schemas/id'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
367 lang:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
368 $ref: '#/components/schemas/lang'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
369
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
370 ping:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
371 $ref: '#/components/schemas/ping'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
372 version:
4527
9a6aaba3d5ef mod_rest: Reflect XEP-0092 queries no longer taking booleans in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4497
diff changeset
373 $ref: '#/components/schemas/version'
4574
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
374 lastactivity:
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
375 $ref: '#/components/schemas/lastactivity'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
376 disco:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
377 $ref: '#/components/schemas/disco'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
378 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
379 $ref: '#/components/schemas/items'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
380 command:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
381 $ref: '#/components/schemas/command'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
382
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
383 stats:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
384 $ref: '#/components/schemas/stats'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
385 payload:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
386 $ref: '#/components/schemas/payload'
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
387 gateway:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
388 $ref: '#/components/schemas/gateway'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
389 register:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
390 $ref: '#/components/schemas/register'
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
391 extdisco:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
392 $ref: '#/components/schemas/extdisco'
4889
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
393 upload_request:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
394 $ref: '#/components/schemas/upload_request'
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
395 upload_slot:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
396 $ref: '#/components/schemas/upload_slot'
4546
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types
Kim Alvefur <zash@zash.se>
parents: 4529
diff changeset
397
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
398 error:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
399 $ref: '#/components/schemas/error'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
400
4495
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
401 iq_pong:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
402 description: Test reachability of some XMPP address
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
403 type: object
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
404 xml:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
405 name: iq
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
406 properties:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
407 type:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
408 type: string
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
409 enum:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
410 - result
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
411 xml:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
412 attribute: true
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation
Kim Alvefur <zash@zash.se>
parents: 4494
diff changeset
413
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
414 iq_result_version:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
415 description: Version query response
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
416 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
417 xml:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
418 name: iq
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
419 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
420 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
421 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
422 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
423 - result
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
424 xml:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
425 attribute: true
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
426 version:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
427 $ref: '#/components/schemas/version'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
428
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
429 kind:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
430 description: Which kind of stanza
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
431 type: string
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
432 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
433 - message
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
434 - presence
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
435 - iq
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
436
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
437 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
438 description: Stanza type
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
439 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
440 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
441 - chat
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
442 - normal
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
443 - headline
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
444 - groupchat
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
445 - get
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
446 - set
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
447 - result
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
448 - available
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
449 - unavailable
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
450 - subscribe
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
451 - subscribed
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
452 - unsubscribe
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
453 - unsubscribed
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
454 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
455 attribute: true
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
456
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
457 to:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
458 description: recipient
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
459 example: alice@example.com
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
460 type: string
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
461 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
462 attribute: true
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
463
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
464 from:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
465 description: the sender
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
466 example: bob@localhost.example
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
467 type: string
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
468 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
469 attribute: true
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
470
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
471 id:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
472 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
473 type: string
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
474 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
475 attribute: true
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
476
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
477 lang:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
478 description: Language code
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
479 example: en
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
480 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
481 prefix: xml
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
482 attribute: true
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
483 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
484
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
485 body:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
486 description: Human-readable chat message
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
487 example: Hello, World!
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
488 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
489
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
490 subject:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
491 description: Subject of message or group chat
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
492 example: Talking about stuff
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
493 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
495 thread:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
496 description: Message thread identifier
4571
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
497 properties:
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
498 parent:
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
499 type: string
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
500 xml:
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
501 attribute: true
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
502 id:
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
503 type: string
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
504 xml:
913fcb5efc77 mod_rest: Update schema for <thread>
Kim Alvefur <zash@zash.se>
parents: 4570
diff changeset
505 text: true
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
506
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
507 show:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
508 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
509 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
510 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
511 - away
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
512 - chat
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
513 - dnd
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
514 - xa
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
515
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
516 status:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
517 description: Textual status message.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
518 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
519
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
520 priority:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
521 description: Presence priority
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
522 type: integer
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
523 maximum: 127
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
524 minimum: -128
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
525
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
526 state:
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
527 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
528 type: string
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
529 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
530 namespace: http://jabber.org/protocol/chatstates
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
531 x_name_is_value: true
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
532 enum:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
533 - active
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
534 - inactive
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
535 - gone
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
536 - composing
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
537 - paused
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
538 example: composing
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
539
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
540 nick:
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
541 type: string
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
542 description: Nickname of the sender
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
543 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
544 name: nick
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
545 namespace: http://jabber.org/protocol/nick
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
546
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
547 delay:
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
548 type: string
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
549 format: date-time
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
550 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
551 format.
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
552 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
553 name: delay
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
554 namespace: urn:xmpp:delay
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
555 x_single_attribute: stamp
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
556
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
557 replace:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
558 type: string
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
559 description: ID of message being replaced (e.g. for corrections)
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
560 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
561 name: replace
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
562 namespace: urn:xmpp:message-correct:0
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
563 x_single_attribute: id
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
564
4935
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
565 muc:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
566 description: Multi-User-Chat related
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
567 type: object
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
568 xml:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
569 name: x
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
570 namespace: http://jabber.org/protocol/muc
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
571 properties:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
572 history:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
573 type: object
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
574 properties:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
575 maxchars:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
576 type: integer
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
577 minimum: 0
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
578 xml:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
579 attribute: true
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
580 maxstanzas:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
581 type: integer
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
582 minimum: 0
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
583 xml:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
584 attribute: true
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
585 seconds:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
586 type: integer
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
587 minimum: 0
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
588 xml:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
589 attribute: true
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
590 since:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
591 type: string
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
592 format: date-time
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
593 xml:
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
594 attribute: true
a85efae90e21 mod_rest: Expand mapping of XEP-0045 join stanza
Kim Alvefur <zash@zash.se>
parents: 4929
diff changeset
595
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
596
4549
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
597 invite:
4958
2735e29cf94b mod_rest: Add some descriptive details to schema
Kim Alvefur <zash@zash.se>
parents: 4948
diff changeset
598 description: Invite to a group chat
2735e29cf94b mod_rest: Add some descriptive details to schema
Kim Alvefur <zash@zash.se>
parents: 4948
diff changeset
599 title: "XEP-0249: Direct MUC Invitations"
4549
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
600 type: object
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
601 required:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
602 - jid
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
603 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
604 name: x
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
605 namespace: jabber:x:conference
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
606 properties:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
607 jid:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
608 type: string
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
609 description: Address of the group chat
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
610 format: xmpp-jid
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
611 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
612 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
613 reason:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
614 type: string
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
615 description: Optional message by the inviter
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
616 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
617 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
618 password:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
619 type: string
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
620 description: Password for the group chat, if required
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
621 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
622 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
623 thread:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
624 type: string
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
625 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
626 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
627 continue:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
628 type: boolean
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
629 description: Whether the group chat continues a one-to-one chat
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
630 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
631 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas
Kim Alvefur <zash@zash.se>
parents: 4548
diff changeset
632
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
633 html:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
634 description: HTML version of 'body'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
635 example: <body><p>Hello!</p></body>
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
636 type: string
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
637
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
638 ping:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
639 description: A ping.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
640 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
641 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
642 - true
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
643 xml:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
644 name: ping
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
645 namespace: urn:xmpp:ping
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
646
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
647 version:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
648 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
649 description: Software version query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
650 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
651 name:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
652 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
653 example: My Software
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
654 version:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
655 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
656 example: 1.0.0
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
657 os:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
658 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
659 example: Linux
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
660 required:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
661 - name
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
662 - version
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
663 xml:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
664 name: query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
665 namespace: jabber:iq:version
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
666
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
667 disco:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
668 description: Discover supported features
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
669 oneOf:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
670 - description: A full response
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
671 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
672 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
673 features:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
674 description: List of URIs indicating supported features
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
675 type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
676 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
677 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
678 identities:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
679 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
680 entity
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
681 type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
682 example:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
683 - name: Prosody
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
684 type: im
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
685 category: server
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
686 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
687 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
688 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
689 name:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
690 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
691 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
692 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
693 category:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
694 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
695 node:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
696 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
697 extensions:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
698 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
699 - 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
700 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
701 - 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
702 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
703
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
704 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
705 description: List of references to other entities
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
706 oneOf:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
707 - description: List of items referenced
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
708 type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
709 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
710 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
711 jid:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
712 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
713 description: Address of item
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
714 node:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
715 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
716 name:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
717 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
718 description: Descriptive name
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
719 required:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
720 - jid
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
721 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
722 - type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
723 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
724 - description: An items query or empty list
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
725 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
726 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
727 - true
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
728
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
729 command:
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
730 description: Ad-hoc commands.
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
731 oneOf:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
732 - type: object
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
733 properties:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
734 data:
4486
4f41678ba00d mod_rest/openapi: Fix dataform references
Kim Alvefur <zash@zash.se>
parents: 4479
diff changeset
735 $ref: '#/components/schemas/formdata'
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
736 action:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
737 type: string
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
738 note:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
739 type: object
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
740 properties:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
741 text:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
742 type: string
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
743 type:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
744 type: string
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
745 enum:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
746 - info
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
747 - warn
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
748 - error
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
749 form:
4486
4f41678ba00d mod_rest/openapi: Fix dataform references
Kim Alvefur <zash@zash.se>
parents: 4479
diff changeset
750 $ref: '#/components/schemas/dataform'
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
751 sessionid:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
752 type: string
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
753 status:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
754 type: string
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
755 node:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
756 type: string
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
757 actions:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
758 type: object
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
759 properties:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
760 complete:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
761 type: boolean
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
762 prev:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
763 type: boolean
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
764 next:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
765 type: boolean
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
766 execute:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
767 type: string
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
768 - type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
769 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
770
4547
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
771 oob:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
772 type: object
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
773 description: Reference a media file
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
774 xml:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
775 name: x
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
776 namespace: jabber:x:oob
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
777 properties:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
778 url:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
779 type: string
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
780 description: URL of the attached media file
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
781 example: https://media.example.net/thisfile.jpg
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
782 format: uri
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
783 desc:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
784 description: Optional description
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob'
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
785 type: string
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
786
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
787 payload:
4958
2735e29cf94b mod_rest: Add some descriptive details to schema
Kim Alvefur <zash@zash.se>
parents: 4948
diff changeset
788 title: 'XEP-0335: JSON Containers'
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
789 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
790 type: object
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
791 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
792 name: payload
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
793 namespace: urn:xmpp:json-msg:0
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
794 required:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
795 - datatype
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
796 - data
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
797 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
798 data:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
799 example: '{"some":"json"}'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
800 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
801 datatype:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
802 example: urn:example:my-json#payload
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
803 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
804
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
805 dataform:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
806 description: Data form
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
807 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
808 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
809 title:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
810 description: Title of the form
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
811 example: TPS Report
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
812 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
813 fields:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
814 type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
815 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
816 description: Form field
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
817 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
818 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
819 value:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
820 description: Field value
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
821 oneOf:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
822 - type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
823 - type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
824 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
825 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
826 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
827 description: Type of form field
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
828 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
829 label:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
830 description: Descriptive label for the field
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
831 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
832 desc:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
833 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
834 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
835 required:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
836 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
837 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
838 var:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
839 description: Internal name of the field
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
840 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
841 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
842 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
843 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
844 - form
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
845 - submit
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
846 - cancel
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
847 - result
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
848 instructions:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
849 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
850
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
851 formdata:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
852 description: Simplified data form carrying only values
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
853 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
854 additionalProperties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
855 oneOf:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
856 - type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
857 - type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
858 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
859 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
860
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
861 stats:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
862 description: Statistics
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
863 type: array
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
864 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
865 name: query
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
866 namespace: http://jabber.org/protocol/stats
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
867 wrapped: true
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
868 items:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
869 type: object
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
870 properties:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
871 name:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
872 type: string
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
873 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
874 attribute: true
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
875 unit:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
876 type: string
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
877 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
878 attribute: true
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
879 value:
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
880 type: string
4570
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
881 xml:
82df1eed45d1 mod_rest: Add various XML metadata to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4549
diff changeset
882 attribute: true
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
883
4574
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
884 lastactivity:
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
885 type: object
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
886 xml:
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
887 name: query
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
888 namespace: jabber:iq:last
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
889 properties:
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
890 seconds:
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
891 type: integer
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
892 minimum: 0
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
893 xml:
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
894 attribute: true
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
895 status:
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
896 type: string
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
897 xml:
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
898 text: true
38d80dbfee88 mod_rest: Add XEP-0012 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4573
diff changeset
899
4572
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
900 caps:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
901 type: object
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
902 xml:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
903 name: c
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
904 namespace: http://jabber.org/protocol/caps
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
905 properties:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
906 ver:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
907 type: string
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
908 xml:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
909 attribute: true
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
910 hash:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
911 type: string
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
912 xml:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
913 attribute: true
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
914 node:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
915 type: string
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
916 xml:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
917 attribute: true
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
918 ext:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
919 type: string
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
920 xml:
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
921 attribute: true
2395d68af879 mod_rest: Add XEP-0115 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4571
diff changeset
922
4573
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
923 vcard_update:
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
924 type: object
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
925 xml:
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
926 name: x
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
927 namespace: vcard-temp:x:update
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
928 properties:
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
929 photo:
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
930 type: string
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
931 example: adc83b19e793491b1c6ea0fd8b46cd9f32e592fc
766883d8fc9e mod_rest: Add XEP-0153 to OpenAPI spec
Kim Alvefur <zash@zash.se>
parents: 4572
diff changeset
932
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
933 reactions:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
934 type: object
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
935 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
936 namespace: urn:xmpp:reactions:0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
937 properties:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
938 id:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
939 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
940 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
941 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
942 reactions:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
943 type: array
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
944 items:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
945 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
946 name: reaction
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
947 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
948 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
949 wrapped: false
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
950 name: reactions
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
951
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
952 occupant_id:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
953 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
954 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
955 namespace: urn:xmpp:occupant-id:0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
956 x_single_attribute: id
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
957 name: occupant-id
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
958
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
959 attach_to:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
960 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
961 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
962 namespace: urn:xmpp:message-attaching:1
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
963 x_single_attribute: id
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
964 name: attach-to
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
965
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
966 fallback:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
967 type: boolean
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
968 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
969 namespace: urn:xmpp:fallback:0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
970 x_name_is_value: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
971 name: fallback
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
972
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
973 stanza_ids:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
974 type: array
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
975 items:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
976 type: object
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
977 required:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
978 - id
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
979 - by
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
980 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
981 namespace: urn:xmpp:sid:0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
982 name: stanza-id
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
983 properties:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
984 id:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
985 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
986 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
987 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
988 by:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
989 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
990 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
991 format: xmpp-jid
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
992 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
993
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
994 reference:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
995 type: object
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
996 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
997 namespace: urn:xmpp:reference:0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
998 properties:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
999 end:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1000 minimum: 0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1001 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1002 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1003 type: integer
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1004 uri:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1005 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1006 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1007 format: uri
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1008 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1009 begin:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1010 minimum: 0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1011 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1012 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1013 type: integer
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1014 type:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1015 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1016 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1017 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1018 required:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1019 - type
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1020 - uri
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1021
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1022 markable:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1023 type: boolean
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1024 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1025 namespace: urn:xmpp:chat-markers:0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1026 x_name_is_value: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1027
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1028 displayed:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1029 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1030 description: Message ID of a message that has been displayed
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1031 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1032 namespace: urn:xmpp:chat-markers:0
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1033
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1034 idle_since:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1035 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1036 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1037 namespace: urn:xmpp:idle:1
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1038 x_single_attribute: since
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1039 name: idle
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1040 format: date-time
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1041
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1042 gateway:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1043 type: object
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1044 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1045 namespace: jabber:iq:gateway
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1046 name: query
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1047 properties:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1048 desc:
4802
75543146e94e mod_rest: Fix minor mistakes in openapi spec
Kim Alvefur <zash@zash.se>
parents: 4801
diff changeset
1049 type: string
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1050 prompt:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1051 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1052 jid:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1053 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1054
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1055 extdisco:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1056 type: object
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1057 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1058 namespace: urn:xmpp:extdisco:2
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1059 name: services
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1060 properties:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1061 type:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1062 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1063 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1064 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1065 services:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1066 items:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1067 type: object
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1068 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1069 name: service
4800
1e2f53fb2099 mod_rest: Fix mistaken way of specifying required fields in XEP-0215 map
Kim Alvefur <zash@zash.se>
parents: 4729
diff changeset
1070 required:
1e2f53fb2099 mod_rest: Fix mistaken way of specifying required fields in XEP-0215 map
Kim Alvefur <zash@zash.se>
parents: 4729
diff changeset
1071 - type
1e2f53fb2099 mod_rest: Fix mistaken way of specifying required fields in XEP-0215 map
Kim Alvefur <zash@zash.se>
parents: 4729
diff changeset
1072 - host
4729
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1073 properties:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1074 transport:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1075 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1076 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1077 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1078 type:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1079 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1080 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1081 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1082 port:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1083 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1084 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1085 type: integer
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1086 host:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1087 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1088 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1089 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1090 expires:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1091 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1092 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1093 format: datetime
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1094 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1095 username:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1096 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1097 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1098 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1099 password:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1100 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1101 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1102 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1103 restricted:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1104 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1105 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1106 type: boolean
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1107 name:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1108 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1109 attribute: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1110 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1111 type: array
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1112
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1113 register:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1114 type: object
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1115 description: Register with a service
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1116 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1117 namespace: jabber:iq:register
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1118 name: query
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1119 properties:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1120 nick:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1121 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1122 misc:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1123 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1124 password:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1125 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1126 date:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1127 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1128 address:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1129 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1130 key:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1131 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1132 text:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1133 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1134 url:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1135 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1136 zip:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1137 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1138 phone:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1139 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1140 last:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1141 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1142 email:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1143 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1144 remove:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1145 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1146 x_name_is_value: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1147 type: boolean
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1148 city:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1149 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1150 registered:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1151 xml:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1152 x_name_is_value: true
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1153 type: boolean
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1154 first:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1155 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1156 state:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1157 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1158 instructions:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1159 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1160 username:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1161 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1162 name:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1163 type: string
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1164 required:
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1165 - username
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1166 - password
fae4e1335593 mod_rest: Add new fields to openapi spec from mapping schema
Kim Alvefur <zash@zash.se>
parents: 4574
diff changeset
1167
4889
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1168 upload_slot:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1169 type: object
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1170 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1171 name: slot
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1172 namespace: urn:xmpp:http:upload:0
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1173 properties:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1174 put:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1175 type: object
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1176 properties:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1177 url:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1178 type: string
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1179 format: uri
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1180 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1181 attribute: true
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1182 headers:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1183 type: array
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1184 items:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1185 type: object
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1186 required:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1187 - name
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1188 - value
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1189 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1190 name: header
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1191 properties:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1192 name:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1193 type: string
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1194 enum:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1195 - Authorization
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1196 - Cookie
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1197 - Expires
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1198 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1199 attribute: true
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1200 value:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1201 type: string
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1202 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1203 text: true
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1204 get:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1205 type: object
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1206 properties:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1207 url:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1208 type: string
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1209 format: uri
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1210 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1211 attribute: true
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1212 upload_request:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1213 type: object
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1214 required:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1215 - filename
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1216 - size
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1217 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1218 name: request
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1219 namespace: urn:xmpp:http:upload:0
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1220 properties:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1221 filename:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1222 type: string
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1223 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1224 attribute: true
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1225 content-type:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1226 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1227 attribute: true
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1228 name: content-type
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1229 size:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1230 type: integer
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1231 xml:
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1232 attribute: true
52522c71ad1a mod_rest: Add XEP-0363 HTTP Upload to schemas
Kim Alvefur <zash@zash.se>
parents: 4802
diff changeset
1233
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
1234 error:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
1235 description: Description of something gone wrong. See the Stanza Errors section in RFC 6120.
4476
125279f4a5b8 mod_rest: Restructure API spec
Kim Alvefur <zash@zash.se>
parents: 4474
diff changeset
1236 type: object
4479
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1237 properties:
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1238 type:
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1239 description: General category of error
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1240 type: string
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1241 enum:
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1242 - auth
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1243 - cancel
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1244 - continue
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1245 - modify
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1246 - wait
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1247 condition:
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1248 description: Specific error condition.
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1249 type: string
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1250 # enum: [ full list available in RFC 6120 ]
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1251 code:
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1252 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
1253 type: integer
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1254 text:
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1255 description: Description of error intended for human eyes.
356b5ad521a5 mod_rest: Add schema for errors
Kim Alvefur <zash@zash.se>
parents: 4478
diff changeset
1256 type: string
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
1257
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1258 securitySchemes:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1259 token:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1260 description: Tokens from mod_http_oauth2.
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1261 scheme: Bearer
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1262 type: http
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1263 basic:
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1264 description: Use JID as username.
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1265 scheme: Basic
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1266 type: http
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
1267
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1268 requestBodies:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1269 common:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1270 required: true
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1271 content:
4497
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents: 4496
diff changeset
1272 application/json:
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents: 4496
diff changeset
1273 schema:
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents: 4496
diff changeset
1274 $ref: '#/components/schemas/stanza'
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents: 4496
diff changeset
1275 application/xmpp+xml:
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents: 4496
diff changeset
1276 schema:
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML
Kim Alvefur <zash@zash.se>
parents: 4496
diff changeset
1277 description: Single XMPP stanza in XML format.
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1278 application/x-www-form-urlencoded:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1279 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1280 description: A subset of the JSON schema, only top level string fields.
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
1281
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1282 responses:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1283 success:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1284 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
1285 content:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1286 application/json:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1287 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1288 $ref: '#/components/schemas/stanza'
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1289 application/xmpp+xml:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1290 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1291 description: Single XMPP stanza in XML format.
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1292 example: <message><body>Hello</body></message>
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1293 application/x-www-form-urlencoded:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1294 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1295 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
1296 example: body=Hello
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1297 text/plain:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1298 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1299 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
1300 example: Hello
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1301 type: string
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1302 sent:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1303 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
1304 so an empty reply.
4494
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation
Kim Alvefur <zash@zash.se>
parents: 4493
diff changeset
1305
4487
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1306 parameters:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1307 to:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1308 name: to
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1309 in: path
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1310 required: true
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1311 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1312 $ref: '#/components/schemas/to'
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1313 kind:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1314 name: kind
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1315 in: path
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1316 required: true
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1317 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1318 $ref: '#/components/schemas/kind'
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1319 type:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1320 name: type
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1321 in: path
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1322 required: true
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1323 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1324 $ref: '#/components/schemas/type'
f877a4d3770b mod_rest/openapi: Deduplicate things using references
Kim Alvefur <zash@zash.se>
parents: 4486
diff changeset
1325
4474
949db0714b5f mod_rest: Add an OpenAPI specification
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1326 ...