mod_rest/res/openapi.yaml

3.0.1
mod_rest API
0.3.2
MIT
Send stanzas and receive responses. Webhooks work the same way.
generic
/rest/{kind}/{type}/{to}
Even more RESTful mapping with certain components in the path.
generic
Build as stanza and return it for inspection.
debug
/rest/ping/{to}
query
Ping a local or remote server or other entity
Test reachability of some address
/rest/version/{to}
query
Ask what software version is used.
Version query response
/rest/disco/{to}
query
Query a remote entity for supported features
/rest/items/{to}
query
Query an entity for related services, chat rooms or other items
/rest/extdisco/{to}
query
Query for external services (usually STUN and TURN)
type
query
string
stun
/rest/archive/{to}
query
Query a message archive
with
query
string
start
query
string
end
query
string
before-id
query
string
after-id
query
string
ids
query
string
comma-separated list of archive ids
after
query
string
before
query
string
max
query
integer
/rest/lastactivity/{to}
query
Query last activity of an entity. Sometimes used as "uptime" for servers.
/rest/stats/{to}
query
Query an entity for statistics
/rest/upload_request/{to}
query
Lorem ipsum
object
Hello
chat
message
alice@example.com
active
object
message
Which kind of stanza
string
message
string
chat
error
groupchat
headline
normal
true
object
Which kind of stanza
string
presence
string
available
unavailable
subscribe
subscribed
unsubscribe
unsubscribed
error
true
object
Which kind of stanza
string
iq
string
get
set
result
error
true
Test reachability of some XMPP address
object
iq
string
result
true
Version query response
object
iq
string
result
true
Which kind of stanza
string
message
presence
iq
Stanza type
string
chat
normal
headline
groupchat
get
set
result
available
unavailable
subscribe
subscribed
unsubscribe
unsubscribed
true
recipient
alice@example.com
string
true
the sender
bob@localhost.example
string
true
Reasonably unique id. mod_rest generates one if left out.
string
true
Language code
en
xml
true
string
Human-readable chat message
Hello, World!
string
Subject of message or group chat
Talking about stuff
string
Message thread identifier
string
true
string
true
indicator of availability, ie away or not
string
away
chat
dnd
xa
Textual status message.
string
Presence priority
integer
127
-128
Chat state notifications, e.g. "is typing..."
string
http://jabber.org/protocol/chatstates
true
active
inactive
gone
composing
paused
composing
string
Nickname of the sender
nick
http://jabber.org/protocol/nick
string
date-time
Timestamp of when a stanza was delayed, in ISO 8601 / XEP-0082
format.
delay
urn:xmpp:delay
stamp
string
ID of message being replaced (e.g. for corrections)
replace
urn:xmpp:message-correct:0
id
Multi-User-Chat related
object
x
http://jabber.org/protocol/muc
object
integer
0
true
integer
0
true
integer
0
true
string
date-time
true
Invite to a group chat
object
jid
x
jabber:x:conference
string
Address of the group chat
xmpp-jid
true
string
Optional message by the inviter
true
string
Password for the group chat, if required
true
string
true
boolean
Whether the group chat continues a one-to-one chat
true
HTML version of 'body'
<body><p>Hello!</p></body>
string
A ping.
boolean
true
ping
urn:xmpp:ping
object
Software version query
string
My Software
string
1.0.0
string
Linux
name
version
query
jabber:iq:version
Discover supported features
A full response
object
List of URIs indicating supported features
array
string
List of abstract identities or types that describe the
entity
array
Prosody
im
server
object
string
string
string
string
object
A query with a node, or an empty response with a node
string
Either a query, or an empty response
boolean
List of references to other entities
List of items referenced
array
string
Address of item
string
string
Descriptive name
jid
object
string
A query with a node, or an empty reply list with a node
An items query or empty list
boolean
true
Ad-hoc commands.
object
string
object
string
string
info
warn
error
string
string
string
object
boolean
boolean
boolean
string
string
Call a command by 'node' id, without arguments
object
Reference a media file
x
jabber:x:oob
string
URL of the attached media file
https://media.example.net/thisfile.jpg
uri
Optional description
string
A piece of arbitrary JSON with a type field attached
object
payload
urn:xmpp:json-msg:0
datatype
data
object
urn:example:my-json#payload
string
set
http://jabber.org/protocol/rsm
object
string
integer
integer
integer
string
string
string
object
true
string
query
urn:xmpp:mam:2
urn:xmpp:mam:2
result
object
string
true
forwarded
urn:xmpp:forward:0
object
Data form
object
Title of the form
TPS Report
string
array
Form field
object
Field value
string
array
string
Type of form field
string
Descriptive label for the field
string
Longer description, i.e. that would go in a tooltip
string
Whether the field must be included in the form
boolean
Internal name of the field
string
string
form
submit
cancel
result
string
Simplified data form carrying only values
object
string
array
string
Statistics
array
query
http://jabber.org/protocol/stats
true
object
string
true
string
true
string
true
object
query
jabber:iq:last
integer
0
true
string
true
object
c
http://jabber.org/protocol/caps
string
true
string
true
string
true
string
true
object
x
vcard-temp:x:update
string
adc83b19e793491b1c6ea0fd8b46cd9f32e592fc
object
urn:xmpp:reactions:0
string
true
array
reaction
string
false
reactions
string
urn:xmpp:occupant-id:0
id
occupant-id
string
urn:xmpp:message-attaching:1
id
attach-to
boolean
urn:xmpp:fallback:0
true
fallback
array
object
id
by
urn:xmpp:sid:0
stanza-id
true
string
true
xmpp-jid
string
object
urn:xmpp:reference:0
0
true
integer
true
uri
string
0
true
integer
true
string
type
uri
Reference a message being replied to
object
reply
urn:xmpp:reply:0
string
true
string
true
boolean
urn:xmpp:chat-markers:0
true
string
Message ID of a message that has been displayed
urn:xmpp:chat-markers:0
id
string
urn:xmpp:idle:1
since
idle
date-time
object
jabber:iq:gateway
query
string
string
string
object
urn:xmpp:extdisco:2
services
true
string
object
service
type
host
true
string
true
string
true
integer
true
string
true
datetime
string
true
string
true
string
true
boolean
true
string
array
object
Register with a service
jabber:iq:register
query
string
string
string
string
string
string
string
string
string
string
string
string
true
boolean
string
true
boolean
string
string
string
string
string
username
password
object
slot
urn:xmpp:http:upload:0
object
string
uri
true
array
object
name
value
header
string
Authorization
Cookie
Expires
true
string
true
object
string
uri
true
object
filename
size
request
urn:xmpp:http:upload:0
string
true
true
content-type
integer
true
string
namespace
encryption
urn:xmpp:eme:0
Description of something gone wrong. See the Stanza Errors section in RFC 6120.
object
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
Needs mod_http_oauth2
oauth2
https://example.com/oauth2/authorize
https://example.com/oauth2/token
Restricted account
Regular user privileges
Administrator privileges
Server operator privileges
true
Single XMPP stanza in XML format.
A subset of the JSON schema, only top level string fields.
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	Tue, 02 May 2023 16:34:31 +0200
parents	d03448560acf
children	5268049915d8