forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTS29486_VAE_PC5ProvisioningRequirement.yaml
281 lines (281 loc) · 10.8 KB
/
TS29486_VAE_PC5ProvisioningRequirement.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
openapi: 3.0.0
info:
version: 1.0.0-alpha.1
title: VAE_PC5ProvisioningRequirement
description: |
API for VAE_PC5ProvisioningRequirement
© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.486 V17.3.0 V2X Application Enabler (VAE) Services
url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.486/'
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/vae-pc5-prov-req/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
paths:
/subscriptions:
post:
summary: VAE_PC5 Provisioning Requirement resource create service Operation
tags:
- PC5 provisioning requirement subscriptions collection (Document)
operationId: Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisioningRequirement'
required: true
responses:
'201':
description: PC5 Provisioning Requirement Subscription Resource Created
headers:
Location:
description: 'Contains the URI of the newly created resource'
required: true
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisioningRequirement'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
NotifyResutOfMultiOperationPC5Provisioning:
'{$request.body#/notifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
responses:
'204':
description: No Content, Notification was succesfull
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
get:
summary: VAE PC5 Provisioning Requirement Subscription resource read service Operation
tags:
- Individual PC5 Provisioning Requirement Subscription (Document)
operationId: ReadPC5ProvisioningRequirementSubscription
parameters:
- name: subscriptionId
in: path
description: Identifier of an PC5 Provisioning Requirement Subscription resource
required: true
schema:
type: string
responses:
'200':
description: OK. Resource representation is returned
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisioningRequirement'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Updates/replaces an existing subscription resource
tags:
- VAE PC5 Provisioning Requirement Subscription resource put service Operation
operationId: UpdatePC5ProvisioningRequirementSubscription
parameters:
- name: subscriptionId
in: path
description: Identifier of an PC5 Provisioning Requirement Subscription resource
required: true
schema:
type: string
requestBody:
description: Parameters to update/replace the existing subscription
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisioningRequirement'
responses:
'200':
description: OK (Successful update of the subscription)
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisioningRequirement'
'204':
description: No Content (Successful update of the subscription)
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: VAE PC5 Provisioning Requirement Subscription resource delete service Operation
tags:
- Individual PC5 Provisioning Requirement Subscription (Document)
operationId: DeletePC5ProvisioningRequirementSubscription
parameters:
- name: subscriptionId
in: path
required: true
description: Unique ID of the PC5 Provisioning Requirement Subscription n to be deleted
schema:
type: string
responses:
'204':
description: The subscription was terminated successfully.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
ProvisioningRequirement:
description: Represents an Individual PC5 Provisioning Requirement Subscription resource.
type: object
properties:
ueId:
$ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xUeId'
groupId:
$ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xGroupId'
notifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
serviceId:
$ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xServiceId'
appQosReq:
$ref: 'TS29486_VAE_SessionOrientedService.yaml#/components/schemas/AppplicationQosRequirement'
requestTestNotification:
type: boolean
description: Set to true by the NF service consumer to request the VAE server to send a test notification as defined in clause 6.3.5.3. Set to false or omitted otherwise.
websockNotifConfig:
$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- serviceId
Notification:
description: Represents a notificaton of result of PC5 Provisioning Requirement.
type: object
properties:
resourceUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
result:
$ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/Result'
required:
- resourceUri
- result