forked from astm-utm/Protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathutm.yaml
3957 lines (3840 loc) · 143 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: 1.0.0
description: >-
Interface definitions for communication between a UAS Service Supplier (USS)
and a Discovery and Synchronization Service (DSS), as well as for
communication between two USSs.
DSS functionality includes identification of peer UTM USS instances
(managing flight operational intents and constraints). USS functionality
includes sharing details of flight operational intents and constraints.
Note: Unless otherwise specified, fields specified in a message but not
declared in the API must be ignored.
Whenever a object-type field may be omitted, it may also be set to null for
the same effect.
security:
- Authority:
- utm.strategic_coordination
- utm.constraint_management
- utm.constraint_processing
- utm.conformance_monitoring_sa
- utm.availability_arbitration
tags:
- name: Operational intent references
description: >-
Endpoints exposed by the DSS for interaction with references to
operational intents.
- name: Operational intent details
description: >-
Endpoints exposed by USSs for interaction with details of operational
intents.
- 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: Availability
description: Endpoints exposed by the DSS for declaring USS availability.
- name: Logging
description: >-
Pseudo-endpoints not intended to be implemented literally, but rather to
illustrate logging data formats
- 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://auth.example.com/oauth/token
scopes:
utm.strategic_coordination: >-
Client may perform actions encompassed by the strategic
coordination role including strategic conflict detection.
utm.constraint_management: >-
Client may manage (create, edit, and delete) constraints according
to the constraint management role.
utm.constraint_processing: >-
Client may read constraint references from the DSS and details
from the partner USSs according to the constraint processing role.
utm.conformance_monitoring_sa: >-
Client may perform actions encompassed by the conformance
monitoring for situational awareness role.
utm.availability_arbitration: >-
Client may set the availability state of USSs in the DSS.
description: >-
Authorization from, or on behalf of, an authorization authority. This
authority will 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 must 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 string composed of a space-separated list of strings
indicating the scopes granted, per RFC 6749.
* `jti`, according to RFC 7519.
Following the principle of least privilege, only one of the scopes
enumerated in this document should be granted in a single token (though
other scopes may accompany it). The tokens granted by this authority
must protect against reuse of received tokens to impersonate the sender
to other recipients (via use of the `aud` claim or other means).
When using the `aud` claim to protect against the reuse of received
tokens, and absent guidance on behalf of the competent authority to the
contrary, the JWT `aud` claim requested by the client must be included
in each access token and must contain the fully qualified domain name of
the URL the access token will be used to access. For example, if a USS
were querying the endpoint at
https://dss.example.com:8888/rid/v2/dss/identification_service_areas,
the access token included in the request should specify `"aud":
"dss.example.com"`.
Clients must provide these access tokens in an `Authorization` header in
the form `Bearer <token>` in accordance with RFC 6750.
schemas:
UUIDv4Format:
description: >-
String whose format matches a version-4 UUID according to RFC 4122.
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}\-[89abAB][0-9a-fA-F]{3}\-[0-9a-fA-F]{12}$
example: 03e5572a-f733-49af-bc14-8a18bd53ee39
UUIDv7Format:
description: >-
String whose format matches a version-7 UUID according to RFC 9562.
maxLength: 36
minLength: 36
type: string
format: uuid
pattern: >-
^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-7[0-9a-fA-F]{3}\-[89abAB][0-9a-fA-F]{3}\-[0-9a-fA-F]{12}$
example: 0191b794-9628-745a-a598-aa1fcd4a82bf
EntityID:
description: >-
Identifier for an Entity communicated through the DSS. Formatted as a
UUIDv4.
anyOf:
- $ref: '#/components/schemas/UUIDv4Format'
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
EntityVersion:
title: EntityVersion
description: >-
Numeric version of this entity which increments upon each change in the
entity, regardless of whether any field of the entity changes. A USS
with the details of this entity when it was at a particular version does
not need to retrieve the details again until the version changes.
type: integer
format: int32
example: 1
SubscriptionID:
description: >-
Identifier for a subscription communicated through the DSS. Formatted
as a UUIDv4.
anyOf:
- $ref: '#/components/schemas/UUIDv4Format'
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
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
minimum: 0
exclusiveMinimum: true
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 may 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
Polygon:
description: >-
An enclosed area on the earth. The bounding edges of this polygon are
defined to be the shortest paths between connected vertices. This
means, for instance, that the edge between two points both defined at a
particular latitude is not generally contained at that latitude. The
winding order must be interpreted as the order which produces the
smaller area. The path between two vertices is defined to be the
shortest possible path between those vertices. Edges may not cross.
Vertices may not be duplicated. In particular, the final polygon vertex
must not be identical to the first vertex.
required:
- vertices
type: object
properties:
vertices:
minItems: 3
type: array
items:
$ref: '#/components/schemas/LatLngPoint'
LatLngPoint:
description: Point on the earth's surface.
required:
- lat
- lng
type: object
properties:
lng:
$ref: '#/components/schemas/Longitude'
lat:
$ref: '#/components/schemas/Latitude'
Circle:
description: A circular area on the surface of the earth.
type: object
properties:
center:
$ref: '#/components/schemas/LatLngPoint'
radius:
$ref: '#/components/schemas/Radius'
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/SubscriptionID'
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/SubscriptionID'
version:
description: >-
Version of the subscription 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_operational_intents:
description: >-
If true, trigger notifications when operational intents are created,
updated, or deleted. Otherwise, changes in operational intents
should not trigger notifications. The scope
utm.strategic_coordination is required to set this flag true.
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. The scope utm.constraint_processing is
required to set this flag true.
type: boolean
default: false
implicit_subscription:
description: >-
True if this subscription was implicitly created by the DSS via the
creation of an operational intent, and should therefore be deleted
by the DSS when that operational intent is deleted.
type: boolean
default: false
dependent_operational_intents:
description: >-
List of IDs for operational intents that are dependent on this
subscription.
type: array
items:
$ref: '#/components/schemas/EntityID'
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
QuerySubscriptionParameters:
description: >-
Parameters for a request to find subscriptions matching the provided
criteria.
type: object
properties:
area_of_interest:
$ref: '#/components/schemas/Volume4D'
QuerySubscriptionsResponse:
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_operational_intents:
description: >-
If true, trigger notifications when operational intents are created,
updated, or deleted. Otherwise, changes in operational intents
should not trigger notifications. The scope
utm.strategic_coordination is required to set this flag true.
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. The scope utm.constraint_processing is
required to set this flag true.
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'
operational_intent_references:
description: >-
Operational intents in or near the subscription area at the time of
creation/update, if `notify_for_operational_intents` is true.
type: array
items:
$ref: '#/components/schemas/OperationalIntentReference'
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 a 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://uss.example.com/utm
OperationalIntentState:
description: >-
State of an operational intent.
'Accepted': Operational intent is created and shared, but not yet in
use; see standard text for more details.
The create or update request for this operational intent reference must
include a Key containing all OVNs for all relevant Entities.
'Activated': Operational intent is in active use; see standard text for
more details.
The create or update request for this operational intent reference must
include a Key containing all OVNs for all relevant Entities.
'Nonconforming': UA is temporarily outside its volumes, but the
situation is expected to be recoverable; see standard text for more
details.
In this state, the `/uss/v1/operational_intents/{entityid}/telemetry`
USS-USS endpoint should respond, if available, to queries from USS
peers. The create or update request for this operational intent may
omit a Key in this case because the operational intent is being adjusted
as flown and cannot necessarily deconflict.
'Contingent': UA is considered unrecoverably unable to conform with its
coordinate operational intent; see standard text for more details.
This state must transition to Ended. In this state, the
`/uss/v1/operational_intents/{entityid}/telemetry` USS-USS endpoint
should respond, if available, to queries from USS peers. The create or
update request for this operational intent may omit a Key in this case
because the operational intent is being adjusted as flown and cannot
necessarily deconflict.
type: string
enum:
- Accepted
- Activated
- Nonconforming
- Contingent
OperationalIntentReference:
description: >-
The high-level information of a planned or active operational intent
with the URL of a USS to query for details. Note: 'ovn' is returned
ONLY to the USS that created the operational intent but NEVER to other
USS instances.
required:
- id
- manager
- uss_availability
- version
- state
- time_start
- time_end
- uss_base_url
- subscription_id
type: object
properties:
id:
$ref: '#/components/schemas/EntityID'
manager:
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 manager. Used by USSs to reject operational
intent update notifications originating from a USS that does not
manage the operational intent.
uss_availability:
$ref: '#/components/schemas/UssAvailabilityState'
version:
$ref: '#/components/schemas/EntityVersion'
state:
$ref: '#/components/schemas/OperationalIntentState'
ovn:
description: >-
Opaque version number of this operational intent. Populated only
when the OperationalIntentReference is managed by the USS retrieving
or providing it. Not populated when the OperationalIntentReference
is not managed by the USS retrieving or providing it (instead, the
USS must obtain the OVN from the details retrieved from the managing
USS).
anyOf:
- $ref: '#/components/schemas/EntityOVN'
time_start:
description: Beginning time of operational intent.
anyOf:
- $ref: '#/components/schemas/Time'
time_end:
description: End time of operational intent.
anyOf:
- $ref: '#/components/schemas/Time'
uss_base_url:
$ref: '#/components/schemas/OperationalIntentUssBaseURL'
subscription_id:
description: >-
The ID of the subscription that is ensuring the operational intent
manager receives relevant airspace updates.
anyOf:
- $ref: '#/components/schemas/SubscriptionID'
OperationalIntentUssBaseURL:
description: >-
The base URL of a USS implementation that implements the parts of the
USS-USS API necessary for providing the details of this operational
intent, and telemetry during non-conformance or contingency, if
applicable.
anyOf:
- $ref: '#/components/schemas/UssBaseURL'
PutOperationalIntentReferenceParameters:
description: >-
Parameters for a request to create an OperationalIntentReference 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 operational intent.
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. All
volumes, both nominal and off-nominal, must be encompassed in these
extents. However, these extents do not need to match the precise
volumes of the operational intent; a single bounding extent may be
provided instead, for instance.
type: array
items:
$ref: '#/components/schemas/Volume4D'
minItems: 1
key:
description: >-
Proof that the USS creating or mutating this operational intent was
aware of the current state of the airspace, with the expectation
that this operational intent is therefore deconflicted from all
relevant features in the airspace. This field is not required when
declaring an operational intent 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
managing this operational intent is performing the constraint
processing role, which is indicated by whether the subscription
associated with this operational intent triggers notifications for
constraints. The key does not need to contain the OVN for the
operational intent being updated.
anyOf:
- $ref: '#/components/schemas/Key'
state:
$ref: '#/components/schemas/OperationalIntentState'
uss_base_url:
$ref: '#/components/schemas/OperationalIntentUssBaseURL'
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 when the operational intent is in the
Activated, Nonconforming, or Contingent state, then the
`new_subscription` field must be provided in order to provide
notification capability for the operational intent. The
subscription specified by this ID must cover at least the area over
which this operational intent is conducted, and it must provide
notifications for operational intents.
anyOf:
- $ref: '#/components/schemas/EntityID'
new_subscription:
description: >-
If an existing subscription is not specified in `subscription_id`,
and the operational intent is in the Activated, Nonconforming, or
Contingent state, then this field must be populated. When this
field is populated, an implicit subscription will be created and
associated with this operational intent, and will generally be
deleted automatically upon the deletion of this operational intent.
anyOf:
- $ref: '#/components/schemas/ImplicitSubscriptionParameters'
requested_ovn_suffix:
description: >-
This optional field not part of the original F3548 standard API
allows a USS to request a specific OVN when creating or updating an
operational intent.
When creating an operational intent, this enables a USS to
immediately publish the operational intent details with the expected
OVN.
When updating an operational intent, this enables a USS to
immediately make available this new version of the operational
intent details if specifically requested by the remote USS. The USS
must still wait for the DSS receipt to actually publish the new
operational intent details.
This allows USSs to obtain correct operational intent details even
if the DSS takes a long time to respond and/or the USS processing it.
The requested suffix must be a UUIDv7 string containing a timestamp
of the current time. If the suffix is invalid, and notably if the
time is too far in the past or the future, the request will be
rejected. If the suffix is valid, the DSS will set the OVN of the
operational intent to be `{entityid}_{requested_ovn_suffix}`. If no
suffix is set, the DSS will proceed as specified by the standard.
anyOf:
- $ref: '#/components/schemas/UUIDv7Format'
ImplicitSubscriptionParameters:
description: >-
Information necessary to create a subscription to serve a single
operational intent'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 operational
intent must be aware of. This includes, at least, notifications for
relevant changes in operational intents.
anyOf:
- $ref: '#/components/schemas/SubscriptionUssBaseURL'
notify_for_constraints:
description: >-
True if this operational intent's subscription should trigger
notifications when constraints change. Otherwise, changes in
constraints should not trigger notifications. The scope
utm.constraint_processing is required to set this flag true, and a
USS performing the constraint processing role should set this flag
true.
type: boolean
default: false
GetOperationalIntentReferenceResponse:
description: >-
Response to DSS request for the OperationalIntentReference with the
given ID.
required:
- operational_intent_reference
type: object
properties:
operational_intent_reference:
$ref: '#/components/schemas/OperationalIntentReference'
ChangeOperationalIntentReferenceResponse:
description: >-
Response to a request to create, update, or delete an
OperationalIntentReference in the DSS.
required:
- subscribers
- operational_intent_reference
type: object
properties:
subscribers:
description: >-
DSS subscribers that this client now has the obligation to notify of
the operational intent changes just made. This client must call
POST for each provided URL according to the USS-USS
`/uss/v1/operational_intents` path API. The client's own
subscriptions will also be included in this list.
type: array
items:
$ref: '#/components/schemas/SubscriberToNotify'
default: [ ]
operational_intent_reference:
$ref: '#/components/schemas/OperationalIntentReference'
QueryOperationalIntentReferenceParameters:
description: >-
Parameters for a request to find OperationalIntentReferences matching
the provided criteria.
type: object
properties:
area_of_interest:
$ref: '#/components/schemas/Volume4D'
QueryOperationalIntentReferenceResponse:
description: >-
Response to DSS query for OperationalIntentReferences in an area of
interest.
required:
- operational_intent_references
type: object
properties:
operational_intent_references:
description: OperationalIntentReferences in the area of interest.
type: array
items:
$ref: '#/components/schemas/OperationalIntentReference'
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
- manager
- uss_availability
- version
- time_start
- time_end
- uss_base_url
type: object
properties:
id:
$ref: '#/components/schemas/EntityID'
manager:
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 manager. Used by USSs to reject constraint
update notifications originating from a USS that does not manage the
constraint.
uss_availability:
$ref: '#/components/schemas/UssAvailabilityState'
version:
$ref: '#/components/schemas/EntityVersion'
ovn:
description: >-
Opaque version number of this constraint. Populated only when the
ConstraintReference is managed by the USS retrieving or providing
it. Not populated when the ConstraintReference is not managed by
the USS retrieving or providing it (instead, the USS must obtain the
OVN from the details retrieved from the managing 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.
All volumes of the constraint must be encompassed in these extents.
However, these extents do not need to match the precise volumes of
the constraint; a single bounding extent may be provided instead,
for instance.
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
- constraint_reference
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`
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'
QueryConstraintReferenceParameters:
description: >-