forked from astm-utm/Protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
utm.yaml
2760 lines (2619 loc) · 101 KB
/
utm.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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
openapi: 3.0.2
info:
title: UTM API (USS->DSS and USS->USS)
version: 0.3.7
description: |-
Interface definitions for 'Discovery and Synchronization Service' (DSS) and 'UAS Service Supplier (USS).
DSS functionality includes identification of peer UTM USS instances (managing flight operations and constraints).
USS functionality includes sharing details of flight operations and constraints.
Note: Unless otherwise specified, fields specified in a message but not declared in the API shall be ignored.
security:
- Authority:
- utm.strategic_coordination
- utm.constraint_management
- utm.constraint_consumption
tags:
- name: "Operation references"
description: |-
Endpoints exposed by the DSS for interaction with references to Operations.
- name: "Operation details"
description: |-
Endpoints exposed by USSs for interaction with details of Operations.
- name: "Constraint references"
description: |-
Endpoints exposed by the DSS for interaction with references to Constraints.
- name: "Constraint details"
description: |-
Endpoints exposed by USSs for interaction with details of Constraints.
- name: "Subscriptions"
description: |-
Endpoints exposed by the DSS for interaction with Subscription entities.
- name: "Reports"
description: |-
Endpoints exposed by the DSS for reporting peer DSS issues.
- name: dss
description: Endpoints exposed by the DSS server.
- name: p2p_utm
description: Endpoints exposed by UTM USSs for peer-peer communication.
#
#
#
components:
securitySchemes:
Authority:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://token_vendor.com/oauth/token
scopes:
utm.strategic_coordination: |-
Client may perform planning, strategic conflict detection, and conformance monitoring activities, including reading information about Constraints.
utm.constraint_management: |-
Client may manage (create, edit, and delete) Constraints they own.
utm.constraint_consumption: |-
Client may read Constraints from the DSS (references) and partner USSs (details).
description: |-
Authorization from, or on behalf of, an authorization authority. This authority shall issue access tokens that are JSON Web Tokens as defined in RFC 7519, using the `RS256` algorithm for the signature, publish to all providers the public key for verifying that signature, and implement standard OAuth server discovery mechanisms as described in RFC 8414.
The following fields shall be included in the JWT claim for access tokens issued by this authority:
* `iss`, with the URL at which the token generation request was received.
* `exp`, with a time no further than 1 hour in the future.
* `sub`, with unique ID of the client requesting the access token.
* `scope`, with a list of space-separated strings (per RFC 6749) indicating the scopes granted.
* `jti`, according to RFC 7519.
Following the principle of least privilege, only one of the scopes enumerated in this document shall be granted in a single token (though other scopes may accompany it). The tokens granted by this authority shall protect against reuse of received tokens to impersonate the sender to other recipients (via use of the `aud` claim or other means).
Clients shall provide these access tokens in an `Authorization` header in the form `Bearer <token>` in accordance with RFC 6750.
schemas:
UUIDv4:
description: |-
Universally-unique identifier (version 4).
maxLength: 36
minLength: 36
type: string
format: uuid
pattern: >-
'^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-4[0-9a-fA-F]{3}\\-[8-b][0-9a-fA-F]{3}\\-[0-9a-fA-F]{12}$'
example: '03e5572a-f733-49af-bc14-8a18bd53ee39'
EntityUUID:
description: |-
Universally-unique identifier for an Entity communicated through
the DSS. Formatted as UUIDv4.
anyOf:
- $ref: '#/components/schemas/UUIDv4'
example: '2f8343be-6482-4d1b-a474-16847e01af1e'
EntityOVN:
title: EntityOVN
description: |-
A token associated with a particular UTM Entity+version created
by the DSS upon creation or modification of an Entity reference and provided
to the client creating or modifying the Entity reference. The EntityOVN
is stored privately by the DSS and then compared against entries in a Key
provided to mutate the airspace. The EntityOVN is also provided by
the client whenever that client transmits the full information of the Entity
(either via GET, or via a subscription notification).
type: string
minLength: 16
maxLength: 128
example: '9d158f59-80b7-4c11-9c0c-8a2b4d936b2d'
SubscriptionUUID:
description: |-
Universally-unique identifier for a Subscription communicated through
the DSS. Formatted as UUIDv4.
anyOf:
- $ref: '#/components/schemas/UUIDv4'
example: '78ea3fe8-71c2-4f5c-9b44-9c02f5563c6f'
Key:
description: |
Proof that a client has obtained the latest airspace content, used to ensure that write
operations to the DSS occur only when the latest content is known (i.e. has been read). The
client is required to pass a current Key constructed from information obtained with
previous read operations and subsequent requests for full information, and optionally,
subscription updates for deconflicted write operations to the DSS. The contents of this
data structure are generated by the client.
type: array
items:
$ref: '#/components/schemas/EntityOVN'
default: []
Time:
required:
- value
- format
type: object
properties:
value:
type: string
description: RFC3339-formatted time/date string. The time zone must be 'Z'.
format: date-time
example: '1985-04-12T23:20:50.52Z'
format:
type: string
enum:
- RFC3339
CircleProperties:
required:
- radius
type: object
properties:
radius:
$ref: '#/components/schemas/Radius'
Radius:
required:
- value
- units
type: object
properties:
value:
format: float
description: Distance from the centerpoint of a circular area, along the WGS84 ellipsoid.
type: number
example: 300.183
units:
type: string
description: FIXM-compatible units. Only meters ("M") are acceptable for UTM.
enum:
- M
Altitude:
type: object
required:
- value
- reference
- units
properties:
value:
description: |-
The numeric value of the altitude. Note that min and max values are
added as a sanity check. As use cases evolve and more options are
made available in terms of units of measure or reference systems,
these bounds should be re-evaluated.
type: number
format: double
minimum: -8000
exclusiveMinimum: false
maximum: 100000
exclusiveMaximum: false
reference:
description: |-
A code indicating the reference for a vertical distance. See AIXM 5.1
and FIXM 4.2.0. Currently, UTM only allows WGS84 with no immediate
plans to allow other options. FIXM and AIXM allow for 'SFC' which is
equivalent to AGL.
type: string
enum:
- W84
units:
description: |-
The reference quantities used to express the value of altitude. See
FIXM 4.2. Currently, UTM only allows meters with no immediate plans
to allow other options.
type: string
enum:
- M
Latitude:
description: Degrees of latitude north of the equator, with reference to the WGS84 ellipsoid.
maximum: 90
exclusiveMaximum: false
minimum: -90
exclusiveMinimum: false
type: number
format: double
example: 34.123
Longitude:
description: Degrees of longitude east of the Prime Meridian, with reference to the WGS84 ellipsoid.
minimum: -180
exclusiveMaximum: false
maximum: 180
exclusiveMinimum: false
type: number
format: double
example: -118.456
LongitudeOrLatitude:
description: |-
Longitude (degrees east of the Prime Meridian or degrees, with reference to the WGS84 ellipsoid) or Latitude
(degrees north of the equator, with reference to the WGS84 ellipsoid).
minimum: -180
exclusiveMinimum: false
maximum: 180
exclusiveMaximum: false
type: number
format: double
example: 12.34
LonLatPair:
description: Longitude/Latitude pair (in that order) used for specifying geographical vertex. Specified as an array. Order is important!
type: array
maxItems: 2
minItems: 2
items:
$ref: '#/components/schemas/LongitudeOrLatitude'
example: [-122.106325, 47.660898]
#
# GeoJSON definitions
#
# Original version: https://gist.github.com/bubbobne/fe5f2db65acf039be6a9fd92fc9c7233
# Edits by [email protected]
#MIT License
#Copyright (c) 2017 Daniele Andreis
#Permission is hereby granted, free of charge, to any person obtaining a copy
#of this software and associated documentation files (the "Software"), to deal
#in the Software without restriction, including without limitation the rights
#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
#copies of the Software, and to permit persons to whom the Software is
#furnished to do so, subject to the following conditions:
#
#
#The above copyright notice and this permission notice shall be included in all
#copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
#SOFTWARE.
Point:
type: object
description: GeoJSon Point, limited to 2D.
externalDocs:
url: https://tools.ietf.org/html/rfc7946#section-3.1.2
properties:
type:
description: The type of Geometry. In this case, must be 'Point' per GeoJSON spec.
type: string
enum:
- Point
coordinates:
$ref: '#/components/schemas/LonLatPair'
Polygon:
type: object
required:
- type
- coordinates
description: GeoJSon Polygon. Positions all 2D.
externalDocs:
url: https://tools.ietf.org/html/rfc7946#section-3.1.6
properties:
type:
description: |
The type of Geometry. In this case, must be 'Polygon' per GeoJSON
spec. Note that the "coordinates" member is validated to be be an
array of size one. This implies there are no interior rings allowed
currently.
type: string
enum:
- Polygon
coordinates:
type: array
description: >-
The number of polygons allowed. Currently 1, implying no interior
rings. If this number is changes, the maxItems should be considered.
From RFC7946:
o For type "Polygon", the "coordinates" member MUST be an array of
linear ring coordinate arrays.
o For Polygons with more than one of these rings, the first MUST be
the exterior ring, and any others MUST be interior rings. The
exterior ring bounds the surface, and the interior rings (if
present) bound holes within the surface.
Again, note we only allow a single set of coordinates, implying no
interior rings.
minItems: 1
maxItems: 1
items:
type: array
description: >-
The number of vertices in this polygon. From RFC7946:
o A linear ring is a closed LineString with four or more positions.
o The first and last positions are equivalent, and they MUST contain
identical values; their representation SHOULD also be identical.
o A linear ring is the boundary of a surface or the boundary of a
hole in a surface.
o A linear ring MUST follow the right-hand rule with respect to the
area it bounds, i.e., exterior rings are counterclockwise, and
holes are clockwise. (also in the spec: parsers SHOULD NOT reject
Polygons that do not follow the right-hand rule.)
https://tools.ietf.org/html/rfc7946#section-3.1.6
minItems: 4
maxItems: 100
items:
$ref: '#/components/schemas/LonLatPair'
Circle:
description: |-
Local extension of the GeoJSON specification to add a circular area defined by a
Point/Radius pair. We extend the Properties object to include a 'radius' value (see
CircleProperties for details).
required:
- type
- geometry
- properties
type: object
properties:
type:
description: The type of Geometry. In this case, must be 'Feature' per GeoJSON spec.
type: string
enum:
- Feature
geometry:
type: object
properties:
type:
description: The type of Geometry. Must be Point.
type: string
enum:
- Point
coordinates:
$ref: '#/components/schemas/LonLatPair'
properties:
$ref: '#/components/schemas/CircleProperties'
#
# End of GeoJSON definitions
#
Volume3D:
description: |-
A three-dimensional geographic volume consisting of a vertically-extruded shape. Exactly
one outline must be specified.
type: object
properties:
outline_circle:
anyOf:
- $ref: '#/components/schemas/Circle'
description: A circular geographic shape on the surface of the earth.
outline_polygon:
anyOf:
- $ref: '#/components/schemas/Polygon'
description: A polygonal geographic shape on the surface of the earth.
altitude_lower:
description: Minimum bounding altitude of this volume. Must be less than
altitude_upper, if specified.
anyOf:
- $ref: '#/components/schemas/Altitude'
altitude_upper:
description: Maximum bounding altitude of this volume. Must be greater than
altitude_lower, if specified.
anyOf:
- $ref: '#/components/schemas/Altitude'
Volume4D:
description: Contiguous block of geographic spacetime.
required:
- volume
type: object
properties:
volume:
$ref: '#/components/schemas/Volume3D'
time_start:
description: Beginning time of this volume. Must be before time_end.
anyOf:
- $ref: '#/components/schemas/Time'
time_end:
description: End time of this volume. Must be after time_start.
anyOf:
- $ref: '#/components/schemas/Time'
ErrorResponse:
description: |-
Human-readable string returned when an error occurs
as a result of a USS - DSS transaction.
type: object
properties:
message:
description: |-
Human-readable message indicating what error occurred and/or why.
type: string
example: 'The error occurred because [...]'
SubscriptionState:
description: |-
State of Subscription which is causing a notification to be sent.
required:
- subscription_id
- notification_index
type: object
properties:
subscription_id:
$ref: '#/components/schemas/SubscriptionUUID'
notification_index:
$ref: '#/components/schemas/SubscriptionNotificationIndex'
SubscriberToNotify:
description: |-
Subscriber to notify of a change in the airspace. This is provided by the DSS
to a client changing the airspace, and it is the responsibility of that client
to send a notification to the specified USS according to the change made to the
airspace.
required:
- subscriptions
- uss_base_url
type: object
properties:
subscriptions:
description: Subscription(s) prompting this notification.
type: array
items:
$ref: '#/components/schemas/SubscriptionState'
minItems: 1
uss_base_url:
$ref: '#/components/schemas/SubscriptionUssBaseURL'
Subscription:
description: |-
Specification of a geographic area that a client is interested
in on an ongoing basis (e.g., "planning area").
required:
- id
- version
- notification_index
- uss_base_url
type: object
properties:
id:
$ref: '#/components/schemas/SubscriptionUUID'
version:
description: |-
Version that the DSS changes every time a USS changes the Subscription. The DSS
incrementing the notification_index does not constitute a change that triggers a
new version. A USS must specify this version when modifying an existing
Subscription to ensure consistency in read-modify-write operations and distributed
systems.
type: string
notification_index:
$ref: '#/components/schemas/SubscriptionNotificationIndex'
time_start:
description: |-
If set, this subscription will not receive notifications involving airspace changes
entirely before this time.
anyOf:
- $ref: '#/components/schemas/Time'
time_end:
description: |-
If set, this subscription will not receive notifications involving airspace changes
entirely after this time.
anyOf:
- $ref: '#/components/schemas/Time'
uss_base_url:
$ref: '#/components/schemas/SubscriptionUssBaseURL'
notify_for_operations:
description: If true, trigger notifications when Operations are created, updated, or deleted. Otherwise, changes in Operations should not trigger notifications.
type: boolean
default: false
notify_for_constraints:
description: If true, trigger notifications when Constraints are created, updated, or deleted. Otherwise, changes in Constraints should not trigger notifications.
type: boolean
default: false
implicit_subscription:
description: |-
True if this Subscription was implicitly created by the DSS via the creation of an
Operation, and should therefore be deleted by the DSS when that Operation is deleted.
type: boolean
default: false
dependent_operations:
description: List of Operations (UUIDs) that are dependent on this Subscription.
type: array
items:
$ref: '#/components/schemas/EntityUUID'
default: []
SubscriptionNotificationIndex:
format: int32
description: Tracks the notifications sent for a subscription so the subscriber
can detect missed notifications more easily.
type: integer
minimum: 0
exclusiveMinimum: false
default: 0
SearchSubscriptionParameters:
description: |-
Parameters for a request to find Subscriptions matching the provided criteria.
type: object
properties:
area_of_interest:
$ref: '#/components/schemas/Volume4D'
SearchSubscriptionsResponse:
description: Response to DSS query for subscriptions in a particular geographic area.
required:
- subscriptions
type: object
properties:
subscriptions:
description: Subscriptions that overlap the specified geographic area.
type: array
items:
$ref: '#/components/schemas/Subscription'
default: []
GetSubscriptionResponse:
description: Response to DSS request for the subscription with the given id.
required:
- subscription
type: object
properties:
subscription:
$ref: '#/components/schemas/Subscription'
PutSubscriptionParameters:
description: |-
Parameters for a request to create/update a subscription in the DSS. At least one form of
notifications must be requested.
required:
- extents
- uss_base_url
type: object
properties:
extents:
description: |-
Spacetime extents of the volume to subscribe to.
This subscription will automatically be deleted after its end time if it has not been
refreshed by then. If end time is not specified, the value will be chosen automatically
by the DSS. If start time is not specified, it will default to the time the request is
processed. The end time may not be in the past.
Note that some Entities triggering notifications may lie entirely outside the requested
area.
anyOf:
- $ref: '#/components/schemas/Volume4D'
uss_base_url:
$ref: '#/components/schemas/SubscriptionUssBaseURL'
notify_for_operations:
description: If true, trigger notifications when Operations are created, updated, or deleted. Otherwise, changes in Operations should not trigger notifications.
type: boolean
default: false
notify_for_constraints:
description: If true, trigger notifications when Constraints are created, updated, or deleted. Otherwise, changes in Constraints should not trigger notifications.
type: boolean
default: false
SubscriptionUssBaseURL:
description: |-
The base URL of a USS implementation of the parts of the USS-USS API necessary for
receiving the notifications requested by this Subscription.
anyOf:
- $ref: '#/components/schemas/UssBaseURL'
PutSubscriptionResponse:
description: |-
Response for a request to create or update a subscription.
required:
- subscription
type: object
properties:
subscription:
$ref: '#/components/schemas/Subscription'
operation_references:
description: |-
Operations in or near the subscription area at the time of creation/update,
if `notify_for_operations` is true.
type: array
items:
$ref: '#/components/schemas/OperationReference'
default: []
constraint_references:
description: |-
Constraints in or near the subscription area at the time of creation/update,
if `notify_for_constraints` is true.
type: array
items:
$ref: '#/components/schemas/ConstraintReference'
default: []
DeleteSubscriptionResponse:
description: Response for a successful request to delete an Subscription.
required:
- subscription
type: object
properties:
subscription:
$ref: '#/components/schemas/Subscription'
UssBaseURL:
description: |-
The base URL of a USS implementation of part or all of the USS-USS API. Per the USS-USS API, the full URL
of a particular resource can be constructed by appending, e.g., `/uss/v1/{resource}/{id}` to this base URL.
Accordingly, this URL may not have a trailing '/' character.
type: string
example: 'https://utm_uss.com/utm'
OperationState:
description: |-
State of an Operation.
'Accepted': This Operation was fully deconflicted from other Entities at the time it changed to this
state, but no aircraft associated with it are active yet. The create or update request for this
Operation reference must include a Key containing all OVNs for all relevant Entities.
'Activated': One or more aircraft associated with this Operation are, or will imminently be, in
flight. The create or update request for this Operation reference must include a Key containing
all OVNs for all relevant Entities.
'NonConforming': This Operation is outside of the planned volume. The new or updated volumes MUST
contain the actual position of the aircraft. In this state, the `/uss/v1/operations/{entityuuid}/telemetry'
USS-USS endpoint should respond, if available, to queries from USS peers. The create or update request
for this Operation may omit a Key in this case because the Operation is being adjusted as flown and
cannot necessarily deconflict.
'Contingent': This Operation is executing a contingency action, either because it has been
NonConforming for a certain period of time, or because of operator initiation. This state must
transition to Ended. The new or updated volumes MUST contain the actual position of the aircraft.
In this state, the `/uss/v1/operations/{entityuuid}/telemetry' USS-USS endpoint should respond, if available,
to queries from USS peers. The create or update request for this Operation may omit a Key in this
case because the Operation is being adjusted as flown and cannot necessarily deconflict.
'Ended': This Operation has ended (due to either an Operator-induced change or flight completion).
Note that an Operation may not be updated to this state in the DSS; instead, the USS should DELETE
the Operation reference to indicated that the Operation has ended.
type: string
enum:
- Accepted
- Activated
- NonConforming
- Contingent
- Ended
OperationReference:
description: |-
The high-level information of a planned or active Operation with the URL
of a USS to query for details. Note: 'OVN' is returned ONLY to the USS that
created the Operation but NEVER to other USS instances.
required:
- id
- owner
- time_start
- time_end
- uss_base_url
- subscription_id
type: object
properties:
id:
$ref: '#/components/schemas/EntityUUID'
owner:
type: string
example: 'uss1'
description: |-
Created by the DSS based on creating client's ID (via access token). Used internal
to the DSS for restricting mutation and deletion operations to owner. Used by USSs
to reject Operation update notifications originating from a USS that does not own
the Operation.
ovn:
description: |-
Opaque version number of this Operation. Populated only when the OperationReference
is owned by the USS retrieving or providing it. Not populated when the
OperationReference is not owned by the USS retrieving or providing it (instead, the
USS must obtain the OVN from the details retrieved from the owning USS).
anyOf:
- $ref: '#/components/schemas/EntityOVN'
time_start:
description: Beginning time of Operation.
anyOf:
- $ref: '#/components/schemas/Time'
time_end:
description: End time of Operation.
anyOf:
- $ref: '#/components/schemas/Time'
uss_base_url:
$ref: '#/components/schemas/OperationUssBaseURL'
subscription_id:
description: |-
The ID of the Subscription that is ensuring the Operation owner receives relevant
airspace updates.
anyOf:
- $ref: '#/components/schemas/SubscriptionUUID'
OperationUssBaseURL:
description: |-
The base URL of a USS implementation that implements the parts of the USS-USS API necessary for
providing the details of this Operation, and telemetry during non-conformance or contingency,
if applicable.
anyOf:
- $ref: '#/components/schemas/UssBaseURL'
PutOperationReferenceParameters:
description: |-
Parameters for a request to create an OperationReference in the DSS.
A subscription to changes overlapping this volume may be implicitly created, but
this can be overridden by providing the (optional) 'subscription_id' to use.
Note: The implicit subscription is managed by the DSS, not the USS.
required:
- extents
- state
- uss_base_url
type: object
properties:
extents:
description: |-
Spacetime extents that bound this Operation.
Start and end times, as well as lower and upper altitudes, are required for each
volume. The end time may not be in the past.
type: array
items:
$ref: '#/components/schemas/Volume4D'
minItems: 1
key:
description: |-
Proof that the USS creating or mutating this Operation was aware of the current state of the
airspace, with the expectation that this Operation is therefore deconflicted from all relevant
features in the airspace. This field is not required when declaring an Operation NonConforming
or Contingent, or when there are no relevant Entities in the airspace, but is otherwise required.
OVNs for Constraints are required if and only if the USS owning this Operation is considering
Constraints, which is determined by whether the Subscription associated with this Operation
triggers notifications for Constraints. The key does not need to contain the OVN for an
Operation being updated.
anyOf:
- $ref: '#/components/schemas/Key'
state:
$ref: '#/components/schemas/OperationState'
uss_base_url:
$ref: '#/components/schemas/OperationUssBaseURL'
subscription_id:
description: |-
The ID of an existing Subscription that the USS will use to keep the operator informed about
updates to relevant airspace information. If this field is not provided, then the
`new_subscription` field must be provided in order to provide notification capability
for the Operation. The Subscription specified by this ID must cover at least the area over
which this Operation is conducted, and it must provide notifications for Operations.
anyOf:
- $ref: '#/components/schemas/EntityUUID'
new_subscription:
description: |-
If an existing Subscription is not specified in `subscription_id`, then this field must be
populated. When this field is populated, an implicit Subscription will be created and
associated with this Operation, and will generally be deleted automatically upon the
deletion of this Operation.
anyOf:
- $ref: '#/components/schemas/ImplicitSubscriptionParameters'
ImplicitSubscriptionParameters:
description: |-
Information necessary to create a Subscription to serve a single Operation's notification needs.
type: object
required:
- uss_base_url
properties:
uss_base_url:
description: |-
The base URL of a USS implementation of the parts of the USS-USS API necessary for
receiving the notifications that the Operation must be aware of. This includes, at least,
notifications for relevant changes in Operations.
anyOf:
- $ref: '#/components/schemas/SubscriptionUssBaseURL'
notify_for_constraints:
description: |-
True if this Operation's Subscription should trigger notifications when Constraints change. Otherwise, changes in Constraints should not trigger notifications.
type: boolean
default: false
GetOperationReferenceResponse:
description: |-
Response to DSS request for the OperationReference with the given ID.
required:
- operation_reference
type: object
properties:
operation_reference:
$ref: '#/components/schemas/OperationReference'
ChangeOperationReferenceResponse:
description: |-
Response to a request to create, update, or delete an OperationReference
in the DSS.
required:
- subscribers
- operation_reference
type: object
properties:
subscribers:
description: |-
DSS subscribers that this client now has the obligation to
notify of the Operation changes just made. This client must call POST
for each provided URL according to the USS-USS `/uss/v1/operations/{entityuuid}`
path API. The client's own Subscriptions will also be included in this list.
type: array
items:
$ref: '#/components/schemas/SubscriberToNotify'
default: []
operation_reference:
$ref: '#/components/schemas/OperationReference'
SearchOperationReferenceParameters:
description: |-
Parameters for a request to find OperationReferences matching the provided criteria.
type: object
properties:
area_of_interest:
$ref: '#/components/schemas/Volume4D'
SearchOperationReferenceResponse:
description: Response to DSS query for OperationReferences in an area of interest.
required:
- operation_references
type: object
properties:
operation_references:
description: OperationReferences in the area of interest.
type: array
items:
$ref: '#/components/schemas/OperationReference'
default: []
ConstraintReference:
description: A ConstraintReference (area in which a Constraint is present, along
with other high-level information, but no details). The DSS reports only
these references and clients must exchange details and additional information
peer-to-peer.
required:
- id
- owner
- time_start
- time_end
- uss_base_url
type: object
properties:
id:
$ref: '#/components/schemas/EntityUUID'
owner:
type: string
example: 'uss1'
description: |-
Created by the DSS based on creating client's ID (via access token). Used internal
to the DSS for restricting mutation and deletion operations to owner. Used by USSs
to reject Constraint update notifications originating from a USS that does not own
the Constraint.
ovn:
description: |-
Opaque version number of this Constraint. Populated only when the ConstraintReference
is owned by the USS retrieving or providing it. Not populated when the
ConstraintReference is not owned by the USS retrieving or providing it (instead, the
USS must obtain the OVN from the details retrieved from the owning USS).
anyOf:
- $ref: '#/components/schemas/EntityOVN'
time_start:
$ref: '#/components/schemas/Time'
time_end:
$ref: '#/components/schemas/Time'
uss_base_url:
$ref: '#/components/schemas/ConstraintUssBaseURL'
ConstraintUssBaseURL:
description: |-
The base URL of a USS implementation that implements the parts of the USS-USS API necessary for
providing the details of this Constraint.
anyOf:
- $ref: '#/components/schemas/UssBaseURL'
PutConstraintReferenceParameters:
description: Parameters for a request to create/update a ConstraintReference in the
DSS.
required:
- extents
- uss_base_url
type: object
properties:
extents:
description: |-
Spacetime extents that bound this Constraint.
The end time may not be in the past.
type: array
items:
$ref: '#/components/schemas/Volume4D'
minItems: 1
uss_base_url:
$ref: '#/components/schemas/ConstraintUssBaseURL'
GetConstraintReferenceResponse:
description: Response to DSS request for the ConstraintReference with the given
ID.
required:
- constraint_reference
type: object
properties:
constraint_reference:
$ref: '#/components/schemas/ConstraintReference'
ChangeConstraintReferenceResponse:
description: Response to a request to create, update, or delete a ConstraintReference.
in the DSS.
required:
- subscribers
type: object
properties:
subscribers:
description: DSS subscribers that this client now has the obligation to
notify of the Constraint changes just made. This client must call POST
for each provided URL according to the USS-USS `/uss/v1/constraints/{entityuuid}`
path API. The client's own Subscriptions will also be included in this list.
type: array
items:
$ref: '#/components/schemas/SubscriberToNotify'
default: []
constraint_reference:
$ref: '#/components/schemas/ConstraintReference'
SearchConstraintReferenceParameters:
description: |-
Parameters for a request to find ConstraintReferences matching the provided criteria.
type: object
properties:
area_of_interest:
$ref: '#/components/schemas/Volume4D'
SearchConstraintReferencesResponse:
description: Response to DSS query for ConstraintReferences in an area of interest.
required:
- constraint_references
type: object
properties:
constraint_references:
description: ConstraintReferences in the area of interest.
type: array
items:
$ref: '#/components/schemas/ConstraintReference'
default: []
EntityReference:
description: Reference to a generic Entity known to the DSS.
type: object
properties:
operation_reference:
$ref: '#/components/schemas/OperationReference'
constraint_reference:
$ref: '#/components/schemas/ConstraintReference'
AirspaceConflictResponse:
description: Data provided when an airspace conflict was encountered.
type: object
properties:
message:
description: Human-readable message indicating what error occurred and/or