mod_rest/openapi.yaml

3.0.1
mod_rest API
0.1.0
MIT
Send stanzas and receive responses. Webhooks work the same way.
/rest/{kind}/{type}/{to}
Even more RESTful mapping with certain components in the path.
/rest/ping/{to}
Ping a local or remote server or other entity
/rest/disco/{to}
Query a remote entity for supported features
/rest/items/{to}
Query an entity for related services, chat rooms or other items
/rest/version/{to}
Ask what software version is used.
object
Hello
chat
message
alice@example.com
active
string
Timestamp of when a stanza was delayed, in ISO 8601 / XEP-0082
format.
active
inactive
gone
composing
paused
Chat state notifications, e.g. "is typing..."
string
composing
string
Message thread identifier
string
Textual status message.
string
Reasonably unique id. mod_rest generates one if left out.
string
ID of message being replaced (e.g. for corrections)
the sender
string
bob@localhost.example
Human-readable chat message
string
Hello, World!
string
object
string
object
string
string
info
warn
error
string
string
string
object
boolean
boolean
boolean
string
Ad-hoc commands.
indicator of availability, ie away or not
string
away
chat
dnd
xa
Statistics
array
object
string
string
string
string
presence priority
Which kind of stanza
string
message
presence
iq
recipient
string
alice@example.com
Stanza type
string
chat
normal
headline
groupchat
get
set
result
available
unavailable
subscribe
subscribed
unsubscribe
unsubscribed
Language code
string
en
string
array
string
object
Simplified data form
For joining Multi-User-Chats
boolean
true
string
array
object
string
array
string
string
string
string
boolean
string
string
form
submit
cancel
result
string
Data form
object
An items query or empty list
boolean
true
string
A query with a node, or an empty reply list with a node
List of items referenced
array
string
Address of item
string
string
Descriptive name
jid
object
List of references to other entities
boolean
string
string
string
name
version
object
Software version query
datatype
data
object
string
A piece of arbitrary JSON with a type field attached
object
boolean
Either a query, or an empty response
string
A query with a node, or an empty response with a node
List of URIs indicating supported features
array
string
object
string
string
string
List of abstract identities or types that describe the
entity
array
Prosody
im
server
string
object
A full response
object
Discover supported features
string
URL of an attached media file.
HTML version of 'body'
string
<body><p>Hello!</p></body>
Subject of message or group chat
string
Talking about stuff
A ping.
boolean
true
string
Nickname of the sender
object
Description of something gone wrong. See the Stanza Errors section in RFC 6120.
General category of error
string
auth
cancel
continue
modify
wait
Specific error condition.
string
Legacy numeric error code. Similar to HTTP status codes.
integer
Description of error intended for human eyes.
string
Tokens from mod_http_oauth2.
Bearer
http
Use JID as username.
Basic
http
true
A subset of the JSON schema, only top level string fields.
Single XMPP stanza in XML format.
The stanza was sent and returned a response.
Single XMPP stanza in XML format.
<message><body>Hello</body></message>
A subset of the JSON schema, only top level string fields.
body=Hello
Plain text response used as message body.
Hello
string
The stanza was sent without problem, and without response,
so an empty reply.
to
path
true
kind
path
true
type
path
true
author	Kim Alvefur <zash@zash.se>
date	Thu, 04 Mar 2021 00:43:26 +0100
parents	f877a4d3770b
children	89571a20196f