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