prosody-modules: mod_rest/res/openapi.yaml annotate

annotate mod_rest/res/openapi.yaml @ 4549:cce0e1ec8a74

mod_rest: Add XEP-0249: Direct MUC Invitations to schemas

author	Kim Alvefur <zash@zash.se>
date	Sun, 25 Apr 2021 16:53:08 +0200
parents	c50fac0f3cbf
children	82df1eed45d1

rev	line source
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	1 ---
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	2 openapi: 3.0.1
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	3
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	4 info:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	5 title: mod_rest API
4497 4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML Kim Alvefur <zash@zash.se> parents: 4496 diff changeset	6 version: 0.3.2
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	7 description: \|
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	8 API for sending and receiving stanzas, in a REST-ish fashion or by
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	9 responding to webhooks. Multiple formats supported, including native XML
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	10 and a simplified JSON mapping.
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	11 license:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	12 name: MIT
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	13
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	14 paths:
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	15
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	16 /rest:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	17 post:
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	18 summary: Send stanzas and receive responses. Webhooks work the same way.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	19 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	20 - generic
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	21 security:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	22 - basic: []
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	23 - token: []
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	24 requestBody:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	25 $ref: '#/components/requestBodies/common'
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	26 responses:
4548 c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec Kim Alvefur <zash@zash.se> parents: 4547 diff changeset	27 '200':
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	28 $ref: '#/components/responses/success'
4548 c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec Kim Alvefur <zash@zash.se> parents: 4547 diff changeset	29 '202':
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	30 $ref: '#/components/responses/sent'
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	31
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	32 /rest/{kind}/{type}/{to}:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	33 post:
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	34 summary: Even more RESTful mapping with certain components in the path.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	35 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	36 - generic
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	37 security:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	38 - basic: []
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	39 - token: []
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	40 parameters:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	41 - $ref: '#/components/parameters/kind'
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	42 - $ref: '#/components/parameters/type'
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	43 - $ref: '#/components/parameters/to'
4496 8e9bff3cde4f mod_rest/openapi: Add missing body for POST /kind/type/to query Kim Alvefur <zash@zash.se> parents: 4495 diff changeset	44 requestBody:
8e9bff3cde4f mod_rest/openapi: Add missing body for POST /kind/type/to query Kim Alvefur <zash@zash.se> parents: 4495 diff changeset	45 $ref: '#/components/requestBodies/common'
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	46 responses:
4548 c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec Kim Alvefur <zash@zash.se> parents: 4547 diff changeset	47 '200':
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	48 $ref: '#/components/responses/success'
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	49
4529 c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	50 /rest/echo:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	51 post:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	52 summary: Build as stanza and return it for inspection.
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	53 tags:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	54 - debug
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	55 security:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	56 - basic: []
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	57 - token: []
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	58 requestBody:
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	59 $ref: '#/components/requestBodies/common'
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	60 responses:
4548 c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec Kim Alvefur <zash@zash.se> parents: 4547 diff changeset	61 '200':
4529 c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	62 $ref: '#/components/responses/success'
c6d44e1fb4d9 mod_rest: Document the /echo endpoint in the openapi spec Kim Alvefur <zash@zash.se> parents: 4528 diff changeset	63
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	64 /rest/ping/{to}:
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	65 get:
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	66 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	67 - query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	68 summary: Ping a local or remote server or other entity
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	69 security:
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	70 - basic: []
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	71 - token: []
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	72 parameters:
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	73 - $ref: '#/components/parameters/to'
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	74 responses:
4548 c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec Kim Alvefur <zash@zash.se> parents: 4547 diff changeset	75 '200':
4495 cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	76 description: Test reachability of some address
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	77 content:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	78 application/json:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	79 schema:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	80 $ref: '#/components/schemas/iq_pong'
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	81 application/xmpp+xml:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	82 schema:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	83 $ref: '#/components/schemas/iq_pong'
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	84
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	85
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	86 /rest/version/{to}:
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	87 get:
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	88 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	89 - query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	90 summary: Ask what software version is used.
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	91 security:
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	92 - basic: []
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	93 - token: []
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	94 parameters:
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	95 - $ref: '#/components/parameters/to'
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	96 responses:
4548 c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec Kim Alvefur <zash@zash.se> parents: 4547 diff changeset	97 '200':
4493 89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail Kim Alvefur <zash@zash.se> parents: 4492 diff changeset	98 description: Version query response
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail Kim Alvefur <zash@zash.se> parents: 4492 diff changeset	99 content:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail Kim Alvefur <zash@zash.se> parents: 4492 diff changeset	100 application/json:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail Kim Alvefur <zash@zash.se> parents: 4492 diff changeset	101 schema:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail Kim Alvefur <zash@zash.se> parents: 4492 diff changeset	102 $ref: '#/components/schemas/iq_result_version'
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail Kim Alvefur <zash@zash.se> parents: 4492 diff changeset	103 application/xmpp+xml:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail Kim Alvefur <zash@zash.se> parents: 4492 diff changeset	104 schema:
89571a20196f mod_rest/openapi: Describe 'version' endpoint in more detail Kim Alvefur <zash@zash.se> parents: 4492 diff changeset	105 $ref: '#/components/schemas/iq_result_version'
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	106
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	107 /rest/disco/{to}:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	108 get:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	109 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	110 - query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	111 summary: Query a remote entity for supported features
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	112 security:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	113 - basic: []
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	114 - token: []
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	115 parameters:
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	116 - $ref: '#/components/parameters/to'
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	117 responses:
4548 c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec Kim Alvefur <zash@zash.se> parents: 4547 diff changeset	118 '200':
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	119 $ref: '#/components/responses/success'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	120
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	121 /rest/items/{to}:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	122 get:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	123 tags:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	124 - query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	125 summary: Query an entity for related services, chat rooms or other items
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	126 security:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	127 - basic: []
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	128 - token: []
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	129 parameters:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	130 - $ref: '#/components/parameters/to'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	131 responses:
4548 c50fac0f3cbf mod_rest: Fix type of response status codes in openapi spec Kim Alvefur <zash@zash.se> parents: 4547 diff changeset	132 '200':
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	133 $ref: '#/components/responses/success'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	134
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	135 components:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	136 schemas:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	137 stanza:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	138 type: object
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	139 example:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	140 body: Hello
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	141 type: chat
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	142 kind: message
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	143 to: alice@example.com
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	144 state: active
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	145 oneOf:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	146 - $ref: '#/components/schemas/message'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	147 - $ref: '#/components/schemas/presence'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	148 - $ref: '#/components/schemas/iq'
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	149
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	150 message:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	151 type: object
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	152 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	153 kind:
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	154 kind:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	155 description: Which kind of stanza
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	156 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	157 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	158 - message
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	159 type:
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	160 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	161 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	162 - chat
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	163 - error
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	164 - groupchat
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	165 - headline
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	166 - normal
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	167 to:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	168 $ref: '#/components/schemas/to'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	169 from:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	170 $ref: '#/components/schemas/from'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	171 id:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	172 $ref: '#/components/schemas/id'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	173 lang:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	174 $ref: '#/components/schemas/lang'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	175
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	176 body:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	177 $ref: '#/components/schemas/body'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	178 subject:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	179 $ref: '#/components/schemas/subject'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	180 thread:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	181 $ref: '#/components/schemas/thread'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	182
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	183 state:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	184 $ref: '#/components/schemas/state'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	185 nick:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	186 $ref: '#/components/schemas/nick'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	187 delay:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	188 $ref: '#/components/schemas/delay'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	189 replace:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	190 $ref: '#/components/schemas/replace'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	191
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	192 html:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	193 $ref: '#/components/schemas/html'
4547 a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	194 oob:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	195 $ref: '#/components/schemas/oob'
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	196
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	197 error:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	198 $ref: '#/components/schemas/error'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	199
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	200 presence:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	201 type: object
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	202 properties:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	203 kind:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	204 kind:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	205 description: Which kind of stanza
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	206 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	207 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	208 - presence
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	209 type:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	210 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	211 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	212 - available
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	213 - unavailable
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	214 - subscribe
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	215 - subscribed
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	216 - unsubscribe
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	217 - unsubscribed
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	218 - error
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	219 to:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	220 $ref: '#/components/schemas/to'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	221 from:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	222 $ref: '#/components/schemas/from'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	223 id:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	224 $ref: '#/components/schemas/id'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	225 lang:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	226 $ref: '#/components/schemas/lang'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	227
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	228 show:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	229 $ref: '#/components/schemas/show'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	230 status:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	231 $ref: '#/components/schemas/status'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	232 priority:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	233 $ref: '#/components/schemas/priority'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	234
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	235 nick:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	236 $ref: '#/components/schemas/nick'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	237 delay:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	238 $ref: '#/components/schemas/delay'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	239
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	240 join:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	241 $ref: '#/components/schemas/join'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	242
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	243 error:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	244 $ref: '#/components/schemas/error'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	245
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	246 iq:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	247 type: object
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	248 properties:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	249 kind:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	250 description: Which kind of stanza
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	251 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	252 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	253 - iq
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	254 type:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	255 type: string
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	256 enum:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	257 - get
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	258 - set
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	259 - result
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	260 - error
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	261 to:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	262 $ref: '#/components/schemas/to'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	263 from:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	264 $ref: '#/components/schemas/from'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	265 id:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	266 $ref: '#/components/schemas/id'
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	267 lang:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	268 $ref: '#/components/schemas/lang'
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	269
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	270 ping:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	271 $ref: '#/components/schemas/ping'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	272 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	273 $ref: '#/components/schemas/version'
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	274 disco:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	275 $ref: '#/components/schemas/disco'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	276 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	277 $ref: '#/components/schemas/items'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	278 command:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	279 $ref: '#/components/schemas/command'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	280
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	281 stats:
cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	282 $ref: '#/components/schemas/stats'
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	283 payload:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	284 $ref: '#/components/schemas/payload'
4546 cfe196f88e96 mod_rest: Reorganise openapi spec to group stanza types Kim Alvefur <zash@zash.se> parents: 4529 diff changeset	285
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	286 error:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	287 $ref: '#/components/schemas/error'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	288
4495 cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	289 iq_pong:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	290 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	291 type: object
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	292 xml:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	293 name: iq
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	294 properties:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	295 type:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	296 type: string
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	297 enum:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	298 - result
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	299 xml:
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	300 attribute: true
cdc530ec76d6 mod_rest/openapi: Improve ping (XEP-0199) representation Kim Alvefur <zash@zash.se> parents: 4494 diff changeset	301
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	302 iq_result_version:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	303 description: Version query response
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	304 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	305 xml:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	306 name: iq
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	307 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	308 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	309 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	310 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	311 - result
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	312 xml:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	313 attribute: true
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	314 version:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	315 $ref: '#/components/schemas/version'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	316
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	317 kind:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	318 description: Which kind of stanza
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	319 type: string
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	320 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	321 - message
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	322 - presence
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	323 - iq
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	324
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	325 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	326 description: Stanza type
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	327 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	328 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	329 - chat
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	330 - normal
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	331 - headline
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	332 - groupchat
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	333 - get
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	334 - set
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	335 - result
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	336 - available
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	337 - unavailable
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	338 - subscribe
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	339 - subscribed
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	340 - unsubscribe
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	341 - unsubscribed
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	342
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	343 to:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	344 description: recipient
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	345 example: alice@example.com
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	346 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	347
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	348 from:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	349 description: the sender
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	350 example: bob@localhost.example
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	351 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	352
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	353 id:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	354 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	355 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	356
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	357 lang:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	358 description: Language code
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	359 example: en
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	360 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	361
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	362 body:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	363 description: Human-readable chat message
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	364 example: Hello, World!
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	365 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	366
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	367 subject:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	368 description: Subject of message or group chat
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	369 example: Talking about stuff
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	370 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	371
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	372 thread:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	373 description: Message thread identifier
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	374 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	375
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	376 show:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	377 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	378 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	379 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	380 - away
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	381 - chat
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	382 - dnd
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	383 - xa
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	384
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	385 status:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	386 description: Textual status message.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	387 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	388
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	389 priority:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	390 description: Presence priority
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	391 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	392
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	393 state:
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	394 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	395 type: string
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	396 enum:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	397 - active
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	398 - inactive
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	399 - gone
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	400 - composing
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	401 - paused
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	402 example: composing
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	403
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	404 nick:
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	405 type: string
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	406 description: Nickname of the sender
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	407
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	408 delay:
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	409 type: string
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	410 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	411 format.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	412
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	413 replace:
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 description: ID of message being replaced (e.g. for corrections)
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	416
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	417 join:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	418 description: For joining Multi-User-Chats
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	419 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	420 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	421 - true
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	422
4549 cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	423 invite:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	424 type: object
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	425 description: Invite to a group chat
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	426 required:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	427 - jid
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	428 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	429 name: x
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	430 namespace: jabber:x:conference
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	431 properties:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	432 jid:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	433 type: string
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	434 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	435 format: xmpp-jid
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	436 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	437 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	438 reason:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	439 type: string
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	440 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	441 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	442 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	443 password:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	444 type: string
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	445 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	446 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	447 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	448 thread:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	449 type: string
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	450 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	451 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	452 continue:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	453 type: boolean
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	454 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	455 xml:
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	456 attribute: true
cce0e1ec8a74 mod_rest: Add XEP-0249: Direct MUC Invitations to schemas Kim Alvefur <zash@zash.se> parents: 4548 diff changeset	457
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	458 html:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	459 description: HTML version of 'body'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	460 example: <body><p>Hello!</p></body>
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	461 type: string
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	462
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	463 ping:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	464 description: A ping.
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	465 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	466 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	467 - true
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	468 xml:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	469 name: ping
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	470 namespace: urn:xmpp:ping
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	471
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	472 version:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	473 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	474 description: Software version query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	475 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	476 name:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	477 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	478 example: My Software
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	479 version:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	480 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	481 example: 1.0.0
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	482 os:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	483 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	484 example: Linux
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	485 required:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	486 - name
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	487 - version
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	488 xml:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	489 name: query
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	490 namespace: jabber:iq:version
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	491
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	492 disco:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	493 description: Discover supported features
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	494 oneOf:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	495 - description: A full response
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	496 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	497 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	498 features:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	499 description: List of URIs indicating supported features
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	500 type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	501 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	502 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	503 identities:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	504 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	505 entity
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	506 type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	507 example:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	508 - name: Prosody
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	509 type: im
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	510 category: server
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	511 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	512 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	513 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	514 name:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	515 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	516 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	517 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	518 category:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	519 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	520 node:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	521 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	522 extensions:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	523 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	524 - 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	525 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	526 - 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	527 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	528
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	529 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	530 description: List of references to other entities
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	531 oneOf:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	532 - description: List of items referenced
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	533 type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	534 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	535 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	536 jid:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	537 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	538 description: Address of item
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	539 node:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	540 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	541 name:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	542 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	543 description: Descriptive name
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	544 required:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	545 - jid
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	546 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	547 - type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	548 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	549 - description: An items query or empty list
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	550 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	551 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	552 - true
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	553
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	554 command:
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	555 description: Ad-hoc commands.
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	556 oneOf:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	557 - type: object
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	558 properties:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	559 data:
4486 4f41678ba00d mod_rest/openapi: Fix dataform references Kim Alvefur <zash@zash.se> parents: 4479 diff changeset	560 $ref: '#/components/schemas/formdata'
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	561 action:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	562 type: string
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	563 note:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	564 type: object
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	565 properties:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	566 text:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	567 type: string
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	568 type:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	569 type: string
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	570 enum:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	571 - info
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	572 - warn
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	573 - error
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	574 form:
4486 4f41678ba00d mod_rest/openapi: Fix dataform references Kim Alvefur <zash@zash.se> parents: 4479 diff changeset	575 $ref: '#/components/schemas/dataform'
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	576 sessionid:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	577 type: string
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	578 status:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	579 type: string
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	580 node:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	581 type: string
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	582 actions:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	583 type: object
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	584 properties:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	585 complete:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	586 type: boolean
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	587 prev:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	588 type: boolean
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	589 next:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	590 type: boolean
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	591 execute:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	592 type: string
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	593 - type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	594 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	595
4547 a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	596 oob:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	597 type: object
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	598 description: Reference a media file
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	599 xml:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	600 name: x
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	601 namespace: jabber:x:oob
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	602 properties:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	603 url:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	604 type: string
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	605 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	606 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	607 format: uri
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	608 desc:
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	609 description: Optional description
a9e997d5eb94 mod_rest: Replace 'oob_url' with datamapper-native 'oob' Kim Alvefur <zash@zash.se> parents: 4546 diff changeset	610 type: string
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	611
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	612 payload:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	613 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	614 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	615 required:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	616 - datatype
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	617 - data
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	618 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	619 data:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	620 example: '{"some":"json"}'
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	621 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	622 datatype:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	623 example: urn:example:my-json#payload
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	624 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	625
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	626 dataform:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	627 description: Data form
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	628 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	629 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	630 title:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	631 description: Title of the form
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	632 example: TPS Report
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	633 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	634 fields:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	635 type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	636 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	637 description: Form field
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	638 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	639 properties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	640 value:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	641 description: Field value
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	642 oneOf:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	643 - type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	644 - type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	645 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	646 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	647 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	648 description: Type of form field
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	649 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	650 label:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	651 description: Descriptive label for the field
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	652 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	653 desc:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	654 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	655 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	656 required:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	657 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	658 type: boolean
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	659 var:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	660 description: Internal name of the field
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	661 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	662 type:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	663 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	664 enum:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	665 - form
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	666 - submit
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	667 - cancel
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	668 - result
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	669 instructions:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	670 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	671
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	672 formdata:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	673 description: Simplified data form carrying only values
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	674 type: object
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	675 additionalProperties:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	676 oneOf:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	677 - type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	678 - type: array
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	679 items:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	680 type: string
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	681
4476 125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	682 stats:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	683 description: Statistics
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	684 type: array
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	685 items:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	686 type: object
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	687 properties:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	688 name:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	689 type: string
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	690 unit:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	691 type: string
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	692 value:
125279f4a5b8 mod_rest: Restructure API spec Kim Alvefur <zash@zash.se> parents: 4474 diff changeset	693 type: string
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	694
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	695 error:
aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	696 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	697 type: object
4479 356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	698 properties:
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	699 type:
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	700 description: General category of error
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	701 type: string
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	702 enum:
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	703 - auth
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	704 - cancel
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	705 - continue
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	706 - modify
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	707 - wait
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	708 condition:
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	709 description: Specific error condition.
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	710 type: string
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	711 # enum: [ full list available in RFC 6120 ]
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	712 code:
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	713 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	714 type: integer
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	715 text:
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	716 description: Description of error intended for human eyes.
356b5ad521a5 mod_rest: Add schema for errors Kim Alvefur <zash@zash.se> parents: 4478 diff changeset	717 type: string
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	718
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	719 securitySchemes:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	720 token:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	721 description: Tokens from mod_http_oauth2.
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	722 scheme: Bearer
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	723 type: http
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	724 basic:
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	725 description: Use JID as username.
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	726 scheme: Basic
949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	727 type: http
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	728
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	729 requestBodies:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	730 common:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	731 required: true
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	732 content:
4497 4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML Kim Alvefur <zash@zash.se> parents: 4496 diff changeset	733 application/json:
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML Kim Alvefur <zash@zash.se> parents: 4496 diff changeset	734 schema:
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML Kim Alvefur <zash@zash.se> parents: 4496 diff changeset	735 $ref: '#/components/schemas/stanza'
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML Kim Alvefur <zash@zash.se> parents: 4496 diff changeset	736 application/xmpp+xml:
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML Kim Alvefur <zash@zash.se> parents: 4496 diff changeset	737 schema:
4c262e5a02b5 mod_rest/openapi: Reorder request bodies becasue YAML Kim Alvefur <zash@zash.se> parents: 4496 diff changeset	738 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	739 application/x-www-form-urlencoded:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	740 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	741 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	742
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	743 responses:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	744 success:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	745 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	746 content:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	747 application/json:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	748 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	749 $ref: '#/components/schemas/stanza'
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	750 application/xmpp+xml:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	751 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	752 description: Single XMPP stanza in XML format.
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	753 example: <message><body>Hello</body></message>
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	754 application/x-www-form-urlencoded:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	755 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	756 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	757 example: body=Hello
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	758 text/plain:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	759 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	760 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	761 example: Hello
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	762 type: string
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	763 sent:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	764 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	765 so an empty reply.
4494 aa4dcd4b39c8 mod_rest/openapi: Improve organization and navigation Kim Alvefur <zash@zash.se> parents: 4493 diff changeset	766
4487 f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	767 parameters:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	768 to:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	769 name: to
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	770 in: path
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	771 required: true
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	772 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	773 $ref: '#/components/schemas/to'
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	774 kind:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	775 name: kind
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	776 in: path
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	777 required: true
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	778 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	779 $ref: '#/components/schemas/kind'
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	780 type:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	781 name: type
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	782 in: path
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	783 required: true
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	784 schema:
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	785 $ref: '#/components/schemas/type'
f877a4d3770b mod_rest/openapi: Deduplicate things using references Kim Alvefur <zash@zash.se> parents: 4486 diff changeset	786
4474 949db0714b5f mod_rest: Add an OpenAPI specification Kim Alvefur <zash@zash.se> parents: diff changeset	787 ...

Mercurial > prosody-modules

annotate mod_rest/res/openapi.yaml @ 4549:cce0e1ec8a74