Mercurial > prosody-modules
annotate mod_http_admin_api/openapi.yaml @ 5853:97c9b76867ca
mod_log_ringbuffer: Detach event handlers on logging reload (thanks Menel)
Otherwise the global event handlers accumulate, one added each time
logging is reoladed, and each invocation of the signal or event triggers
one dump of each created ringbuffer.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 03 Mar 2024 11:23:40 +0100 |
parents | f60287bba62c |
children | 2aa66e928aa0 |
rev | line source |
---|---|
4379
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 openapi: 3.0.1 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 info: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 title: Prosody administration API |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 description: Prosody administration API |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 contact: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 email: developers@prosody.im |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 license: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 name: MIT |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 url: https://prosody.im/source/mit |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 version: 1.0.0 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 servers: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 - url: /admin_api |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 - name: user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 description: Manage user accounts |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 - name: invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 description: Pending invitations |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 - name: group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 description: User groups |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 paths: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 /users: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 - user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 summary: List users |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 description: Returns an array of users. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 operationId: listUsers |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 $ref: '#/components/schemas/UserList' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 /users/{username}: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
36 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
37 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
38 - user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
39 summary: Get user by user name |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
40 operationId: getUserByName |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
41 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
42 - name: username |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
43 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
44 description: The name that needs to be fetched |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
45 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
46 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
47 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
48 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
49 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
50 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
51 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
52 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
53 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
54 $ref: '#/components/schemas/User' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
55 400: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
56 description: Invalid username supplied |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
57 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
58 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
59 description: User not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
60 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
61 put: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
62 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
63 - user |
4517
d6a3201a65c0
mod_http_admin_api: support for updating user roles via the API
Jonas Schäfer <jonas@wielicki.name>
parents:
4390
diff
changeset
|
64 summary: Updated user |
4379
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
65 description: Update a user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
66 operationId: updateUser |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
67 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
68 - name: username |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
69 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
70 description: user that need to be updated |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
71 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
72 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
73 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
74 requestBody: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
75 description: Updated user object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
76 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
77 '*/*': |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
78 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
79 $ref: '#/components/schemas/User' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
80 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
81 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
82 400: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
83 description: Invalid user supplied |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
84 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
85 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
86 description: User not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
87 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
88 x-codegen-request-body-name: body |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
89 delete: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
90 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
91 - user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
92 summary: Delete user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
93 description: Delete a user account |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
94 operationId: deleteUser |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
95 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
96 - name: username |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
97 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
98 description: The name that needs to be deleted |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
99 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
100 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
101 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
102 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
103 400: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
104 description: Invalid username supplied |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
105 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
106 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
107 description: User not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
108 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
109 /users/{username}/groups: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
110 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
111 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
112 - user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
113 summary: List groups that user is a member of |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
114 operationId: getUserGroups |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
115 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
116 - name: username |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
117 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
118 description: The name of the user to fetch |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
119 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
120 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
121 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
122 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
123 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
124 description: Returns an array of group IDs that the user belongs to |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
125 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
126 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
127 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
128 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
129 description: "An array of group IDs that the user belongs to" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
130 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
131 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
132 description: "Group ID" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
133 400: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
134 description: Invalid username supplied |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
135 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
136 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
137 description: User not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
138 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
139 /users/{username}/debug: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
140 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
141 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
142 - user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
143 summary: Get user debug info |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
144 operationId: getUserDebugInfo |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
145 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
146 - name: username |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
147 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
148 description: The name of the user to fetch |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
149 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
150 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
151 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
152 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
153 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
154 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
155 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
156 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
157 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
158 $ref: '#/components/schemas/UserDebugInfo' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
159 400: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
160 description: Invalid username supplied |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
161 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
162 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
163 description: User not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
164 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
165 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
166 /invites: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
167 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
168 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
169 - invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
170 summary: List invites |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
171 description: Returns an array of users. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
172 operationId: listInvites |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
173 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
174 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
175 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
176 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
177 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
178 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
179 $ref: '#/components/schemas/InviteList' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
180 /invites/account: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
181 post: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
182 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
183 - invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
184 summary: Create invitation to register a new account |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
185 description: Creates a new invitation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
186 operationId: createInviteForAccount |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
187 requestBody: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
188 description: "Invite parameters (optional)" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
189 required: false |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
190 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
191 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
192 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
193 $ref: "#/components/schemas/NewAccountInvite" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
194 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
195 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
196 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
197 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
198 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
199 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
200 $ref: '#/components/schemas/Invite' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
201 /invites/group: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
202 post: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
203 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
204 - invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
205 summary: Create group invitation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
206 description: | |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
207 Creates a new group invitation. Group invitations may be |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
208 shared with multiple people and each account created via |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
209 a group invitation will automatically be contacts of |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
210 every other account created through the same invitation. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
211 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
212 You can create an invitation to an existing group by including |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
213 the existing group's id in the 'group' property of the request. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
214 If no existing group is specified, a new one will be created |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
215 automatically (using the 'group_options' property as a template |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
216 if provided). |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
217 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
218 If no 'ttl' is specified then the invitation link will be valid |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
219 until it is manually revoked. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
220 operationId: createInviteForGroup |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
221 requestBody: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
222 description: "Invite parameters (optional)" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
223 required: false |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
224 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
225 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
226 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
227 $ref: "#/components/schemas/NewGroupInvite" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
228 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
229 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
230 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
231 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
232 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
233 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
234 $ref: '#/components/schemas/Invite' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
235 /invites/reset: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
236 post: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
237 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
238 - invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
239 summary: Create account reset invitation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
240 description: | |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
241 Creates a new invitation to reset the specified account. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
242 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
243 The created link is valid for a shorter time period (24 hours) by default |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
244 and should only be shared securely with the user who owns the account. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
245 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
246 The returned link will allow the user to regain access to their account, |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
247 for example if they have lost their password. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
248 operationId: createInviteForAccountReset |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
249 requestBody: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
250 description: "Invite parameters" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
251 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
252 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
253 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
254 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
255 $ref: "#/components/schemas/NewResetInvite" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
256 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
257 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
258 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
259 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
260 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
261 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
262 $ref: '#/components/schemas/Invite' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
263 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
264 /invites/{id}: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
265 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
266 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
267 - invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
268 summary: Get invite by id |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
269 operationId: getInviteById |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
270 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
271 - name: id |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
272 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
273 description: The id of the invite to fetch |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
274 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
275 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
276 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
277 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
278 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
279 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
280 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
281 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
282 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
283 $ref: '#/components/schemas/Invite' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
284 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
285 description: Invite not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
286 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
287 delete: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
288 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
289 - invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
290 summary: Delete invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
291 description: Delete a pending invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
292 operationId: deleteInvite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
293 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
294 - name: id |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
295 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
296 description: The id of the invite to be deleted |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
297 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
298 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
299 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
300 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
301 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
302 description: Invite not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
303 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
304 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
305 /groups: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
306 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
307 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
308 - group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
309 summary: List groups |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
310 description: Returns an array of groups. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
311 operationId: listGroups |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
312 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
313 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
314 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
315 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
316 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
317 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
318 $ref: '#/components/schemas/GroupList' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
319 post: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
320 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
321 - group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
322 summary: Create group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
323 description: Creates a new user group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
324 operationId: createGroup |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
325 requestBody: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
326 description: "Group parameters" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
327 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
328 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
329 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
330 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
331 $ref: "#/components/schemas/NewGroup" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
332 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
333 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
334 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
335 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
336 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
337 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
338 $ref: '#/components/schemas/Group' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
339 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
340 /groups/{id}: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
341 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
342 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
343 - group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
344 summary: Get group by id |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
345 operationId: getGroupById |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
346 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
347 - name: id |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
348 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
349 description: The id of the group to fetch |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
350 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
351 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
352 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
353 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
354 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
355 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
356 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
357 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
358 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
359 $ref: '#/components/schemas/Group' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
360 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
361 description: Group not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
362 content: {} |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
363 delete: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
364 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
365 - group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
366 summary: Delete group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
367 description: Delete a group (does not delete users or existing subscriptions) |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
368 operationId: deleteGroup |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
369 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
370 - name: id |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
371 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
372 description: The id of the group to be deleted |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
373 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
374 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
375 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
376 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
377 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
378 description: Group not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
379 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
380 /groups/{id}/members/{username}: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
381 put: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
382 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
383 - group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
384 summary: Create group membership |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
385 operationId: addGroupMember |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
386 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
387 - name: id |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
388 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
389 description: The id of the group to modify |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
390 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
391 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
392 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
393 - name: username |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
394 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
395 description: The username to add to the group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
396 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
397 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
398 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
399 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
400 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
401 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
402 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
403 description: Group not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
404 delete: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
405 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
406 - group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
407 summary: Delete a group membership |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
408 operationId: deleteGroupMember |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
409 parameters: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
410 - name: id |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
411 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
412 description: The id of the group to modify |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
413 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
414 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
415 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
416 - name: username |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
417 in: path |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
418 description: The username to remove from the group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
419 required: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
420 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
421 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
422 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
423 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
424 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
425 404: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
426 description: Group not found |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
427 /server/info: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
428 get: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
429 tags: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
430 - server |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
431 summary: Get information about the server |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
432 operationId: getServerInfo |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
433 responses: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
434 200: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
435 description: successful operation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
436 content: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
437 application/json: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
438 schema: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
439 $ref: '#/components/schemas/ServerInfo' |
4576
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
440 /server/metrics: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
441 get: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
442 tags: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
443 - server |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
444 summary: Get metrics from the running server |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
445 operationId: getServerMetrics |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
446 responses: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
447 200: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
448 description: successful operation |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
449 content: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
450 application/json: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
451 schema: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
452 $ref: '#/components/schemas/ServerMetrics' |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
453 /server/announcement: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
454 post: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
455 tags: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
456 - server |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
457 summary: Post an announcement to some or all users |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
458 operationId: postServerAnnouncement |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
459 requestBody: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
460 description: Announcement parameters |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
461 required: true |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
462 content: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
463 application/json: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
464 schema: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
465 $ref: "#/components/schemas/Announcement" |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
466 responses: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
467 201: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
468 description: Announcement has been sent |
4379
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
469 components: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
470 schemas: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
471 UserList: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
472 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
473 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
474 $ref: '#/components/schemas/User' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
475 User: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
476 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
477 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
478 username: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
479 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
480 description: XMPP username of the user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
481 display_name: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
482 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
483 description: Display name of the user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
484 nullable: true |
5293
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
485 role: |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
486 type: string |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
487 description: Primary role of the user |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
488 nullable: true |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
489 secondary_roles: |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
490 type: array |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
491 description: List of additional roles assigned to the user |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
492 items: |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
493 type: string |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
494 roles: |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
495 type: array |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
496 description: List of roles assigned to the user (Legacy) |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
497 deprecated: true |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
498 items: |
f60287bba62c
mod_http_admin_api: Add roles to user schema in openapi
Kim Alvefur <zash@zash.se>
parents:
5292
diff
changeset
|
499 type: string |
4379
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
500 email: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
501 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
502 description: Optional email address for the user (NYI) |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
503 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
504 phone: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
505 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
506 description: Optional phone number for the user (NYI) |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
507 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
508 groups: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
509 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
510 description: List of group IDs user is a member of |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
511 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
512 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
513 description: Group ID |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
514 InviteList: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
515 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
516 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
517 $ref: '#/components/schemas/Invite' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
518 Invite: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
519 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
520 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
521 id: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
522 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
523 description: Unique ID of the invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
524 type: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
525 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
526 description: The type (action) of the invite (register, roster, etc.) |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
527 reusable: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
528 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
529 description: Whether the invite may be used more than once (until expiry or revocation) |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
530 inviter: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
531 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
532 description: (Optional) JID of the inviter |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
533 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
534 jid: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
535 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
536 description: The JID of the invite, interpretation varies based by invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
537 type |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
538 token: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
539 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
540 description: Invite token |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
541 uri: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
542 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
543 description: XMPP URI of the invite |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
544 landing_page: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
545 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
546 description: HTTPS URL of invite page (use in preference to XMPP URI when available) |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
547 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
548 created_at: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
549 type: integer |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
550 description: Unix timestamp of invite creation |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
551 expires: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
552 type: integer |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
553 description: Unix timestamp of invite expiration |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
554 groups: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
555 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
556 description: Array of group IDs that an accepting user will be added to |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
557 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
558 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
559 description: Group ID |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
560 source: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
561 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
562 description: | |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
563 String that identifies how and by whom the invite was created. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
564 |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
565 Invites created by this API will have the source string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
566 'admin_api/USERNAME', where USERNAME is the name of the user |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
567 that requested creation of the invite. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
568 reset: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
569 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
570 description: "Indicates that this is an account reset for the account identified by 'username'" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
571 NewAccountInvite: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
572 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
573 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
574 username: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
575 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
576 description: Optionally restrict the registered account to the specified username |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
577 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
578 ttl: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
579 type: number |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
580 description: The time in seconds that the invitation will be valid for (uses a sensible default if not provided). |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
581 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
582 groups: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
583 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
584 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
585 description: "IDs of existing groups to add the new account to" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
586 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
587 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
588 description: "Group ID" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
589 NewGroupInvite: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
590 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
591 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
592 ttl: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
593 type: number |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
594 description: Specify that the invitation will only be valid for the specified number of seconds. If not provided, the invitation will be valid until it is manually deleted. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
595 groups: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
596 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
597 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
598 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
599 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
600 description: "Group ID" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
601 description: "IDs of existing group to add the new accounts to" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
602 group_options: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
603 $ref: '#/components/schemas/NewGroup' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
604 NewResetInvite: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
605 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
606 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
607 username: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
608 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
609 description: "Username of the account to create a password reset link for" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
610 ttl: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
611 type: number |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
612 description: Time in seconds that the link will be valid. Defaults to 24 hours. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
613 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
614 NewGroup: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
615 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
616 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
617 name: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
618 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
619 description: "Display name of the group" |
4390
17d44ba8fde2
mod_http_admin_api: support for creating groups with MUCs
Jonas Schäfer <jonas@wielicki.name>
parents:
4379
diff
changeset
|
620 create_muc: |
17d44ba8fde2
mod_http_admin_api: support for creating groups with MUCs
Jonas Schäfer <jonas@wielicki.name>
parents:
4379
diff
changeset
|
621 type: boolean |
17d44ba8fde2
mod_http_admin_api: support for creating groups with MUCs
Jonas Schäfer <jonas@wielicki.name>
parents:
4379
diff
changeset
|
622 description: Create a MUC associated with the group |
4379
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
623 Group: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
624 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
625 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
626 id: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
627 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
628 description: id of the group |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
629 name: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
630 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
631 description: Display name of the group |
4390
17d44ba8fde2
mod_http_admin_api: support for creating groups with MUCs
Jonas Schäfer <jonas@wielicki.name>
parents:
4379
diff
changeset
|
632 muc_jid: |
17d44ba8fde2
mod_http_admin_api: support for creating groups with MUCs
Jonas Schäfer <jonas@wielicki.name>
parents:
4379
diff
changeset
|
633 type: string |
17d44ba8fde2
mod_http_admin_api: support for creating groups with MUCs
Jonas Schäfer <jonas@wielicki.name>
parents:
4379
diff
changeset
|
634 nullable: true |
17d44ba8fde2
mod_http_admin_api: support for creating groups with MUCs
Jonas Schäfer <jonas@wielicki.name>
parents:
4379
diff
changeset
|
635 description: JID of the associated MUC, if any. |
4379
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
636 GroupList: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
637 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
638 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
639 $ref: '#/components/schemas/Group' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
640 UserDebugInfo: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
641 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
642 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
643 sessions: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
644 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
645 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
646 $ref: '#/components/schemas/UserDebugSessionInfo' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
647 push_registrations: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
648 $ref: '#/components/schemas/UserDebugPushRegistrations' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
649 omemo: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
650 $ref: '#/components/schemas/UserDebugOmemo' |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
651 UserDebugSessionInfo: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
652 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
653 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
654 full_jid: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
655 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
656 description: "Full JID of the session" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
657 ip: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
658 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
659 description: "IP address of the session, human-readable" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
660 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
661 since: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
662 type: integer |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
663 description: "Unix timestamp of session establishment" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
664 status: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
665 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
666 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
667 connected: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
668 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
669 description: "Whether the session is connected" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
670 hibernating: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
671 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
672 description: "Whether the session is waiting to be resumed" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
673 active: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
674 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
675 description: "Whether the session is active (CSI)" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
676 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
677 features: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
678 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
679 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
680 encrypted: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
681 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
682 description: "Whether the session enabled transport encryption" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
683 carbons: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
684 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
685 description: "Whether the session enabled carbons" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
686 acks: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
687 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
688 description: "Whether the session enabled acknowledgements" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
689 resumption: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
690 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
691 description: "Whether the session enabled resumption" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
692 mobile_optimization: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
693 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
694 description: "Whether the session enabled mobile optimizations" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
695 push_notifications: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
696 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
697 description: "Whether the session enabled push notifications" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
698 history: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
699 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
700 description: "Whether the session requested history" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
701 queues: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
702 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
703 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
704 held_stanzas: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
705 type: integer |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
706 description: "Number of stanzas held due to mobile optimizations" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
707 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
708 awaiting_acks: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
709 type: integer |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
710 description: "Number of stanzas awaiting acknowledgement" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
711 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
712 push_info: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
713 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
714 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
715 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
716 id: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
717 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
718 description: "ID of the push registration used by this session" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
719 wakeup_push_sent: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
720 type: integer |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
721 description: "Unix timestamp of the first wakeup push sent (if any)" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
722 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
723 UserDebugPushRegistrations: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
724 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
725 description: | |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
726 Push registrations of the user. The key of the object is the registration |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
727 identifier. If a session is using a push registration, this identifier is |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
728 found in `session.push_info.id`. It is possible to have push registrations |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
729 with no active sessions attached. |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
730 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
731 since: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
732 type: integer |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
733 description: "Unix timestamp of creation of this registration" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
734 service: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
735 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
736 description: "The JID of the push service that notifications will be sent to" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
737 node: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
738 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
739 description: "The identifier/token that the remote push service assigned to this registration." |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
740 error_count: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
741 type: number |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
742 description: "A count of recent errors for this push registration (reset on successful push)." |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
743 UserDebugOmemo: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
744 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
745 description: "Information about user's published OMEMO devices and keys" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
746 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
747 status: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
748 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
749 description: "Status of the OMEMO device list" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
750 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
751 valid: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
752 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
753 description: "Indicates whether the overall OMEMO configuration appears to be valid (including all devices)" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
754 config_valid: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
755 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
756 description: "Indicates whether configuration of the device list appears to be valid" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
757 devices: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
758 type: array |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
759 items: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
760 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
761 description: "OMEMO device descriptor" |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
762 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
763 id: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
764 type: integer |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
765 description: "The integer OMEMO device id of this device. May be missing if invalid." |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
766 nullable: true |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
767 have_bundle: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
768 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
769 description: "True when a matching descriptor (bundle) is found for this device." |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
770 valid: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
771 type: boolean |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
772 description: "Whether the bundle config appears to be valid." |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
773 ServerInfo: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
774 type: object |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
775 description: Information about the current server |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
776 properties: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
777 site_name: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
778 type: string |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
779 description: A friendly name for the service |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
780 version: |
950abc6c67b8
mod_http_admin_api: Add OpenAPI spec
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
781 type: string |
4576
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
782 description: A human-readable version string |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
783 ServerMetrics: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
784 type: object |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
785 description: A selection of instantaneous metrics of the prosody server |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
786 properties: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
787 memory: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
788 type: integer |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
789 description: RSS in bytes |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
790 cpu: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
791 type: object |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
792 description: CPU time counter |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
793 required: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
794 - value |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
795 - since |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
796 properties: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
797 since: |
5292
231d9cc750d9
mod_http_admin_api: Fix types of numbers in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4778
diff
changeset
|
798 type: number |
4576
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
799 description: The metric epoch as UNIX timestamp |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
800 value: |
5292
231d9cc750d9
mod_http_admin_api: Fix types of numbers in openapi spec
Kim Alvefur <zash@zash.se>
parents:
4778
diff
changeset
|
801 type: number |
4576
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
802 description: Seconds of CPU time used since the metric epoch |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
803 c2s: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
804 type: integer |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
805 description: Number of active c2s sessions |
4778
229f2a79ad6f
mod_http_admin_api: Fix YAML indentation
Kim Alvefur <zash@zash.se>
parents:
4777
diff
changeset
|
806 uploads: |
229f2a79ad6f
mod_http_admin_api: Fix YAML indentation
Kim Alvefur <zash@zash.se>
parents:
4777
diff
changeset
|
807 type: integer |
229f2a79ad6f
mod_http_admin_api: Fix YAML indentation
Kim Alvefur <zash@zash.se>
parents:
4777
diff
changeset
|
808 description: Disk space used by uploaded files |
4576
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
809 Announcement: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
810 type: object |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
811 description: An announcemen to post to users on the server |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
812 required: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
813 - body |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
814 - recipients |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
815 properties: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
816 body: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
817 type: string |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
818 description: The message body to send |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
819 recipients: |
cade5dac1003
mod_http_admin_api: Add endpoints for server maintenance
Jonas Schäfer <jonas@wielicki.name>
parents:
4517
diff
changeset
|
820 description: List of recipients or one of the strings "online" or "all" |