-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29591_Nnef_ECSAddress.yaml
321 lines (318 loc) · 11.5 KB
/
TS29591_Nnef_ECSAddress.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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
openapi: 3.0.0
info:
title: Nnef_ECSAddressConfigurationInformation
version: 1.0.0-alpha.2
description: |
NEF ECS Address Service.
© 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.591 V18.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
- url: '{apiRoot}/nnef-ecs-addr-cfg-info/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
- {}
- oAuth2ClientCredentials:
- nnef-ecs-addr-cfg-info
paths:
/subscriptions:
post:
summary: subscribe to notifications
operationId: CreateIndividualSubcription
tags:
- Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EcsAddrCfgInfoSub'
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EcsAddrCfgInfoSub'
headers:
Location:
description: >
Contains the URI of the newly created resource, according to the structure
{apiRoot}/nnef-ecs-addr-cfg-info/<apiVersion>/subscriptions/{subscriptionId}
required: true
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
myNotification:
'{$request.body#/notifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EcsAddrCfgInfoNotification'
responses:
'204':
description: No Content, Notification was succesfull
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
get:
summary: retrieve subscription
operationId: GetIndividualSubcription
tags:
- IndividualSubscription (Document)
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
schema:
type: string
responses:
'200':
description: OK. Resource representation is returned
content:
application/json:
schema:
$ref: '#/components/schemas/EcsAddrCfgInfoSub'
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
put:
summary: update subscription
operationId: ReplaceIndividualSubcription
tags:
- IndividualSubscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EcsAddrCfgInfoSub'
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
schema:
type: string
responses:
'200':
description: OK. Resource was succesfully modified and representation is returned
content:
application/json:
schema:
$ref: '#/components/schemas/EcsAddrCfgInfoSub'
'204':
description: No Content. Resource was succesfully modified
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: unsubscribe from notifications
operationId: DeleteIndividualSubcription
tags:
- IndividualSubscription (Document)
parameters:
- name: subscriptionId
in: path
description: Subscription ID
required: true
schema:
type: string
responses:
'204':
description: No Content. Resource was succesfully deleted
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nnef-ecs-addr-cfg-info: Access to the Nnef_ECSAddress API
schemas:
EcsAddrCfgInfoSub:
description: Represents an Individual ECS Address Configuration Information subscription data.
type: object
properties:
notifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
notifCorrId:
type: string
description: Notification correlation identifier.
dnns:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems: 1
description: Each element identifies a DNN.
snssais:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
description: Each element identifies a slice.
internalGroupId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
immRepInd:
type: boolean
description: >
Indication of immediate reporting. If included, when it is set to true it indicates
immediate reporting of the subscribed events, if available. Otherwise, reporting will
occur when the event is met.
immReports:
type: array
items:
$ref: '#/components/schemas/EcsAddrCfgInfoNotification'
minItems: 1
description: Immediate report with ECS Address Configuration Information that
match this subscription.
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- notifUri
- notifCorrId
EcsAddrCfgInfoNotification:
description: Represents notifications for ECS Address Configuration Information data.
type: object
properties:
notifCorrId:
type: string
description: Notification correlation identifier.
ecsAddrCfgInfo:
type: array
items:
type: string
minItems: 1
description: Contains the ECS Address Configuration Information.
required:
- notifCorrId
- ecsAddrCfgInfo