Mercurial > prosody-modules

diff mod_rest/README.markdown @ 3800:cfa00eea896f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Add some text about the payload format
author Kim Alvefur <zash@zash.se>
date Mon, 30 Dec 2019 07:21:46 +0100
parents ed5d7586a61e
children d59fb4dcf100
line wrap: on
line diff
--- a/mod_rest/README.markdown	Mon Dec 30 05:19:23 2019 +0100
+++ b/mod_rest/README.markdown	Mon Dec 30 07:21:46 2019 +0100
@@ -97,6 +97,18 @@
 </message>
 ```
 
+## Payload format
+
+``` {.xml}
+<message type="" id="" to="" from="" xml:lang="">
+...
+</message>
+```
+
+An XML declaration (`<?xml?>`) **MUST NOT** be included.
+
+The payload MUST contain one (1) `message`, `presence` or `iq` stanza.
+
 # Compatibility
 
 Requires Prosody trunk / 0.12