-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29675_Nucmf_Provisioning.yaml
331 lines (331 loc) · 12.6 KB
/
TS29675_Nucmf_Provisioning.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
322
323
324
325
326
327
328
329
330
331
openapi: 3.0.0
info:
title: Nucmf_Provisioning
version: 1.2.0-alpha.3
description: |
UCMF_Provisioning Service.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.675 V18.3.0; User Equipment (UE) radio capability provisioning service; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.675/
servers:
- url: '{apiRoot}/nucmf-provisioning/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
- {}
- oAuth2ClientCredentials:
- nucmf-provisioning
paths:
/provisionings:
post:
summary: Create an Individual UE radio capability provisioning
operationId: CreateProvisioning
tags:
- UE radio capability provisionings (Collection)
requestBody:
description: Create new provisionings for a given SCS/AS.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RacsData'
responses:
'201':
description: >
Created. The creation of an Individual UE radio capability provisioning
resource is confirmed and a representation of that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/RacsData'
headers:
Location:
description: Contains the URI of the newly created resource.
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':
description: The RACS data for all RACS IDs were not provisioned successfully.
content:
application/json:
schema:
type: array
items:
$ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport'
minItems: 1
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/provisionings/{provisioningId}:
parameters:
- name: provisioningId
in: path
description: Provisioning ID
required: true
schema:
type: string
get:
summary: Get an Individual UE radio capability provisioning
operationId: GetProvisioning
tags:
- Individual UE radio capability provisioning (Document)
responses:
'200':
description: OK. The provisioning information related to the request URI is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/RacsData'
'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'
patch:
summary: Update (PATCH) an Individual UE radio capability provisioning
operationId: UpdateProvisioning
tags:
- Individual UE radio capability provisioning (Document)
requestBody:
description: Update an existing parameter provisioning.
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/RacsDataPatch'
responses:
'200':
description: >
OK. The Individual UE radio capability provisioning resource is modified
and a representation of that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/RacsData'
'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':
description: The RACS data for all RACS IDs were not provisioned successfully.
content:
application/json:
schema:
type: array
items:
$ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport'
minItems: 1
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'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: Replace (PUT) an Individual UE radio capability provisioning
operationId: ReplaceProvisioning
tags:
- Individual UE radio capability provisioning (Document)
requestBody:
description: Update an existing parameter provisioning.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RacsData'
responses:
'200':
description: >
OK. The Individual UE radio capability provisioning resource is modified and a
representation of that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/RacsData'
'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':
description: The RACS data for all RACS IDs were not provisioned successfully.
content:
application/json:
schema:
type: array
items:
$ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport'
minItems: 1
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'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: Remove an Individual UE radio capability provisioning
operationId: RemoveProvisioning
tags:
- Individual UE radio capability provisioning (Document)
responses:
'204':
description: >
No Content. The Individual UE radio capability resource was successfully removed.
The content shall be empty.
'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: '{tokenUrl}'
scopes:
nucmf-provisioning: Access to the Nucmf_Provisioning API
schemas:
RacsData:
description: Represents a UE radio capability data provided by the NF service consumer.
type: object
properties:
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
racsConfigs:
type: object
additionalProperties:
$ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsConfiguration'
minProperties: 1
description: >
Identifies the configuration related to manufacturer specific UE radio capability.
Each element uniquely identifies an RACS configuration for an RACS ID and is
identified in the map via the RACS ID as key. The response shall include
successfully provisioned RACS data.
racsReports:
type: object
additionalProperties:
$ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport'
minProperties: 1
description: >
Contains the RACS IDs for which the RACS data are not provisioned successfully. The
failure reason is also included. Any string value can be used as a key of the map.
readOnly: true
required:
- racsConfigs
RacsDataPatch:
description: >
Represents a modification of a UE radio capability data provided by the NF service
consumer.
type: object
properties:
racsConfigs:
type: object
additionalProperties:
$ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsConfigurationRm'
minProperties: 1
description: >
Identifies the configuration related to manufacturer specific UE radio
capability. Each element uniquely identifies an RACS configuration for an RACS ID
and is identified in the map via the RACS ID as key.