-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29520_Nnwdaf_RoamingAnalytics.yaml
294 lines (285 loc) · 10.8 KB
/
TS29520_Nnwdaf_RoamingAnalytics.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
openapi: 3.0.0
info:
title: Nnwdaf_RoamingAnalytics
version: 1.0.0-alpha.1
description: |
Nnwdaf_RoamingAnalytics API Service.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/
servers:
- url: '{apiRoot}/nnwdaf-roaminganalytics/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
- {}
- oAuth2ClientCredentials:
- nnwdaf-roaminganalytics
paths:
/subscriptions:
post:
summary: Create a new Individual NWDAF Roaming Analytics Subscription
operationId: CreateNwdafRoamingAnalyticsSubscription
tags:
- NWDAF Roaming Analytics Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RoamingAnalyticsSubscription'
responses:
'201':
description: Create a new Individual Roaming Analytics Subscription resource.
headers:
Location:
description: >
Contains the URI of the newly created resource.
required: true
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RoamingAnalyticsSubscription'
'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:
type: array
items:
$ref: '#/components/schemas/RoamingAnalyticsNotification'
minItems: 1
responses:
'204':
description: The receipt of the Notification is acknowledged.
'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}:
put:
summary: Update an existing Individual Roaming Analytics Subscription resource.
operationId: UpdateNwdafRoamingAnalyticsSubscription
tags:
- Individual NWDAF Roaming Analytics Subscription resource (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RoamingAnalyticsSubscription'
parameters:
- name: subscriptionId
in: path
description: String identifying a subscription to the Nnwdaf_RoamingAnalytics service.
required: true
schema:
type: string
responses:
'200':
description: >
The Individual NWDAF Roaming Analytics Subscription resource was modified successfully
and a representation of that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/RoamingAnalyticsSubscription'
'204':
description: >
The Individual NWDAF Roaming Analytics Subscription resource was modified
successfully.
'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'
'501':
$ref: 'TS29571_CommonData.yaml#/components/responses/501'
'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: Delete an existing Individual NWDAF Roaming Analytics Subscription.
operationId: DeleteNwdafRoamingAnalyticsSubscription
tags:
- Individual NWDAF Roaming Analytics Subscription (Document)
parameters:
- name: subscriptionId
in: path
description: String identifying a subscription to the Nnwdaf_RoamingAnalytics service
required: true
schema:
type: string
responses:
'204':
description: >
No Content. The Individual NWDAF Roaming Analytics Subscription resource matching the
subscriptionId was 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'
'501':
$ref: 'TS29571_CommonData.yaml#/components/responses/501'
'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:
nnwdaf-roaminganalytics: Access to the Nnwdaf_RoamingAnalytics API
schemas:
RoamingAnalyticsSubscription:
description: Represents a Roaming Analytics subscription.
type: object
properties:
roamEventSubs:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventSubscription'
minItems: 1
description: Represents Roaming Analytics subscription for a specific event.
evtReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
notifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
notifCorrId:
type: string
description: Notification correlation identifier.
consPlmnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
roamEventNotifs:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification'
minItems: 1
description: Contains immediate reports for Roaming Analytics.
failEventReports:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/FailureEventInfo'
minItems: 1
description: Contains information about failed events.
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- roamEventSubs
- notifUri
- notifCorrId
- consPlmnId
RoamingAnalyticsNotification:
description: Represents a Roaming Analytics notification.
type: object
properties:
roamEventNotifs:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification'
minItems: 1
description: Contains Roaming Analytics notification for a specific event.
notifCorrId:
type: string
description: Notification correlation identifier.
termCause:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TermCause'
required:
- roamEventNotifs
- notifCorrId