-
Notifications
You must be signed in to change notification settings - Fork 9
/
notifications.yaml
167 lines (167 loc) · 4.83 KB
/
notifications.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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
openapi: 3.0.0
info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: Notifications
version: v3
servers:
- url: https://{hostname}/etp-config/v3
x-akamai:
auth-type: EDGE_GRID
file-path: notifications.yaml
paths:
/configs/{configId}/notifications-config:
parameters:
- $ref: parameters/configId-path.yaml
post:
operationId: post-notifications-config
summary: Create notifications configs
tags:
- Notifications
description: |
Create notification configs in bulk.
requestBody:
required: true
content:
application/json:
example:
$ref: examples/notification-config-request-200.json
schema:
$ref: schemas/notificationConfigRequest.yaml
responses:
200:
description: |
Successful response.
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
412:
$ref: errors/precondition-failed-412.yaml
get:
operationId: get-notifications-config
summary: Get notification configuration
tags:
- Notifications
description: |
Provides all notification configurations.
responses:
200:
description: |
Successful response.
headers:
ETag:
$ref: headers/ETag.yaml
content:
application/json:
example:
$ref: examples/notifications-config-all-200.json
schema:
$ref: schemas/notificationConfigAll.yaml
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
put:
operationId: put-notifications-config
summary: Update the notifications configs
tags:
- Notifications
description: |
Updates the notification configs in bulk.
parameters:
- $ref: headers/if-match-header.yaml
requestBody:
required: true
content:
application/json:
example:
$ref: examples/notification-config-request-200.json
schema:
$ref: schemas/notificationConfigRequest.yaml
responses:
200:
description: |
Successful response.
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
412:
$ref: errors/precondition-failed-412.yaml
/configs/{configId}/notifications-config/{notificationType}:
parameters:
- $ref: parameters/notificationType-path.yaml
- $ref: parameters/configId-path.yaml
get:
operationId: get-config-notification-type
summary: Get notification configuration for type
tags:
- Notifications
description: |
Gets notification details for the given notification type.
responses:
200:
description: |
Successful response.
headers:
ETag:
$ref: headers/ETag.yaml
content:
application/json:
example:
$ref: examples/notification-config-type-200.json
schema:
$ref: schemas/notificationConfigType.yaml
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
put:
operationId: put-config-notification-type
summary: Update the subscribers to notification type
tags:
- Notifications
description: |
Updates the subscribers to the given notification type.
parameters:
- $ref: headers/if-match-header.yaml
requestBody:
required: true
content:
application/json:
example:
$ref: examples/notification-config-update-200.json
schema:
$ref: schemas/notificationConfigTypeUpdate.yaml
responses:
200:
description: |
Successful response.
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
412:
$ref: errors/precondition-failed-412.yaml