forked from interuss/automated_testing_interfaces
-
Notifications
You must be signed in to change notification settings - Fork 0
/
observation.yaml
232 lines (224 loc) · 8.1 KB
/
observation.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
openapi: 3.0.2
info:
title: Remote ID Display Data Observation
version: 0.1.2
description: >-
This interface is provided by every Display Provider wishing to be tested by the automated testing framework.
The automated testing suite calls this interface to obtain current remote ID information from the perspective of a user of the Display Provider.
paths:
/display_data:
get:
parameters:
-
examples:
pyramids:
value: '29.97816,31.13296,29.98025,31.13535'
name: view
description: >-
The area of this view: lat1,lng1,lat2,lng2. The view is the smallest box bounded by
the provided corner points.
schema:
type: string
in: query
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetDisplayDataResponse'
description: Current remote ID display data was retrieved successfully.
operationId: getDisplayData
summary: Poll display data
description: Request current remote ID display data as would be visualized by a Display Application.
security:
- RIDAuth:
- dss.read.identification_service_areas
/display_data/{id}:
get:
parameters:
-
examples:
default:
value: '1e3adb99-acc9-424f-a04e-a0743538849a'
name: id
description: >-
ID of flight identified in `/display_data`.
schema:
type: string
in: path
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetDetailsResponse'
description: Details about the requested flight were retrieved successfully.
'404':
description: Requested flight was not found.
operationId: getDetails
summary: Get flight details
description: Get the details of a flight identified in `/display_data`.
security:
- RIDAuth:
- dss.read.identification_service_areas
components:
schemas:
GetDisplayDataResponse:
description: Response to a request for current data that would be visualized by a Display Application.
type: object
properties:
flights:
description: Current information for set of discovered flights whose precise locations are known.
type: array
items:
$ref: '#/components/schemas/Flight'
default: []
clusters:
description: >-
Current information for sets of discovered flights whose precise locations are not
known.
type: array
items:
$ref: '#/components/schemas/Cluster'
default: []
GetDetailsResponse:
description: Response to a request to get details about a flight.
type: object
properties:
operator:
anyOf:
- $ref: '#/components/schemas/Operator'
uas:
anyOf:
- $ref: '#/components/schemas/UAS'
Flight:
description: ''
required:
- id
type: object
properties:
id:
description: >-
Identifier of flight that may be used to obtain details about the flight.
This is not necessarily the UTM/flight ID in the remote ID system.
type: string
current_state:
$ref: '#/components/schemas/CurrentState'
most_recent_position:
description: Most recent position known for the flight.
allOf:
- $ref: '#/components/schemas/Position'
recent_paths:
description: Paths the flight recently traveled, if available.
type: array
items:
$ref: '#/components/schemas/Path'
CurrentState:
description: 'Current state of an aircraft.'
type: object
properties:
timestamp:
description: Time at which the message containing the current state information was generated by the display provider.
type: string
operational_status:
$ref: 'commons.yaml#/components/schemas/RIDOperationalStatus'
track:
$ref: 'commons.yaml#/components/schemas/RIDTrack'
speed:
$ref: 'commons.yaml#/components/schemas/RIDSpeed'
# TODO for next version: Move most_recent_position here.
Operator:
description: "Operator's information"
type: object
properties:
id:
description: >-
CAA-issued registration/license ID for the remote pilot or operator.
type: string
location:
anyOf:
- $ref: 'commons.yaml#/components/schemas/LatLngPoint'
altitude:
anyOf:
- $ref: 'commons.yaml#/components/schemas/OperatorAltitude'
UAS:
description: 'UAS information'
type: object
properties:
id:
description: Observed arbitrary and format agnostic (string) identification of a UAS.
type: string
Cluster:
description: 'A general area containing one or more flight.'
type: object
required:
- corners
- area_sqm
- number_of_flights
properties:
corners:
description: Two opposite corners of a rectangular lat-lng box bounding the cluster.
type: array
items:
$ref: '#/components/schemas/Position'
minItems: 2
maxItems: 2
area_sqm:
description: Area of the cluster in square meters.
type: number
format: double
number_of_flights:
description: Number of flights within the cluster.
type: number
format: int32
minimum: 1
Position:
description: 'A position on Earth.'
required:
- lat
- lng
type: object
properties:
lat:
$ref: 'commons.yaml#/components/schemas/Latitude'
lng:
$ref: 'commons.yaml#/components/schemas/Longitude'
alt:
$ref: 'commons.yaml#/components/schemas/Altitude'
msl_alt:
$ref: 'commons.yaml#/components/schemas/MSLAltitude'
height:
$ref: 'commons.yaml#/components/schemas/RIDHeight'
Path:
description: Path followed by a flight.
required:
- positions
type: object
properties:
positions:
description: Sequential positions available for a flight.
type: array
items:
$ref: '#/components/schemas/Position'
securitySchemes:
RIDAuth:
flows:
clientCredentials:
tokenUrl: https://example.com/oauth/token
scopes:
dss.read.identification_service_areas: Client may read current remote ID information.
type: oauth2
description: |-
Authorization from, or on behalf of, an authorization authority, matching standard remote ID authorization.
This authority will issue access tokens that are JSON Web Tokens as defined in RFC 7519, using the `RS256` algorithm for the signature, and publish to all providers the public key for verifying that signature.
The following fields must be included in the JWT claim for access tokens issued by this authority:
* `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.
* `aud`, with 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://uss.example.com:8888/rid_observation/display_data/a1711ef3-2373-4ea2-bbbc-f92f57285406, the access token included in the request should specify `"aud": "uss.example.com"`.
Clients must provide these access tokens in an `Authorization` header in the form `Bearer <token>` in accordance with RFC 6750.
security:
- RIDAuth:
- dss.read.identification_service_areas