Mercurial > prosody-modules
changeset 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 | e5b5a74feb91 |
| children | 97375a78d2b5 |
| files | mod_rest/res/openapi.yaml |
| diffstat | 1 files changed, 41 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_rest/res/openapi.yaml Mon Aug 19 20:08:41 2024 +0200 +++ b/mod_rest/res/openapi.yaml Mon Aug 19 20:17:52 2024 +0200 @@ -230,16 +230,55 @@ get: tags: - query - summary: Lorem ipsum + summary: Request space for uploading a file to the server. security: - basic: [] - token: [] - oauth2: [] parameters: - $ref: '#/components/parameters/to' + - name: filename + in: query + required: true + schema: + type: string + - name: size + in: query + required: true + schema: + type: integer + - name: content-type + in: query + schema: + type: string responses: "200": - $ref: '#/components/responses/success' + description: Successful slot request. + content: + application/json: + schema: + type: object + xml: + name: iq + properties: + kind: + type: string + enum: + - iq + type: + type: string + enum: + - result + xml: + attribute: true + to: + $ref: '#/components/schemas/to' + from: + $ref: '#/components/schemas/from' + id: + $ref: '#/components/schemas/id' + upload_slot: + $ref: '#/components/schemas/upload_slot' components: schemas: stanza: