Skip to content

Commit

Permalink
[interfaces] update automated_testing submodule (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
Shastick authored Nov 21, 2024
1 parent 397709d commit f556529
Show file tree
Hide file tree
Showing 8 changed files with 429 additions and 174 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Data types and operations from Flight Planning Automated Testing Interface 0.4.0 OpenAPI"""
"""Data types and operations from Flight Planning Automated Testing Interface 0.5.0 OpenAPI"""

# This file is autogenerated; do not modify manually!

Expand All @@ -12,17 +12,17 @@
from implicitdict import ImplicitDict, StringBasedDateTime


API_VERSION = "0.4.0"
API_VERSION = "0.5.0"
"""Version of Flight Planning Automated Testing Interface OpenAPI specification from which the objects in this package were generated."""

FlightPlanID = str
"""String identifying a user flight plan. Format matches a version-4 UUID according to RFC 4122."""


class StatusResponseStatus(str, Enum):
"""The status of the USS automated testing interface.
- `Starting`: the USS is starting and the automated test driver should wait before sending requests.
- `Ready`: the USS is ready to receive test requests.
"""The status of this automated testing interface.
- `Starting`: the interface is starting and the automated test driver should wait before sending requests.
- `Ready`: the interface is ready to receive test requests.
"""

Starting = "Starting"
Expand All @@ -31,20 +31,20 @@ class StatusResponseStatus(str, Enum):

class StatusResponse(ImplicitDict):
status: StatusResponseStatus
"""The status of the USS automated testing interface.
- `Starting`: the USS is starting and the automated test driver should wait before sending requests.
- `Ready`: the USS is ready to receive test requests.
"""The status of this automated testing interface.
- `Starting`: the interface is starting and the automated test driver should wait before sending requests.
- `Ready`: the interface is ready to receive test requests.
"""

api_name: Optional[str]
"""Indication of the API implemented at this URL. Must be "Flight Planning Automated Testing Interface"."""

api_version: Optional[str]
"""Indication of the API version implemented at this URL. Must be "v0.4.0" when implementing this version of the API."""
"""Indication of the API version implemented at this URL. Must be "v0.5.0" when implementing this version of the API."""


class FlightPlanAdditionalInformation(ImplicitDict):
"""Any information relevant to a particular jurisdiction or use case not described in the standard schema. The keys and values must be agreed upon between the test designers and USSs under test."""
"""Any information relevant to a particular jurisdiction or use case not described in the standard schema. The keys and values must be agreed upon between the test designers and test participants."""



Expand All @@ -68,11 +68,11 @@ class BasicFlightPlanInformationUasState(str, Enum):
- `Nominal`: The user or UAS reports or implies that it is performing nominally, or has not indicated
`OffNominal` or `Contingent`.
- `OffNominal`: The user or UAS reports or implies that it is temporarily not performing nominally, but
may expect to be able to recover to normal operation.
- `OffNominal`: The user or UAS reports or implies that it is temporarily not conforming to its intent,
but may expect to be able to recover to normal operation.
- `Contingent`: The user or UAS reports or implies that it is not performing nominally and may be unable
to recover to normal operation.
- `Contingent`: The user or UAS reports or implies that it is not conforming to its intent and may be
unable to recover to normal operation.
- `NotSpecified`: The UAS status is not currently available or known (for instance, if the flight is
planned in the future and the UAS that will be flying has not yet connected to the system).
Expand Down Expand Up @@ -155,7 +155,7 @@ class AdvisoryInclusion(str, Enum):

class UpsertFlightPlanResponse(ImplicitDict):
planning_result: PlanningActivityResult
"""The result of the flight plan creation or update attempt. If any option other than `Completed` is specified, the `notes` field should be populated with the reason for the unsuccessful outcome."""
"""The result of the flight plan creation or update attempt by the emulated user. If any option other than `Completed` is specified, the `notes` field should be populated with the reason for the unsuccessful outcome."""

notes: Optional[str]
"""Human-readable explanation of the observed result. This explanation may be made available to a human reviewing the test results, and ideally should explain why an undesirable result was obtained. For instance, if the injection attempt Failed, then these notes may indicate that the attempt failed because the DSS indicated 400 to a valid request (perhaps also including the valid request as proof)."""
Expand All @@ -169,7 +169,7 @@ class UpsertFlightPlanResponse(ImplicitDict):

class DeleteFlightPlanResponse(ImplicitDict):
planning_result: PlanningActivityResult
"""The result of attempted flight plan cancellation/closure. If any option other than `Completed` is specified, the `notes` field should be populated with the reason for the unsuccessful outcome."""
"""The result of attempted flight plan cancellation/closure by the USS admin. If any option other than `Completed` is specified, the `notes` field should be populated with the reason for the unsuccessful outcome."""

notes: Optional[str]
"""Human-readable explanation of the observed result."""
Expand All @@ -191,7 +191,7 @@ class ClearAreaOutcome(ImplicitDict):
"""True if, and only if, all flight plans in the specified area managed by the USS were canceled and removed."""

message: Optional[str]
"""If the USS was unable to clear the entire area, this message can provide information on the problem encountered."""
"""If the USS admin was unable to clear the entire area, this message can provide information on the problem encountered."""

details: Optional[ClearAreaOutcomeDetails]
"""Optional free-form structured data to augment `message`."""
Expand Down Expand Up @@ -357,6 +357,43 @@ class Time(ImplicitDict):
format: TimeFormat = TimeFormat.RFC3339


UserNotificationConflicts = str
"""Conflict status as indicated in the notification.
- `Unknown`: Notification doesn't contain information regarding conflicts.
- `None`: Notification indicates no conflicts.
- `Single`: Notification indicates the presence of one conflict.
- `Multiple`: Notification indicates the presence of multiple conflicts.
Acceptable values:
* Unknown
* None
* Single
* Multiple
"""


class UserNotification(ImplicitDict):
"""Notification observed by virtual user."""

observed_at: Time
"""Time at which the virtual user observed the notification."""

conflicts: Optional[UserNotificationConflicts] = "Unknown"
"""Conflict status as indicated in the notification.
- `Unknown`: Notification doesn't contain information regarding conflicts.
- `None`: Notification indicates no conflicts.
- `Single`: Notification indicates the presence of one conflict.
- `Multiple`: Notification indicates the presence of multiple conflicts.
"""


class QueryUserNotificationsResponse(ImplicitDict):
"""Response object for query request for notifications observed by the virtual user."""

user_notifications: List[UserNotification]
"""List of applicable observed user notifications."""


class ASTMF354821OpIntentInformation(ImplicitDict):
"""Information provided about a flight plan that is necessary for ASTM F3548-21."""

Expand Down Expand Up @@ -477,11 +514,11 @@ class BasicFlightPlanInformation(ImplicitDict):
- `Nominal`: The user or UAS reports or implies that it is performing nominally, or has not indicated
`OffNominal` or `Contingent`.
- `OffNominal`: The user or UAS reports or implies that it is temporarily not performing nominally, but
may expect to be able to recover to normal operation.
- `OffNominal`: The user or UAS reports or implies that it is temporarily not conforming to its intent,
but may expect to be able to recover to normal operation.
- `Contingent`: The user or UAS reports or implies that it is not performing nominally and may be unable
to recover to normal operation.
- `Contingent`: The user or UAS reports or implies that it is not conforming to its intent and may be
unable to recover to normal operation.
- `NotSpecified`: The UAS status is not currently available or known (for instance, if the flight is
planned in the future and the UAS that will be flying has not yet connected to the system).
Expand All @@ -498,7 +535,7 @@ class ClearAreaRequest(ImplicitDict):
"""Unique string identifying this request. If a second request with an identical ID is received, the USS may return the same response from the previous operation rather than attempting to clear the area again (the USS may also attempt to clear the area again)."""

extent: Volume4D
"""The USS should cancel and remove any flight plan it manages where any part of that flight plan intersects this area."""
"""The USS admin should cancel and remove any flight plan it manages where any part of that flight plan intersects this area."""


class FlightPlan(ImplicitDict):
Expand All @@ -513,7 +550,7 @@ class FlightPlan(ImplicitDict):
rpas_operating_rules_2_6: Optional[RPAS26FlightDetails]

additional_information: Optional[FlightPlanAdditionalInformation]
"""Any information relevant to a particular jurisdiction or use case not described in the standard schema. The keys and values must be agreed upon between the test designers and USSs under test."""
"""Any information relevant to a particular jurisdiction or use case not described in the standard schema. The keys and values must be agreed upon between the test designers and test participants."""


class UpsertFlightPlanRequest(ImplicitDict):
Expand All @@ -534,6 +571,7 @@ class OperationID(str, Enum):
ClearArea = "ClearArea"
UpsertFlightPlan = "UpsertFlightPlan"
DeleteFlightPlan = "DeleteFlightPlan"
QueryUserNotifications = "QueryUserNotifications"


OPERATIONS: Dict[OperationID, Operation] = {
Expand Down Expand Up @@ -584,4 +622,16 @@ class OperationID(str, Enum):
404: None,
}
),
OperationID.QueryUserNotifications: Operation(
id="QueryUserNotifications",
path="/user_notifications",
verb="GET",
request_body_type=None,
response_body_type={
200: QueryUserNotificationsResponse,
400: None,
401: None,
403: None,
}
),
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Data types and operations from Geo-Awareness Automated Test Interfaces 0.2.0 OpenAPI"""
"""Data types and operations from Geo-Awareness Automated Test Interfaces 0.2.2 OpenAPI"""

# This file is autogenerated; do not modify manually!

Expand All @@ -12,7 +12,7 @@
from implicitdict import ImplicitDict, StringBasedDateTime


API_VERSION = "0.2.0"
API_VERSION = "0.2.2"
"""Version of Geo-Awareness Automated Test Interfaces OpenAPI specification from which the objects in this package were generated."""

UUIDv4Format = str
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Data types and operations from Geospatial Map Provider Automated Testing Interface 0.2.0 OpenAPI"""
"""Data types and operations from Geospatial Map Provider Automated Testing Interface 0.2.3 OpenAPI"""

# This file is autogenerated; do not modify manually!

Expand All @@ -12,17 +12,17 @@
from implicitdict import ImplicitDict, StringBasedDateTime


API_VERSION = "0.2.0"
API_VERSION = "0.2.3"
"""Version of Geospatial Map Provider Automated Testing Interface OpenAPI specification from which the objects in this package were generated."""

UUIDv4Format = str
"""String whose format matches a version-4 UUID according to RFC 4122."""


class StatusResponseStatus(str, Enum):
"""The status of the USS automated testing interface.
- `Starting`: the USS is starting and the automated test driver should wait before sending requests.
- `Ready`: the USS is ready to receive test requests.
"""The status of this automated testing interface.
- `Starting`: the interface is starting and the automated test driver should wait before sending requests.
- `Ready`: the interface is ready to receive test requests.
"""

Starting = "Starting"
Expand All @@ -31,16 +31,16 @@ class StatusResponseStatus(str, Enum):

class StatusResponse(ImplicitDict):
status: StatusResponseStatus
"""The status of the USS automated testing interface.
- `Starting`: the USS is starting and the automated test driver should wait before sending requests.
- `Ready`: the USS is ready to receive test requests.
"""The status of this automated testing interface.
- `Starting`: the interface is starting and the automated test driver should wait before sending requests.
- `Ready`: the interface is ready to receive test requests.
"""

api_name: Optional[str]
"""Indication of the API implemented at this URL. Must be "Geospatial Map Provider Automated Testing Interface"."""

api_version: Optional[str]
"""Indication of the API version implemented at this URL. Must be "v0.2.0" when implementing this version of the API."""
"""Indication of the API version implemented at this URL. Must be "v0.2.2" when implementing this version of the API."""


class GeospatialHttpsSourceFormat(str, Enum):
Expand Down
Loading

0 comments on commit f556529

Please sign in to comment.