Comparison

mod_rest/openapi.yaml @ 4479:356b5ad521a5

mod_rest: Add schema for errors I forget, are these util.error objects in the json mapping?
author Kim Alvefur <zash@zash.se>
date Sun, 28 Feb 2021 20:47:32 +0100
parent 4478:7ab0c423688a
child 4486:4f41678ba00d
comparison
equal deleted inserted replaced
4478:7ab0c423688a 4479:356b5ad521a5
248 $ref: '#/components/schemas/formdata' 248 $ref: '#/components/schemas/formdata'
249 thread: 249 thread:
250 $ref: '#/components/schemas/thread' 250 $ref: '#/components/schemas/thread'
251 command: 251 command:
252 $ref: '#/components/schemas/command' 252 $ref: '#/components/schemas/command'
253 error:
254 $ref: '#/components/schemas/error'
253 type: object 255 type: object
254 example: 256 example:
255 body: Hello 257 body: Hello
256 type: chat 258 type: chat
257 kind: message 259 kind: message
539 enum: 541 enum:
540 - true 542 - true
541 nick: 543 nick:
542 type: string 544 type: string
543 description: Nickname of the sender 545 description: Nickname of the sender
546 error:
547 type: object
548 description: Description of something gone wrong. See the Stanza Errors section in RFC 6120.
549 properties:
550 type:
551 description: General category of error
552 type: string
553 enum:
554 - auth
555 - cancel
556 - continue
557 - modify
558 - wait
559 condition:
560 description: Specific error condition.
561 type: string
562 # enum: [ full list available in RFC 6120 ]
563 code:
564 description: Legacy numeric error code. Similar to HTTP status codes.
565 type: integer
566 text:
567 description: Description of error intended for human eyes.
568 type: string
544 securitySchemes: 569 securitySchemes:
545 token: 570 token:
546 description: Tokens from mod_http_oauth2. 571 description: Tokens from mod_http_oauth2.
547 scheme: Bearer 572 scheme: Bearer
548 type: http 573 type: http