Mercurial > prosody-modules

comparison mod_rest/res/openapi.yaml @ 4729:fae4e1335593

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Add new fields to openapi spec from mapping schema
author Kim Alvefur <zash@zash.se>
date Wed, 27 Oct 2021 14:07:07 +0200
parents 38d80dbfee88
children 1e2f53fb2099
comparison
equal deleted inserted replaced
4728:1c6d353550cc 4729:fae4e1335593
163 - chat 163 - chat
164 - error 164 - error
165 - groupchat 165 - groupchat
166 - headline 166 - headline
167 - normal 167 - normal
168 xml:
169 attribute: true
170
168 to: 171 to:
169 $ref: '#/components/schemas/to' 172 $ref: '#/components/schemas/to'
170 from: 173 from:
171 $ref: '#/components/schemas/from' 174 $ref: '#/components/schemas/from'
172 id: 175 id:
192 195
193 html: 196 html:
194 $ref: '#/components/schemas/html' 197 $ref: '#/components/schemas/html'
195 oob: 198 oob:
196 $ref: '#/components/schemas/oob' 199 $ref: '#/components/schemas/oob'
200 reactions:
201 $ref: '#/components/schemas/reactions'
202 occupant_id:
203 $ref: '#/components/schemas/occupant_id'
204 attach_to:
205 $ref: '#/components/schemas/attach_to'
206 fallback:
207 $ref: '#/components/schemas/fallback'
208 stanza_ids:
209 $ref: '#/components/schemas/stanza_ids'
210 reference:
211 $ref: '#/components/schemas/reference'
212 markable:
213 $ref: '#/components/schemas/markable'
214 displayed:
215 $ref: '#/components/schemas/displayed'
197 216
198 error: 217 error:
199 $ref: '#/components/schemas/error' 218 $ref: '#/components/schemas/error'
200 219
201 presence: 220 presence:
215 - subscribe 234 - subscribe
216 - subscribed 235 - subscribed
217 - unsubscribe 236 - unsubscribe
218 - unsubscribed 237 - unsubscribed
219 - error 238 - error
239 xml:
240 attribute: true
220 to: 241 to:
221 $ref: '#/components/schemas/to' 242 $ref: '#/components/schemas/to'
222 from: 243 from:
223 $ref: '#/components/schemas/from' 244 $ref: '#/components/schemas/from'
224 id: 245 id:
239 $ref: '#/components/schemas/nick' 260 $ref: '#/components/schemas/nick'
240 delay: 261 delay:
241 $ref: '#/components/schemas/delay' 262 $ref: '#/components/schemas/delay'
242 vcard_update: 263 vcard_update:
243 $ref: '#/components/schemas/vcard_update' 264 $ref: '#/components/schemas/vcard_update'
265 idle_since:
266 $ref: '#/components/schemas/idle_since'
244 267
245 join: 268 join:
246 $ref: '#/components/schemas/join' 269 $ref: '#/components/schemas/join'
247 270
248 error: 271 error:
261 enum: 284 enum:
262 - get 285 - get
263 - set 286 - set
264 - result 287 - result
265 - error 288 - error
289 xml:
290 attribute: true
266 to: 291 to:
267 $ref: '#/components/schemas/to' 292 $ref: '#/components/schemas/to'
268 from: 293 from:
269 $ref: '#/components/schemas/from' 294 $ref: '#/components/schemas/from'
270 id: 295 id:
287 312
288 stats: 313 stats:
289 $ref: '#/components/schemas/stats' 314 $ref: '#/components/schemas/stats'
290 payload: 315 payload:
291 $ref: '#/components/schemas/payload' 316 $ref: '#/components/schemas/payload'
317 gateway:
318 $ref: '#/components/schemas/gateway'
319 register:
320 $ref: '#/components/schemas/register'
321 extdisco:
322 $ref: '#/components/schemas/extdisco'
292 323
293 error: 324 error:
294 $ref: '#/components/schemas/error' 325 $ref: '#/components/schemas/error'
295 326
296 iq_pong: 327 iq_pong:
344 - unavailable 375 - unavailable
345 - subscribe 376 - subscribe
346 - subscribed 377 - subscribed
347 - unsubscribe 378 - unsubscribe
348 - unsubscribed 379 - unsubscribed
380 xml:
381 attribute: true
349 382
350 to: 383 to:
351 description: recipient 384 description: recipient
352 example: alice@example.com 385 example: alice@example.com
353 type: string 386 type: string
387 xml:
388 attribute: true
354 389
355 from: 390 from:
356 description: the sender 391 description: the sender
357 example: bob@localhost.example 392 example: bob@localhost.example
358 type: string 393 type: string
394 xml:
395 attribute: true
359 396
360 id: 397 id:
361 description: Reasonably unique id. mod_rest generates one if left out. 398 description: Reasonably unique id. mod_rest generates one if left out.
362 type: string 399 type: string
400 xml:
401 attribute: true
363 402
364 lang: 403 lang:
365 description: Language code 404 description: Language code
366 example: en 405 example: en
406 xml:
407 prefix: xml
408 attribute: true
367 type: string 409 type: string
368 410
369 body: 411 body:
370 description: Human-readable chat message 412 description: Human-readable chat message
371 example: Hello, World! 413 example: Hello, World!
784 properties: 826 properties:
785 photo: 827 photo:
786 type: string 828 type: string
787 example: adc83b19e793491b1c6ea0fd8b46cd9f32e592fc 829 example: adc83b19e793491b1c6ea0fd8b46cd9f32e592fc
788 830
831 reactions:
832 type: object
833 xml:
834 namespace: urn:xmpp:reactions:0
835 properties:
836 id:
837 type: string
838 xml:
839 attribute: true
840 reactions:
841 type: array
842 items:
843 xml:
844 name: reaction
845 type: string
846 xml:
847 wrapped: false
848 name: reactions
849
850 occupant_id:
851 type: string
852 xml:
853 namespace: urn:xmpp:occupant-id:0
854 x_single_attribute: id
855 name: occupant-id
856
857 attach_to:
858 type: string
859 xml:
860 namespace: urn:xmpp:message-attaching:1
861 x_single_attribute: id
862 name: attach-to
863
864 fallback:
865 type: boolean
866 xml:
867 namespace: urn:xmpp:fallback:0
868 x_name_is_value: true
869 name: fallback
870
871 stanza_ids:
872 type: array
873 items:
874 type: object
875 required:
876 - id
877 - by
878 xml:
879 namespace: urn:xmpp:sid:0
880 name: stanza-id
881 properties:
882 id:
883 xml:
884 attribute: true
885 type: string
886 by:
887 xml:
888 attribute: true
889 format: xmpp-jid
890 type: string
891
892 reference:
893 type: object
894 xml:
895 namespace: urn:xmpp:reference:0
896 properties:
897 end:
898 minimum: 0
899 xml:
900 attribute: true
901 type: integer
902 uri:
903 xml:
904 attribute: true
905 format: uri
906 type: string
907 begin:
908 minimum: 0
909 xml:
910 attribute: true
911 type: integer
912 type:
913 xml:
914 attribute: true
915 type: string
916 required:
917 - type
918 - uri
919
920 markable:
921 type: boolean
922 xml:
923 namespace: urn:xmpp:chat-markers:0
924 x_name_is_value: true
925
926 displayed:
927 type: string
928 description: Message ID of a message that has been displayed
929 xml:
930 namespace: urn:xmpp:chat-markers:0
931
932 idle_since:
933 type: string
934 xml:
935 namespace: urn:xmpp:idle:1
936 x_single_attribute: since
937 name: idle
938 format: date-time
939
940 gateway:
941 type: object
942 xml:
943 namespace: jabber:iq:gateway
944 name: query
945 properties:
946 desc:
947 type: text
948 prompt:
949 type: string
950 jid:
951 type: string
952
953 extdisco:
954 type: object
955 xml:
956 namespace: urn:xmpp:extdisco:2
957 name: services
958 properties:
959 type:
960 xml:
961 attribute: true
962 type: string
963 services:
964 items:
965 type: object
966 xml:
967 name: service
968 properties:
969 transport:
970 xml:
971 attribute: true
972 type: string
973 type:
974 required: true
975 xml:
976 attribute: true
977 type: string
978 port:
979 xml:
980 attribute: true
981 type: integer
982 host:
983 required: true
984 xml:
985 attribute: true
986 type: string
987 expires:
988 xml:
989 attribute: true
990 format: datetime
991 type: string
992 username:
993 xml:
994 attribute: true
995 type: string
996 password:
997 xml:
998 attribute: true
999 type: string
1000 restricted:
1001 xml:
1002 attribute: true
1003 type: boolean
1004 name:
1005 xml:
1006 attribute: true
1007 type: string
1008 type: array
1009
1010 register:
1011 type: object
1012 description: Register with a service
1013 xml:
1014 namespace: jabber:iq:register
1015 name: query
1016 properties:
1017 nick:
1018 type: string
1019 misc:
1020 type: string
1021 password:
1022 type: string
1023 date:
1024 type: string
1025 address:
1026 type: string
1027 key:
1028 type: string
1029 text:
1030 type: string
1031 url:
1032 type: string
1033 zip:
1034 type: string
1035 phone:
1036 type: string
1037 last:
1038 type: string
1039 email:
1040 type: string
1041 remove:
1042 xml:
1043 x_name_is_value: true
1044 type: boolean
1045 city:
1046 type: string
1047 registered:
1048 xml:
1049 x_name_is_value: true
1050 type: boolean
1051 first:
1052 type: string
1053 state:
1054 type: string
1055 instructions:
1056 type: string
1057 username:
1058 type: string
1059 name:
1060 type: string
1061 required:
1062 - username
1063 - password
1064
789 error: 1065 error:
790 description: Description of something gone wrong. See the Stanza Errors section in RFC 6120. 1066 description: Description of something gone wrong. See the Stanza Errors section in RFC 6120.
791 type: object 1067 type: object
792 properties: 1068 properties:
793 type: 1069 type: