Annotate

mod_rest/openapi.yaml @ 4478:7ab0c423688a

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