Annotate

mod_muc_http_defaults/README.markdown @ 4447:07aa101a1ae7

mod_muc_http_defaults: Get MUC room config from an API
author Kim Alvefur <zash@zash.se>
date Fri, 19 Feb 2021 16:01:41 +0100
child 4448:5879ca1f7853
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4447
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 summary: Seed MUC configuration from JSON REST API
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 ---
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 # Introduction
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 This module fetches configuration for MUC rooms from an API when rooms
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 are created.
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 # Requirements
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 Prosody **trunk** required.
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 # Configuration
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 `muc_create_api_url`
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 : URL template for the API endpoint to get settings. `{room.jid}` is
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 replaced by the address of the room in question.
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 `muc_create_api_auth`
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 : The value of the Authorization header to authenticate against the
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 API. E.g. `"Bearer /rXU4tkQTYQMgdHfMLH6"`{.lua}
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 ## Example
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 ``` {.lua}
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 Component "channels.example.net" "muc"
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 modules_enabled = { "muc_http_defaults" }
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 muc_create_api_url = "https://api.example.net/muc/config?jid={room.jid}"
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 ```
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 # API
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 A RESTful JSON API is used. Any error causes the room to be destroyed.
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 The returned JSON consists of two main parts, the room configuration and
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 the affiliations (member list).
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 ## Schema
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 Here's a JSON Schema in YAML format describing the expected JSON
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42 response data:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 ``` {.yaml}
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
45 ---
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46 type: object
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47 properties:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48 config:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 type: object
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50 properties:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
51 name: string
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52 description: string
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
53 language: string
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
54 persistent: boolean
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
55 public: boolean
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
56 members_only: boolean
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
57 allow_member_invites: boolean
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
58 public_jids: boolean
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
59 subject: string
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
60 changesubject: boolean
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
61 historylength: integer
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
62 moderated: boolean
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
63 archiving: boolean
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
64 affiliations:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
65 anyOf:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
66 - type: array
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
67 items:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
68 type: object
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
69 required:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
70 - jid
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
71 - affiliation
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
72 properties:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
73 jid:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
74 type: string
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
75 pattern: ^[^@/]+@[^/]+$
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
76 affiliation:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
77 ref: '#/definitions/affiliation'
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
78 nick: string
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
79 - type: object
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
80 patternProperties:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
81 ^[^@/]+@[^/]+$: '#/definitions/affiliation'
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
82 definitions:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
83 affiliation:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
84 type: string
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
85 enum:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
86 - owner
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
87 - admin
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
88 - member
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
89 - none
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
90 - outcast
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
91 ...
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
92 ```
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
93
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
94 ## Example
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
95
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
96 A basic example with some config settings and a few affiliations:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
97
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
98 ``` {.json}
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
99 GET /muc/config?jid=place@channels.example.net
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
100 Accept: application/json
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
101
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
102 HTTP/1.1 200 OK
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
103 Content-Type: application/json
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
104
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
105 {
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
106 "affiliations" : [
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
107 {
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
108 "affiliation" : "owner",
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
109 "jid" : "bosmang@example.net",
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
110 "nick" : "bosmang"
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
111 },
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
112 {
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
113 "affiliation" : "admin",
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
114 "jid" : "xo@example.net",
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
115 "nick" : "xo"
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
116 },
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
117 {
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
118 "affiliation" : "member",
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
119 "jid" : "john@example.net"
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
120 }
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
121 ],
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
122 "config" : {
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
123 "archiving" : true,
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
124 "description" : "This is the place",
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
125 "members_only" : true,
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
126 "moderated" : false,
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
127 "name" : "The Place",
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
128 "persistent" : true,
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
129 "public" : false,
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
130 "subject" : "Discussions regarding The Place"
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
131 }
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
132 }
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
133 ```
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
134
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
135 To allow the creation without making any changes, letting whoever
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
136 created it be the owner, just return an empty JSON object:
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
137
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
138 HTTP/1.1 200 OK
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
139 Content-Type: application/json
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
140
07aa101a1ae7 mod_muc_http_defaults: Get MUC room config from an API
Kim Alvefur <zash@zash.se>
parents:
diff changeset
141 {}