-
Notifications
You must be signed in to change notification settings - Fork 433
/
status_messages.yaml
67 lines (64 loc) · 2.03 KB
/
status_messages.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
get:
summary: Get list of status messages
description: |
Get a list of all status messages
security:
- basic_authentication: []
parameters:
- $ref: '../components/parameters/limit.yaml'
responses:
'200':
description: OK. The request has succeeded.
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/status_messages.yaml'
example:
count: 2
status_message:
- id: 2
message: OBS 3.0 is released!
user: Iggy
severity: announcement
scope: all_users
created_at: 2021-10-15 13:28:22 UTC
- id: 1
message: Feature number 42 was implemented!
user: Iggy
severity: announcement
scope: all_users
created_at: 2021-10-12 11:18:12 UTC
'401':
$ref: '../components/responses/unauthorized.yaml'
tags:
- Status Messages
post:
summary: Create a status message
description: |
Create a new status message (Only admins are allowed to add status messages).
Possible values for severity: (information, green, yellow, red, announcement).
Possible values for scope: (all_users, logged_in_users, admin_users, in_beta_users, in_rollout_users)
security:
- basic_authentication: []
requestBody:
description: Attributes for status message
required: true
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/status_message.yaml'
example:
message: Feature number 42 was implemented!
severity: announcement
scope: all_users
responses:
'200':
$ref: '../components/responses/succeeded.yaml'
'400':
$ref: '../components/responses/validation_error.yaml'
'401':
$ref: '../components/responses/unauthorized.yaml'
'403':
$ref: '../components/responses/status_message_no_permission.yaml'
tags:
- Status Messages