comparison mod_rest/res/openapi.yaml @ 5955:0616a6687d0c

mod_rest: Improve OpenAPI documentation for XEP-0363 GET method It was half-done
author Kim Alvefur <zash@zash.se>
date Mon, 19 Aug 2024 20:17:52 +0200
parents 12828e969a60
children
comparison
equal deleted inserted replaced
5954:e5b5a74feb91 5955:0616a6687d0c
228 $ref: '#/components/responses/success' 228 $ref: '#/components/responses/success'
229 /rest/upload_request/{to}: 229 /rest/upload_request/{to}:
230 get: 230 get:
231 tags: 231 tags:
232 - query 232 - query
233 summary: Lorem ipsum 233 summary: Request space for uploading a file to the server.
234 security: 234 security:
235 - basic: [] 235 - basic: []
236 - token: [] 236 - token: []
237 - oauth2: [] 237 - oauth2: []
238 parameters: 238 parameters:
239 - $ref: '#/components/parameters/to' 239 - $ref: '#/components/parameters/to'
240 - name: filename
241 in: query
242 required: true
243 schema:
244 type: string
245 - name: size
246 in: query
247 required: true
248 schema:
249 type: integer
250 - name: content-type
251 in: query
252 schema:
253 type: string
240 responses: 254 responses:
241 "200": 255 "200":
242 $ref: '#/components/responses/success' 256 description: Successful slot request.
257 content:
258 application/json:
259 schema:
260 type: object
261 xml:
262 name: iq
263 properties:
264 kind:
265 type: string
266 enum:
267 - iq
268 type:
269 type: string
270 enum:
271 - result
272 xml:
273 attribute: true
274 to:
275 $ref: '#/components/schemas/to'
276 from:
277 $ref: '#/components/schemas/from'
278 id:
279 $ref: '#/components/schemas/id'
280 upload_slot:
281 $ref: '#/components/schemas/upload_slot'
243 components: 282 components:
244 schemas: 283 schemas:
245 stanza: 284 stanza:
246 type: object 285 type: object
247 example: 286 example: