https://soft.trung.fun/code/prosody-modules/ en-us mod_rest/README.markdown revision history https://soft.trung.fun/code/prosody-modules/log/dcea4b4c415d/mod_rest/README.markdown installations.]]> Ben Smith <bens@effortlessis.com> Tue, 14 May 2024 07:31:34 -0700 https://soft.trung.fun/code/prosody-modules/log/d194d1012fd3/mod_rest/README.markdown
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.

Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.]]> Ben Smith <bens@effortlessis.com> Mon, 13 May 2024 13:25:13 -0700 https://soft.trung.fun/code/prosody-modules/log/5be04d1b16fb/mod_rest/README.markdown
Users were somehow confused into thinking that you should use the JID as
username, rather than the username.]]> Kim Alvefur <zash@zash.se> Tue, 28 Feb 2023 18:15:20 +0100 https://soft.trung.fun/code/prosody-modules/log/51f7d72a56c2/mod_rest/README.markdown
The examples are inconsistent and confusing wrt authentication,
hopefully these words help a bit.]]> Kim Alvefur <zash@zash.se> Wed, 25 Jan 2023 20:39:13 +0100 https://soft.trung.fun/code/prosody-modules/log/09dd378748b8/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Sat, 31 Dec 2022 16:57:40 +0100 https://soft.trung.fun/code/prosody-modules/log/25f39ceccbca/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Sat, 31 Dec 2022 15:32:25 +0100 https://soft.trung.fun/code/prosody-modules/log/a85efae90e21/mod_rest/README.markdown
The previous 'join' mapping was apparently lost in translation when
swithing to datamapper, so might as well map some properties allowing
history control. Usually you probably want either zero history or
history since the last known time of being joined. Maybe that the former
should be the default?]]> Kim Alvefur <zash@zash.se> Sat, 30 Apr 2022 01:00:01 +0200 https://soft.trung.fun/code/prosody-modules/log/c83b009b5bc5/mod_rest/README.markdown
Makes it simpler to build APIs that only handle a certain kind of
stanzas, letting them be handled by the unhandled stanza handler instead
of having to write code to ignore certain kinds of stanzas.]]> Kim Alvefur <zash@zash.se> Sat, 09 Apr 2022 01:04:25 +0200 https://soft.trung.fun/code/prosody-modules/log/bdac7c717c91/mod_rest/README.markdown
E.g.

rest_callback_url = "http://myapi.example:5000/api/{kind}/{type}"

which results in e.g. requests to /api/message/chat

Allows using path routing in web frameworks for dispatch instead of
having to pick apart the payload to further dispatch it.]]> Kim Alvefur <zash@zash.se> Sat, 09 Apr 2022 00:41:18 +0200 https://soft.trung.fun/code/prosody-modules/log/b9f8dd9a7fdb/mod_rest/README.markdown
... in passing. Should be documented better. But not this day!

This day, I commit features!]]> Kim Alvefur <zash@zash.se> Sat, 09 Apr 2022 00:37:55 +0200 https://soft.trung.fun/code/prosody-modules/log/dc35d2932d3e/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Fri, 26 Mar 2021 12:09:57 +0100 https://soft.trung.fun/code/prosody-modules/log/073f5397c1d2/mod_rest/README.markdown
All the stuff now goes into a JSON file that describes the mappings.]]> Kim Alvefur <zash@zash.se> Sun, 21 Mar 2021 23:54:06 +0100 https://soft.trung.fun/code/prosody-modules/log/508cb880b163/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Tue, 09 Mar 2021 18:44:35 +0100 https://soft.trung.fun/code/prosody-modules/log/7ab0c423688a/mod_rest/README.markdown
Example:
GET /rest/version/example.com

200 OK
{ version: { name: "thing", version: "1.0.0" } }]]> Kim Alvefur <zash@zash.se> Sun, 28 Feb 2021 19:33:09 +0100 https://soft.trung.fun/code/prosody-modules/log/8df6cc648963/mod_rest/README.markdown
Example:
POST /rest/message/chat/juliet@example.net
{ body: "Hello" }

Becomes equivalent to
POST /rest
{ kind: "message", type: "chat", to: "juliet@example.net", body: "Hello" }

Sending messages as plain/text also becomes more convenient.

IQ stazas are still weird, but we'll do something special for those.]]> Kim Alvefur <zash@zash.se> Sun, 28 Feb 2021 19:25:45 +0100 https://soft.trung.fun/code/prosody-modules/log/bb111148d031/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Sat, 28 Nov 2020 14:14:03 +0100 https://soft.trung.fun/code/prosody-modules/log/7191d4638393/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Mon, 05 Oct 2020 21:56:04 +0200 https://soft.trung.fun/code/prosody-modules/log/b89f381abaa9/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Mon, 20 Jul 2020 22:32:22 +0200 https://soft.trung.fun/code/prosody-modules/log/504a0cd5f883/mod_rest/README.markdown
mod_http_oauth2 needs docs too]]> Kim Alvefur <zash@zash.se> Mon, 20 Jul 2020 21:55:07 +0200 https://soft.trung.fun/code/prosody-modules/log/5790c3cf615b/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Mon, 20 Jul 2020 21:54:52 +0200 https://soft.trung.fun/code/prosody-modules/log/2c6d5734ae04/mod_rest/README.markdown
Example XEP-0157 payload:

{
"disco" : {
"extensions" : {
"http://jabber.org/network/serverinfo" : {
"abuse-addresses" : [
"mailto:abuse@shakespeare.lit",
"xmpp:abuse@shakespeare.lit"
],
"admin-addresses" : [
"mailto:admin@shakespeare.lit",
"xmpp:admin@shakespeare.lit"
],
"feedback-addresses" : [
"http://shakespeare.lit/feedback.php",
"mailto:feedback@shakespeare.lit",
"xmpp:feedback@shakespeare.lit"
],
"sales-addresses" : [
"xmpp:bard@shakespeare.lit"
],
"security-addresses" : [
"xmpp:security@shakespeare.lit"
],
"support-addresses" : [
"http://shakespeare.lit/support.php",
"xmpp:support@shakespeare.lit"
]
}
}
}
}]]> Kim Alvefur <zash@zash.se> Mon, 23 Mar 2020 19:03:04 +0100 https://soft.trung.fun/code/prosody-modules/log/2a5b42e4db07/mod_rest/README.markdown
Listing commands is done with disco#items, not disco#info]]> Kim Alvefur <zash@zash.se> Sun, 15 Mar 2020 23:02:58 +0100 https://soft.trung.fun/code/prosody-modules/log/117a979ef930/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Sat, 08 Feb 2020 15:29:35 +0100 https://soft.trung.fun/code/prosody-modules/log/8752e5b5dd08/mod_rest/README.markdown
Mostly complete]]> Kim Alvefur <zash@zash.se> Sat, 25 Jan 2020 01:31:49 +0100 https://soft.trung.fun/code/prosody-modules/log/a8aa11cc351d/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Thu, 02 Jan 2020 10:45:19 +0100 https://soft.trung.fun/code/prosody-modules/log/7d909976ca88/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Thu, 02 Jan 2020 10:45:14 +0100 https://soft.trung.fun/code/prosody-modules/log/21ffca4d3aae/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Thu, 02 Jan 2020 10:08:48 +0100 https://soft.trung.fun/code/prosody-modules/log/d3757e089433/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Wed, 01 Jan 2020 18:11:55 +0100 https://soft.trung.fun/code/prosody-modules/log/aa1ad69c7c10/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Wed, 01 Jan 2020 16:21:28 +0100 https://soft.trung.fun/code/prosody-modules/log/a70f5a6c7f01/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Wed, 01 Jan 2020 12:08:25 +0100 https://soft.trung.fun/code/prosody-modules/log/02164f8aebac/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Wed, 01 Jan 2020 12:06:46 +0100 https://soft.trung.fun/code/prosody-modules/log/f88e07630e4e/mod_rest/README.markdown
Token specified in config]]> Kim Alvefur <zash@zash.se> Tue, 31 Dec 2019 03:37:46 +0100 https://soft.trung.fun/code/prosody-modules/log/d59fb4dcf100/mod_rest/README.markdown
Prosody needs it to be empty internally.]]> Kim Alvefur <zash@zash.se> Mon, 30 Dec 2019 07:22:15 +0100 https://soft.trung.fun/code/prosody-modules/log/cfa00eea896f/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Mon, 30 Dec 2019 07:21:46 +0100 https://soft.trung.fun/code/prosody-modules/log/ed5d7586a61e/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Mon, 30 Dec 2019 05:17:18 +0100 https://soft.trung.fun/code/prosody-modules/log/d1ad10b76b00/mod_rest/README.markdown
This will primarily cover error replies, and only those generated by the
same Prosody instance using the `origin.reply()` method.]]> Kim Alvefur <zash@zash.se> Mon, 30 Dec 2019 05:14:49 +0100 https://soft.trung.fun/code/prosody-modules/log/f51308fcba83/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Mon, 30 Dec 2019 04:07:25 +0100 https://soft.trung.fun/code/prosody-modules/log/4b258329e6e4/mod_rest/README.markdown Kim Alvefur <zash@zash.se> Mon, 30 Dec 2019 04:04:34 +0100