You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The base URL (protocol://hostname/path) where USS Operation data is retrieved. This URL may not have a trailing '/' character.
567
-
The path `/v1/operations/{id}` will be appended to this string to form the complete URL.
568
-
(See `GET /v1/operations/`, `GET /v1/operations/{id}`, and `GET /v1/operations/{id}/telemetry` for more information.)
599
+
The base URL of a USS implementation of (at least) the GET Operation details portion of the USS-USS API.
600
+
Per the USS-USS API, the full URL to retrieve the details of an Operation with a particular {id} can
601
+
be constructed by appending `/v1/operations/{id}` to this base URL. Accordingly, this URL may
602
+
not have a trailing '/' character. At times when telemetry is available for this operation, it may
603
+
be retrieved at `{QueryOperationBaseURL}/v1/operations/{id}/telemetry`. See
604
+
`GET /v1/operations/{id}` and `GET /v1/operations/{id}/telemetry` in the USS-USS API for more information.
569
605
type: string
570
606
example: 'https://uss.com/utm'
571
607
572
608
NotifyOperationDetailsURL:
573
609
description: |-
574
-
The base URL (protocol://hostname/path) where USS Operation data is received. This URL may not have a trailing '/' character.
575
-
The path `/v1/operations/{id}` will be appended to this string to form the complete URL.
576
-
(See `PUT /v1/operations/{id}` and `DELETE /v1/operations/{id}` for more information.)
610
+
The base URL of a USS implementation of (at least) the PUT Operation details portion of the USS-USS API.
611
+
Per the USS-USS API, the full URL to notify the implementing USS of updated details for an Operation
612
+
with a particular {id} can be constructed by appending `/v1/operations/{id}` to this base URL.
613
+
Accordingly, this URL may not have a trailing '/' character. See `PUT /v1/operations/{id}` and
614
+
`DELETE /v1/operations/{id}` in the USS-USS API for more information.
577
615
type: string
578
616
example: 'https://uss.com/utm'
579
617
580
618
OperationCallbacks:
581
619
description: |-
582
-
Endpoints that should be called when an applicable event occurs.
583
-
All fields are required.
620
+
Endpoints that should be called when an applicable event occurs to ensure the
621
+
Operator remains aware of relevant airspace information.
622
+
This field should be populated there is no existing Subscription provided in
623
+
`subscription_id` is not provided. If provided, this
624
+
information will be used to create an implicit Subscription associated with this Operation.
584
625
required:
585
626
- query_details_url
586
627
- notify_feedback_url
@@ -595,13 +636,13 @@ components:
595
636
description: |-
596
637
State of an Operation.
597
638
598
-
'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.
639
+
'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 must include a Key containing all OVNs for all relevant Entities.
599
640
600
-
'Activated': One or more aircraft associated with this Operation are, or will imminently be, in flight.
641
+
'Activated': One or more aircraft associated with this Operation are, or will imminently be, in flight. The create or update request for this Operation must include a Key containing all OVNs for all relevant Entities.
601
642
602
-
'NonConforming': This Operation is outside of the planned volume. A new volume MUST be submitted to the DSS. In this state, the {query-operation-details}/{id}/telemetry' endpoint MUST respond (if possible) to queries from USS peers.
643
+
'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 `/v1/operation_details/{id}/telemetry' USS-USS endpoint MUST respond (if possible) 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.
603
644
604
-
'Contingent': (Also known as ROGUE). This Operation has been NON-CONFORMING for a certain period of time. This state must transition to ENDED. A new volume MUST be submitted to the DSS. In this state, the {query-operation-details}/{id}/telemetry' endpoint MUST respond (if possible) to queries from USS peers.
645
+
'Contingent': This Operation is executing a contingency action, either because is 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 `/v1/operation_details/{id}/telemetry' USS-USS endpoint MUST respond (if possible) 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.
605
646
606
647
'Ended': This Operation has ended (due to either an Operator-induced change or flight completion).
607
648
type: string
@@ -614,7 +655,7 @@ components:
614
655
615
656
OperationReference:
616
657
description: |-
617
-
The high-level information of a planned/active Operation with the URL
658
+
The high-level information of a planned or active Operation with the URL
618
659
of a USS to query for details. Note: 'OVN' is returned ONLY to the USS that
619
660
created the Operation but NEVER to other USS instances.
620
661
required:
@@ -627,21 +668,34 @@ components:
627
668
id:
628
669
$ref: '#/components/schemas/EntityUUID'
629
670
ovn:
630
-
$ref: '#/components/schemas/EntityOVN'
671
+
description: |-
672
+
Opaque version number of this Operation. Populated only when the OperationReference
673
+
is owned by the USS retrieving it. Not populated when the OperationReference is not
674
+
owned by the USS retrieving it (instead, the USS must obtain the OVN from the details
675
+
retrieved from the owning USS).
676
+
allOf:
677
+
- $ref: '#/components/schemas/EntityOVN'
631
678
owner:
632
679
type: string
633
-
example: '(uss_owner)'
680
+
example: 'uss1'
634
681
description: |-
635
682
Created by the DSS and based on creating client’s ID (via access
636
683
token). Used for restricting mutation and deletion operations to owner.
637
684
time_start:
638
-
$ref: '#/components/schemas/TimeWithUnits'
685
+
description: Beginning time of Operation.
686
+
allOf:
687
+
- $ref: '#/components/schemas/TimeWithUnits'
639
688
time_end:
640
-
$ref: '#/components/schemas/TimeWithUnits'
689
+
description: End time of Operation.
690
+
allOf:
691
+
- $ref: '#/components/schemas/TimeWithUnits'
641
692
callbacks:
642
693
$ref: '#/components/schemas/OperationCallbacks'
643
694
subscription_id:
644
-
$ref: '#/components/schemas/EntityUUID'
695
+
description: |-
696
+
The ID of the Subscription that is ensuring the Operation owner receives relevant airspace updates while that Operation is
697
+
allOf:
698
+
- $ref: '#/components/schemas/SubscriptionUUID'
645
699
646
700
PutOperationReferenceParameters:
647
701
description: |-
@@ -667,9 +721,21 @@ components:
667
721
callbacks:
668
722
$ref: '#/components/schemas/OperationCallbacks'
669
723
subscription_id:
670
-
$ref: '#/components/schemas/EntityUUID'
724
+
description: |-
725
+
The ID of an existing Subscription that the USS will use to keep the operator informed about
726
+
updates to relevant airspace information. If this field is not provided, then the
727
+
`subscription_callbacks` field must be provided in order to provide notification capability
728
+
for the Operation. The Subscription specified by this ID must cover at least the area over
0 commit comments