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