Software /
code /
prosody-modules
Comparison
mod_rest/res/openapi.yaml @ 4570:82df1eed45d1
mod_rest: Add various XML metadata to OpenAPI spec
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Tue, 25 May 2021 16:46:46 +0200 |
parent | 4549:cce0e1ec8a74 |
child | 4571:913fcb5efc77 |
comparison
equal
deleted
inserted
replaced
4569:9cbdb60e21f2 | 4570:82df1eed45d1 |
---|---|
147 - $ref: '#/components/schemas/presence' | 147 - $ref: '#/components/schemas/presence' |
148 - $ref: '#/components/schemas/iq' | 148 - $ref: '#/components/schemas/iq' |
149 | 149 |
150 message: | 150 message: |
151 type: object | 151 type: object |
152 xml: | |
153 name: message | |
152 properties: | 154 properties: |
153 kind: | 155 kind: |
154 kind: | |
155 description: Which kind of stanza | 156 description: Which kind of stanza |
156 type: string | 157 type: string |
157 enum: | 158 enum: |
158 - message | 159 - message |
159 type: | 160 type: |
386 description: Textual status message. | 387 description: Textual status message. |
387 type: string | 388 type: string |
388 | 389 |
389 priority: | 390 priority: |
390 description: Presence priority | 391 description: Presence priority |
391 type: string | 392 type: integer |
393 maximum: 127 | |
394 minimum: -128 | |
392 | 395 |
393 state: | 396 state: |
394 description: Chat state notifications, e.g. "is typing..." | 397 description: Chat state notifications, e.g. "is typing..." |
395 type: string | 398 type: string |
399 xml: | |
400 namespace: http://jabber.org/protocol/chatstates | |
401 x_name_is_value: true | |
396 enum: | 402 enum: |
397 - active | 403 - active |
398 - inactive | 404 - inactive |
399 - gone | 405 - gone |
400 - composing | 406 - composing |
402 example: composing | 408 example: composing |
403 | 409 |
404 nick: | 410 nick: |
405 type: string | 411 type: string |
406 description: Nickname of the sender | 412 description: Nickname of the sender |
413 xml: | |
414 name: nick | |
415 namespace: http://jabber.org/protocol/nick | |
407 | 416 |
408 delay: | 417 delay: |
409 type: string | 418 type: string |
419 format: date-time | |
410 description: Timestamp of when a stanza was delayed, in ISO 8601 / XEP-0082 | 420 description: Timestamp of when a stanza was delayed, in ISO 8601 / XEP-0082 |
411 format. | 421 format. |
422 xml: | |
423 name: delay | |
424 namespace: urn:xmpp:delay | |
425 x_single_attribute: stamp | |
412 | 426 |
413 replace: | 427 replace: |
414 type: string | 428 type: string |
415 description: ID of message being replaced (e.g. for corrections) | 429 description: ID of message being replaced (e.g. for corrections) |
430 xml: | |
431 name: replace | |
432 namespace: urn:xmpp:message-correct:0 | |
433 x_single_attribute: id | |
416 | 434 |
417 join: | 435 join: |
418 description: For joining Multi-User-Chats | 436 description: For joining Multi-User-Chats |
419 type: boolean | 437 type: boolean |
420 enum: | 438 enum: |
610 type: string | 628 type: string |
611 | 629 |
612 payload: | 630 payload: |
613 description: A piece of arbitrary JSON with a type field attached | 631 description: A piece of arbitrary JSON with a type field attached |
614 type: object | 632 type: object |
633 xml: | |
634 name: payload | |
635 namespace: urn:xmpp:json-msg:0 | |
615 required: | 636 required: |
616 - datatype | 637 - datatype |
617 - data | 638 - data |
618 properties: | 639 properties: |
619 data: | 640 data: |
680 type: string | 701 type: string |
681 | 702 |
682 stats: | 703 stats: |
683 description: Statistics | 704 description: Statistics |
684 type: array | 705 type: array |
706 xml: | |
707 name: query | |
708 namespace: http://jabber.org/protocol/stats | |
709 wrapped: true | |
685 items: | 710 items: |
686 type: object | 711 type: object |
687 properties: | 712 properties: |
688 name: | 713 name: |
689 type: string | 714 type: string |
715 xml: | |
716 attribute: true | |
690 unit: | 717 unit: |
691 type: string | 718 type: string |
719 xml: | |
720 attribute: true | |
692 value: | 721 value: |
693 type: string | 722 type: string |
723 xml: | |
724 attribute: true | |
694 | 725 |
695 error: | 726 error: |
696 description: Description of something gone wrong. See the Stanza Errors section in RFC 6120. | 727 description: Description of something gone wrong. See the Stanza Errors section in RFC 6120. |
697 type: object | 728 type: object |
698 properties: | 729 properties: |