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