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