annotate mod_rest/res/openapi.yaml @ 5493:cae3bb3dd45f

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