prosody-modules
4c262e5a02b5
mod_rest/openapi.yaml

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

Software / code / prosody-modules

Comparison

mod_rest/openapi.yaml @ 4497:4c262e5a02b5

mod_rest/openapi: Reorder request bodies becasue YAML Silly ordered key-value dicts, affecting how things show up in /that/ interactive documentation thing.
author Kim Alvefur <zash@zash.se>
date Thu, 04 Mar 2021 01:42:47 +0100
parent 4496:8e9bff3cde4f
child 4527:9a6aaba3d5ef
comparison
equal deleted inserted replaced
4496:8e9bff3cde4f 4497:4c262e5a02b5
1 --- 1 ---
2 openapi: 3.0.1 2 openapi: 3.0.1
3 3
4 info: 4 info:
5 title: mod_rest API 5 title: mod_rest API
6 version: 0.3.1 6 version: 0.3.2
7 description: | 7 description: |
8 API for sending and receiving stanzas, in a REST-ish fashion or by 8 API for sending and receiving stanzas, in a REST-ish fashion or by
9 responding to webhooks. Multiple formats supported, including native XML 9 responding to webhooks. Multiple formats supported, including native XML
10 and a simplified JSON mapping. 10 and a simplified JSON mapping.
11 license: 11 license:
594 594
595 requestBodies: 595 requestBodies:
596 common: 596 common:
597 required: true 597 required: true
598 content: 598 content:
599 application/json:
600 schema:
601 $ref: '#/components/schemas/stanza'
602 application/xmpp+xml:
603 schema:
604 description: Single XMPP stanza in XML format.
599 application/x-www-form-urlencoded: 605 application/x-www-form-urlencoded:
600 schema: 606 schema:
601 description: A subset of the JSON schema, only top level string fields. 607 description: A subset of the JSON schema, only top level string fields.
602 application/xmpp+xml:
603 schema:
604 description: Single XMPP stanza in XML format.
605 application/json:
606 schema:
607 $ref: '#/components/schemas/stanza'
608 608
609 responses: 609 responses:
610 success: 610 success:
611 description: The stanza was sent and returned a response. 611 description: The stanza was sent and returned a response.
612 content: 612 content: