Mercurial > prosody-modules

comparison mod_rest/res/openapi.yaml @ 4548:c50fac0f3cbf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Fix type of response status codes in openapi spec https://spec.openapis.org/oas/v3.0.1#responsesObject > This field MUST be enclosed in quotation marks for compatibility > between JSON and YAML.
author Kim Alvefur <zash@zash.se>
date Sun, 25 Apr 2021 16:45:06 +0200
parents a9e997d5eb94
children cce0e1ec8a74
comparison
equal deleted inserted replaced
4547:a9e997d5eb94 4548:c50fac0f3cbf
22 - basic: [] 22 - basic: []
23 - token: [] 23 - token: []
24 requestBody: 24 requestBody:
25 $ref: '#/components/requestBodies/common' 25 $ref: '#/components/requestBodies/common'
26 responses: 26 responses:
27 200: 27 '200':
28 $ref: '#/components/responses/success' 28 $ref: '#/components/responses/success'
29 202: 29 '202':
30 $ref: '#/components/responses/sent' 30 $ref: '#/components/responses/sent'
31 31
32 /rest/{kind}/{type}/{to}: 32 /rest/{kind}/{type}/{to}:
33 post: 33 post:
34 summary: Even more RESTful mapping with certain components in the path. 34 summary: Even more RESTful mapping with certain components in the path.
42 - $ref: '#/components/parameters/type' 42 - $ref: '#/components/parameters/type'
43 - $ref: '#/components/parameters/to' 43 - $ref: '#/components/parameters/to'
44 requestBody: 44 requestBody:
45 $ref: '#/components/requestBodies/common' 45 $ref: '#/components/requestBodies/common'
46 responses: 46 responses:
47 200: 47 '200':
48 $ref: '#/components/responses/success' 48 $ref: '#/components/responses/success'
49 49
50 /rest/echo: 50 /rest/echo:
51 post: 51 post:
52 summary: Build as stanza and return it for inspection. 52 summary: Build as stanza and return it for inspection.
56 - basic: [] 56 - basic: []
57 - token: [] 57 - token: []
58 requestBody: 58 requestBody:
59 $ref: '#/components/requestBodies/common' 59 $ref: '#/components/requestBodies/common'
60 responses: 60 responses:
61 200: 61 '200':
62 $ref: '#/components/responses/success' 62 $ref: '#/components/responses/success'
63 63
64 /rest/ping/{to}: 64 /rest/ping/{to}:
65 get: 65 get:
66 tags: 66 tags:
70 - basic: [] 70 - basic: []
71 - token: [] 71 - token: []
72 parameters: 72 parameters:
73 - $ref: '#/components/parameters/to' 73 - $ref: '#/components/parameters/to'
74 responses: 74 responses:
75 200: 75 '200':
76 description: Test reachability of some address 76 description: Test reachability of some address
77 content: 77 content:
78 application/json: 78 application/json:
79 schema: 79 schema:
80 $ref: '#/components/schemas/iq_pong' 80 $ref: '#/components/schemas/iq_pong'
92 - basic: [] 92 - basic: []
93 - token: [] 93 - token: []
94 parameters: 94 parameters:
95 - $ref: '#/components/parameters/to' 95 - $ref: '#/components/parameters/to'
96 responses: 96 responses:
97 200: 97 '200':
98 description: Version query response 98 description: Version query response
99 content: 99 content:
100 application/json: 100 application/json:
101 schema: 101 schema:
102 $ref: '#/components/schemas/iq_result_version' 102 $ref: '#/components/schemas/iq_result_version'
113 - basic: [] 113 - basic: []
114 - token: [] 114 - token: []
115 parameters: 115 parameters:
116 - $ref: '#/components/parameters/to' 116 - $ref: '#/components/parameters/to'
117 responses: 117 responses:
118 200: 118 '200':
119 $ref: '#/components/responses/success' 119 $ref: '#/components/responses/success'
120 120
121 /rest/items/{to}: 121 /rest/items/{to}:
122 get: 122 get:
123 tags: 123 tags:
127 - basic: [] 127 - basic: []
128 - token: [] 128 - token: []
129 parameters: 129 parameters:
130 - $ref: '#/components/parameters/to' 130 - $ref: '#/components/parameters/to'
131 responses: 131 responses:
132 200: 132 '200':
133 $ref: '#/components/responses/success' 133 $ref: '#/components/responses/success'
134 134
135 components: 135 components:
136 schemas: 136 schemas:
137 stanza: 137 stanza: