forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TS29257_UAE_C2OperationModeManagement.yaml
501 lines (480 loc) · 19.3 KB
/
TS29257_UAE_C2OperationModeManagement.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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
openapi: 3.0.0
info:
title: UAE Server C2 Operation Mode Management Service
version: 1.1.0-alpha.2
description: |
UAE Server C2 Operation Mode Management Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.257 V18.3.0; Application layer support for Uncrewed Aerial System (UAS);
UAS Application Enabler (UAE) Server Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/
servers:
- url: '{apiRoot}/uae-c2opmode-mngt/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122
security:
- {}
- oAuth2ClientCredentials: []
paths:
/initiate:
post:
summary: Request the provisioning of C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C).
operationId: InitiateC2OpModeConfig
tags:
- Initiate C2 Operation Mode configuration
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureData'
responses:
'200':
description: >
The communicated C2 Operation Mode configuration information was successfully
received. The response body contains the feedback of the UAE Server on whether
this C2 Operation Mode configuration request is confirmed (i.e. can be undertaken
by the UAE Server) or not.
content:
application/json:
schema:
$ref: '#/components/schemas/C2Result'
'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'
callbacks:
C2OpModeMngtCompletionNotification:
'{$request.body#/notificationUri}/c2mode-mngt-completion':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/C2OpModeMngtCompStatus'
responses:
'204':
description: >
No Content. The notification was succesfull and the C2 Operation Mode
Management Completion status for the concerned UAS (i.e. pair of UAV
and UAV-C) was successfully received and acknowledged by the service consumer.
'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'
SelectedC2CommunicationModeNotification:
'{$request.body#/notificationUri}/inform-selec-c2mode':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SelectedC2CommModeNotif'
responses:
'204':
description: >
No Content. The notification was succesfull and the C2 Communication Mode
selected by the concerned UAS (i.e. pair of UAV and UAV-C) was successfully
received and acknowledged by the service consumer.
'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'
C2CommunicationModeSwitchingNotification:
'{$request.body#/notificationUri}/inform-c2mode-switch':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/C2CommModeSwitchNotif'
responses:
'200':
description: >
OK. The targeted C2 Communication Mode switching for the concerned UAS
(i.e. pair of UAV and UAV-C) is successfully received. The response body
contains the feedback of the service consumer on whether this C2 Communication
Mode switching is confirmed (i.e. validated) or not.
content:
application/json:
schema:
$ref: '#/components/schemas/C2Result'
'204':
description: >
No Content. The targeted C2 Communication Mode switching for the concerned
UAS (i.e. pair of UAV and UAV-C) is successfully received and acknowledged,
and the service consumer does not need to confirm (i.e. validate) it.
'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'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
ConfigureData:
description: >
Represents the parameters to request to provision C2 Operation Mode configuration
information for a UAS (i.e. pair of UAV and UAV-C).
type: object
properties:
uassId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
uasId:
$ref: '#/components/schemas/UasId'
allowedC2CommModes:
type: array
items:
$ref: '#/components/schemas/C2CommMode'
minItems: 1
c2CommModeSwitchTypes:
type: array
items:
$ref: '#/components/schemas/C2CommModeSwitching'
minItems: 1
notificationUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
primaryC2CommMode:
$ref: '#/components/schemas/C2CommMode'
secondaryC2CommMode:
$ref: '#/components/schemas/C2CommMode'
c2SwitchPolicies:
$ref: '#/components/schemas/C2SwitchPolicies'
c2ServiceArea:
$ref: '#/components/schemas/C2ServiceArea'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- uassId
- uasId
- allowedC2CommModes
- c2CommModeSwitchTypes
- notificationUri
- primaryC2CommMode
- c2SwitchPolicies
SelectedC2CommModeNotif:
description: >
Represents information on the C2 Communication Mode selected by a UAS (i.e. pair of
UAV and UAV-C).
type: object
properties:
uasId:
$ref: '#/components/schemas/UasId'
selPrimaryC2CommMode:
$ref: '#/components/schemas/C2CommMode'
selSecondaryC2CommMode:
$ref: '#/components/schemas/C2CommMode'
required:
- uasId
- selPrimaryC2CommMode
C2CommModeSwitchNotif:
description: >
Represents information on the targeted C2 Communication Mode switching for a UAS
(i.e. pair of UAV and UAV-C).
type: object
properties:
uaeServerId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
uasId:
$ref: '#/components/schemas/UasId'
c2CommModeSwitchType:
$ref: '#/components/schemas/C2CommModeSwitching'
switchingCause:
$ref: '#/components/schemas/C2SwitchingCause'
required:
- uaeServerId
- uasId
- c2CommModeSwitchType
C2Result:
description: Represents the result of an action related to C2 of a UAS.
type: object
properties:
c2OpConfirmed:
type: boolean
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- c2OpConfirmed
UasId:
description: Represents the identifier of a UAS (i.e. pair of UAV and UAV-C).
type: object
properties:
groupId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'
individualUasId:
type: array
items:
$ref: '#/components/schemas/UavId'
minItems: 2
oneOf:
- required: [groupId]
- required: [individualUasId]
UavId:
description: Represents the identifier of a UAV (e.g. UAV, UAV-C).
type: object
properties:
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
caaId:
type: string
anyOf:
- required: [gpsi]
- required: [caaId]
C2ServiceArea:
description: Represents a C2 service area.
type: object
properties:
ncgiList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
taiList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
geographicAreaList:
type: array
items:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
oneOf:
- required: [geographicAreaList]
- anyOf:
- required: [ncgiList]
- required: [taiList]
C2OpModeMngtCompStatus:
description: >
Represents the C2 Operation Mode Management Completion status for a UAV
(e.g. UAV, UAV-C).
type: object
properties:
uasId:
$ref: '#/components/schemas/UasId'
status:
$ref: '#/components/schemas/C2OpModeStatus'
required:
- uasId
- status
C2SwitchPolicies:
description: Represents the C2 operation mode switching policies.
type: object
properties:
directC2LinkQualityThrlds:
$ref: '#/components/schemas/C2LinkQualityThrlds'
uuC2LinkQualityThrlds:
$ref: '#/components/schemas/C2LinkQualityThrlds'
C2LinkQualityThrlds:
description: Represents the C2 link quality thresholds.
type: object
properties:
nrRsrpThrldLow:
type: integer
minimum: 0
maximum: 127
nrRsrpThrldHigh:
type: integer
minimum: 0
maximum: 127
nrRsrqThrldLow:
type: integer
minimum: 0
maximum: 127
nrRsrqThrldHigh:
type: integer
minimum: 0
maximum: 127
packetLossThrldLow:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
packetLossThrldHigh:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
# ENUMS:
C2CommMode:
anyOf:
- type: string
enum:
- DIRECT_C2_COMMUNICATION
- NETWORK_ASSISTED_C2_COMMUNICATION
- UTM_NAVIGATED_C2_COMMUNICATION
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the C2 Communication Mode.
Possible values are:
- DIRECT_C2_COMMUNICATION: Indicates Direct C2 Communication mode.
- NETWORK_ASSISTED_C2_COMMUNICATION: Indicates Network-Assisted C2 Communication mode.
- UTM_NAVIGATED_C2_COMMUNICATION: Indicates UTM-Navigated C2 communication mode.
C2CommModeSwitching:
anyOf:
- type: string
enum:
- DIRECT_TO_NETWORK_ASSISTED_C2
- NETWORK_ASSISTED_TO_DIRECT_C2
- DIRECT_TO_UTM_NAVIGATED_C2
- NETWORK_ASSISTED_TO_UTM_NAVIGATED_C2
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the C2 Communication Mode Switching type.
Possible values are:
- DIRECT_TO_NETWORK_ASSISTED_C2: Indicates the C2 Communication Mode switching from Direct
C2 Communication mode to Network-Assisted C2 Communication mode.
- NETWORK_ASSISTED_TO_DIRECT_C2: Indicates the C2 Communication Mode switching from
Network-Assisted C2 Communication mode to Direct C2 Communication mode.
- DIRECT_TO_UTM_NAVIGATED_C2: Indicates the C2 Communication Mode switching from
Direct C2 Communication mode to UTM-Navigated C2 communication mode.
- NETWORK_ASSISTED_TO_UTM_NAVIGATED_C2: Indicates the C2 Communication Mode switching
from Network-Assisted C2 Communication mode to UTM-Navigated C2 communication mode.
C2SwitchingCause:
anyOf:
- type: string
enum:
- DIRECT_LINK_QUALITY_DEGRADATION
- DIRECT_LINK_AVAILABLE
- MOVING_BVLOS
- LOCATION_CHANGE
- TRAFFIC_CONTROL_NEEDED
- SECURITY_REASONS
- OTHER_REASONS
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the C2 Communication Mode switching cause.
Possible values are:
- DIRECT_LINK_QUALITY_DEGRADATION: Indicates that the C2 Communication Mode switching
was triggered due to a degradation in the direct radio link quality.
- DIRECT_LINK_AVAILABLE: Indicates that the C2 Communication Mode switching was triggered
due to the availability of a direct link, i.e. direct radio link quality enables its
usage.
- MOVING_BVLOS: Indicates that the C2 Communication Mode switching was triggered due to
the UAV moving BVLOS.
- LOCATION_CHANGE: Indicates that the C2 Communication Mode switching was triggered due to
an actual or expected location/mobility of the UAV (e.g. which impacts the UAV-to-UAV-C
location).
- TRAFFIC_CONTROL_NEEDED: Indicates that the C2 Communication Mode switching was triggered
due to the necessity to have air traffic control.
- SECURITY_REASONS: Indicates that the C2 Communication Mode switching was triggered due to
security reasons.
- OTHER_REASONS: Indicates that the C2 Communication Mode switching was triggered due to
other reasons (e.g. unpredictable event, unknown reason, weather conditions, topography,
etc.).
C2OpModeStatus:
anyOf:
- type: string
enum:
- SUCCESSFUL
- NOT_SUCCESSFUL
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the C2 operation mode management completion status.
Possible values are:
- SUCCESSFUL: Indicates that the C2 operation mode configuration was successful.
- NOT_SUCCESSFUL: Indicates that the C2 operation mode configuration was not successful.