@volant-autonomy/via-sdk 1.4404.1 → 1.4417.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -957,16 +957,48 @@ export interface components {
957
957
  /**
958
958
  * Chart ID
959
959
  * @description Unique identifier for a chart.
960
+ * @example bath
960
961
  */
961
962
  chart_id: string;
962
963
  /**
963
964
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
964
965
  * @default NASADEM
966
+ * @example NASADEM
965
967
  */
966
968
  terrain_source?: components["schemas"]["TerrainSource"];
967
969
  /**
968
970
  * Volumes
969
971
  * @description 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. At least one volume must be provided.
972
+ * @example [
973
+ * {
974
+ * "time_end": "2023-10-30T11:57:57Z",
975
+ * "time_start": "2023-10-30T10:57:57Z",
976
+ * "volume": {
977
+ * "altitude_lower": 900,
978
+ * "altitude_upper": 950,
979
+ * "outline_polygon": {
980
+ * "vertices": [
981
+ * {
982
+ * "lat": 51.375,
983
+ * "lng": -2.37
984
+ * },
985
+ * {
986
+ * "lat": 51.38,
987
+ * "lng": -2.31
988
+ * },
989
+ * {
990
+ * "lat": 51.385,
991
+ * "lng": -2.36
992
+ * },
993
+ * {
994
+ * "lat": 51.375,
995
+ * "lng": -2.35
996
+ * }
997
+ * ]
998
+ * }
999
+ * }
1000
+ * }
1001
+ * ]
970
1002
  */
971
1003
  volumes: components["schemas"]["Volume4D-Input"][];
972
1004
  };
@@ -975,29 +1007,62 @@ export interface components {
975
1007
  /**
976
1008
  * Chart ID
977
1009
  * @description Unique identifier for a chart.
1010
+ * @example bath
978
1011
  */
979
1012
  chart_id: string;
980
1013
  /**
981
1014
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
982
1015
  * @default NASADEM
1016
+ * @example NASADEM
983
1017
  */
984
1018
  terrain_source?: components["schemas"]["TerrainSource"];
985
1019
  /**
986
1020
  * Volumes
987
1021
  * @description 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. At least one volume must be provided.
1022
+ * @example [
1023
+ * {
1024
+ * "time_end": "2023-10-30T11:57:57Z",
1025
+ * "time_start": "2023-10-30T10:57:57Z",
1026
+ * "volume": {
1027
+ * "altitude_lower": 900,
1028
+ * "altitude_upper": 950,
1029
+ * "outline_polygon": {
1030
+ * "vertices": [
1031
+ * {
1032
+ * "lat": 51.375,
1033
+ * "lng": -2.37
1034
+ * },
1035
+ * {
1036
+ * "lat": 51.38,
1037
+ * "lng": -2.31
1038
+ * },
1039
+ * {
1040
+ * "lat": 51.385,
1041
+ * "lng": -2.36
1042
+ * },
1043
+ * {
1044
+ * "lat": 51.375,
1045
+ * "lng": -2.35
1046
+ * }
1047
+ * ]
1048
+ * }
1049
+ * }
1050
+ * }
1051
+ * ]
988
1052
  */
989
1053
  volumes: components["schemas"]["Volume4D-Output"][];
990
1054
  };
991
1055
  /** AirspaceConstraintMeta */
992
1056
  AirspaceConstraintMeta: {
993
- /** @description State of an airspace constraint.
1057
+ /**
1058
+ * @description State of an airspace constraint.
994
1059
  * - 'Accepted' Airspace constraint is validated and is registered as an accepted airspace
995
1060
  * constraint in the database. Subsequent flight plans will be deconflicted against the
996
1061
  * volumes associated with this airspace constraint.
997
1062
  *
998
1063
  * - 'Closed' Airspace constraint is no longer valid and cannot be modified or submitted for
999
1064
  * accepted state.
1000
- * */
1065
+ */
1001
1066
  state: components["schemas"]["AirspaceConstraintState"];
1002
1067
  };
1003
1068
  /** AirspaceConstraintResponse */
@@ -1006,6 +1071,7 @@ export interface components {
1006
1071
  * Airspace Constraint ID
1007
1072
  * Format: uuid
1008
1073
  * @description Unique identifier of the Airspace Constraint.
1074
+ * @example 13e5572a-f733-49af-bc14-8a18bd53ee31
1009
1075
  */
1010
1076
  id: string;
1011
1077
  /**
@@ -1024,14 +1090,15 @@ export interface components {
1024
1090
  AirspaceConstraintState: "Accepted" | "Closed";
1025
1091
  /** AirspaceConstraintStateRequest */
1026
1092
  AirspaceConstraintStateRequest: {
1027
- /** @description State of an airspace constraint.
1093
+ /**
1094
+ * @description State of an airspace constraint.
1028
1095
  * - 'Accepted' Airspace constraint is validated and is registered as an accepted airspace
1029
1096
  * constraint in the database. Subsequent flight plans will be deconflicted against the
1030
1097
  * volumes associated with this airspace constraint.
1031
1098
  *
1032
1099
  * - 'Closed' Airspace constraint is no longer valid and cannot be modified or submitted for
1033
1100
  * accepted state.
1034
- * */
1101
+ */
1035
1102
  state: components["schemas"]["AirspaceConstraintState"];
1036
1103
  };
1037
1104
  /**
@@ -1044,21 +1111,25 @@ export interface components {
1044
1111
  /**
1045
1112
  * Min Lon
1046
1113
  * @description Degrees of longitude east of the Prime Meridian, with reference to the WGS84 ellipsoid.
1114
+ * @example -118.456
1047
1115
  */
1048
1116
  min_lon: number;
1049
1117
  /**
1050
1118
  * Min Lat
1051
1119
  * @description Degrees of latitude north of the equator, with reference to the WGS84 ellipsoid.
1120
+ * @example 34.123
1052
1121
  */
1053
1122
  min_lat: number;
1054
1123
  /**
1055
1124
  * Max Lon
1056
1125
  * @description Degrees of longitude east of the Prime Meridian, with reference to the WGS84 ellipsoid.
1126
+ * @example -118.456
1057
1127
  */
1058
1128
  max_lon: number;
1059
1129
  /**
1060
1130
  * Max Lat
1061
1131
  * @description Degrees of latitude north of the equator, with reference to the WGS84 ellipsoid.
1132
+ * @example 34.123
1062
1133
  */
1063
1134
  max_lat: number;
1064
1135
  };
@@ -1067,6 +1138,7 @@ export interface components {
1067
1138
  /**
1068
1139
  * ARC Display Name
1069
1140
  * @description ARC sub-category display name
1141
+ * @example ARC-b (<500ft AGL in Uncontrolled Airspace Over Rural Areas)
1070
1142
  */
1071
1143
  name: string;
1072
1144
  /** Implemented */
@@ -1113,7 +1185,7 @@ export interface components {
1113
1185
  * - 'arc-d3' - ARC-d (>500ft AGL but <FL600 and TMZ)
1114
1186
  *
1115
1187
  * - 'arc-d4' - ARC-d (>500ft AGL but <FL600 Mode-C Veil)
1116
- *
1188
+ * @example arc-b2
1117
1189
  */
1118
1190
  id: components["schemas"]["ARC"];
1119
1191
  /**
@@ -1129,6 +1201,45 @@ export interface components {
1129
1201
  * @description A volume of airspace that the operator is permitted to enter that may be characterised as either restricted
1130
1202
  * airspace, segregated areas, or airspace where normally manned aircraft should not go (e.g., at a height low enough
1131
1203
  * or close to an obstacle).
1204
+ * @example {
1205
+ * "features": [
1206
+ * {
1207
+ * "geometry": {
1208
+ * "coordinates": [
1209
+ * [
1210
+ * [
1211
+ * -2.363,
1212
+ * 51.381
1213
+ * ],
1214
+ * [
1215
+ * -2.391,
1216
+ * 51.381
1217
+ * ],
1218
+ * [
1219
+ * -2.391,
1220
+ * 51.37
1221
+ * ],
1222
+ * [
1223
+ * -2.363,
1224
+ * 51.37
1225
+ * ],
1226
+ * [
1227
+ * -2.363,
1228
+ * 51.381
1229
+ * ]
1230
+ * ]
1231
+ * ],
1232
+ * "type": "Polygon"
1233
+ * },
1234
+ * "properties": {
1235
+ * "altitude_upper": 500,
1236
+ * "altitude_lower": 0
1237
+ * },
1238
+ * "type": "Feature"
1239
+ * }
1240
+ * ],
1241
+ * "type": "FeatureCollection"
1242
+ * }
1132
1243
  */
1133
1244
  "AtypicalAirspace-Input": {
1134
1245
  /**
@@ -1147,6 +1258,45 @@ export interface components {
1147
1258
  * @description A volume of airspace that the operator is permitted to enter that may be characterised as either restricted
1148
1259
  * airspace, segregated areas, or airspace where normally manned aircraft should not go (e.g., at a height low enough
1149
1260
  * or close to an obstacle).
1261
+ * @example {
1262
+ * "features": [
1263
+ * {
1264
+ * "geometry": {
1265
+ * "coordinates": [
1266
+ * [
1267
+ * [
1268
+ * -2.363,
1269
+ * 51.381
1270
+ * ],
1271
+ * [
1272
+ * -2.391,
1273
+ * 51.381
1274
+ * ],
1275
+ * [
1276
+ * -2.391,
1277
+ * 51.37
1278
+ * ],
1279
+ * [
1280
+ * -2.363,
1281
+ * 51.37
1282
+ * ],
1283
+ * [
1284
+ * -2.363,
1285
+ * 51.381
1286
+ * ]
1287
+ * ]
1288
+ * ],
1289
+ * "type": "Polygon"
1290
+ * },
1291
+ * "properties": {
1292
+ * "altitude_upper": 500,
1293
+ * "altitude_lower": 0
1294
+ * },
1295
+ * "type": "Feature"
1296
+ * }
1297
+ * ],
1298
+ * "type": "FeatureCollection"
1299
+ * }
1150
1300
  */
1151
1301
  "AtypicalAirspace-Output": {
1152
1302
  /**
@@ -1162,9 +1312,15 @@ export interface components {
1162
1312
  };
1163
1313
  /** AtypicalAirspaceProperties */
1164
1314
  AtypicalAirspaceProperties: {
1165
- /** Altitude Upper */
1315
+ /**
1316
+ * Altitude Upper
1317
+ * @example 100
1318
+ */
1166
1319
  altitude_upper: number;
1167
- /** Altitude Lower */
1320
+ /**
1321
+ * Altitude Lower
1322
+ * @example 100
1323
+ */
1168
1324
  altitude_lower: number;
1169
1325
  };
1170
1326
  /** AtypicalAirspaceResponse */
@@ -1173,6 +1329,7 @@ export interface components {
1173
1329
  * Atypical Airspace ID
1174
1330
  * Format: uuid
1175
1331
  * @description Unique identifier of the atypical airspace.
1332
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
1176
1333
  */
1177
1334
  id: string;
1178
1335
  /**
@@ -1188,17 +1345,18 @@ export interface components {
1188
1345
  /**
1189
1346
  * Chart ID
1190
1347
  * @description Unique identifier for a chart.
1348
+ * @example bath
1191
1349
  */
1192
1350
  chart_id: string;
1193
1351
  /**
1194
1352
  * Cost Dataset Name
1195
1353
  * @description A custom name for the cost dataset, it can have a maximum length of 255 characters, contain symbols and spacing, and importantly cannot be renamed afterwards.
1354
+ * @example Bath_October Dataset
1196
1355
  */
1197
1356
  name: string;
1198
1357
  /**
1199
1358
  * Raster Valid Time Ranges
1200
- * @description
1201
- * Series of time ranges that must match the number of bands within the GeoTiff and must not overlap. Each range may be
1359
+ * @description Series of time ranges that must match the number of bands within the GeoTiff and must not overlap. Each range may be
1202
1360
  * described as:
1203
1361
  *
1204
1362
  *
@@ -1261,14 +1419,13 @@ export interface components {
1261
1419
  * "type": "object"
1262
1420
  * }
1263
1421
  * ```
1264
- *
1422
+ * @example [{"start": "2023-10-30T11:00:00Z", "end": "2023-10-30T12:00:00Z"}]
1265
1423
  */
1266
1424
  valid_time_ranges: string;
1267
1425
  /**
1268
1426
  * Cost Dataset GeoTiff
1269
1427
  * Format: binary
1270
- * @description
1271
- * GeoTiff file for a Cost Dataset.
1428
+ * @description GeoTiff file for a Cost Dataset.
1272
1429
  *
1273
1430
  * The file must:
1274
1431
  * * Match georeference information for the specified `chart_id` that can be retrieved using the `/charts` endpoints,
@@ -1278,7 +1435,6 @@ export interface components {
1278
1435
  * * Not use any negative values
1279
1436
  *
1280
1437
  * It is recommended to use `0` where there is no cost (or no known cost) associated but entry is allowed.
1281
- *
1282
1438
  */
1283
1439
  geotiff: string;
1284
1440
  };
@@ -1346,6 +1502,42 @@ export interface components {
1346
1502
  * ControlledGroundArea
1347
1503
  * @description An area under full responsibility of the operator with assurance that no unauthorised personnel may be present
1348
1504
  * during the operation.
1505
+ * @example {
1506
+ * "features": [
1507
+ * {
1508
+ * "geometry": {
1509
+ * "coordinates": [
1510
+ * [
1511
+ * [
1512
+ * -2.363,
1513
+ * 51.381
1514
+ * ],
1515
+ * [
1516
+ * -2.391,
1517
+ * 51.381
1518
+ * ],
1519
+ * [
1520
+ * -2.391,
1521
+ * 51.37
1522
+ * ],
1523
+ * [
1524
+ * -2.363,
1525
+ * 51.37
1526
+ * ],
1527
+ * [
1528
+ * -2.363,
1529
+ * 51.381
1530
+ * ]
1531
+ * ]
1532
+ * ],
1533
+ * "type": "Polygon"
1534
+ * },
1535
+ * "properties": {},
1536
+ * "type": "Feature"
1537
+ * }
1538
+ * ],
1539
+ * "type": "FeatureCollection"
1540
+ * }
1349
1541
  */
1350
1542
  "ControlledGroundArea-Input": {
1351
1543
  /**
@@ -1363,6 +1555,42 @@ export interface components {
1363
1555
  * ControlledGroundArea
1364
1556
  * @description An area under full responsibility of the operator with assurance that no unauthorised personnel may be present
1365
1557
  * during the operation.
1558
+ * @example {
1559
+ * "features": [
1560
+ * {
1561
+ * "geometry": {
1562
+ * "coordinates": [
1563
+ * [
1564
+ * [
1565
+ * -2.363,
1566
+ * 51.381
1567
+ * ],
1568
+ * [
1569
+ * -2.391,
1570
+ * 51.381
1571
+ * ],
1572
+ * [
1573
+ * -2.391,
1574
+ * 51.37
1575
+ * ],
1576
+ * [
1577
+ * -2.363,
1578
+ * 51.37
1579
+ * ],
1580
+ * [
1581
+ * -2.363,
1582
+ * 51.381
1583
+ * ]
1584
+ * ]
1585
+ * ],
1586
+ * "type": "Polygon"
1587
+ * },
1588
+ * "properties": {},
1589
+ * "type": "Feature"
1590
+ * }
1591
+ * ],
1592
+ * "type": "FeatureCollection"
1593
+ * }
1366
1594
  */
1367
1595
  "ControlledGroundArea-Output": {
1368
1596
  /**
@@ -1384,6 +1612,7 @@ export interface components {
1384
1612
  * Controlled Ground Area ID
1385
1613
  * Format: uuid
1386
1614
  * @description Unique identifier of the controlled ground area.
1615
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
1387
1616
  */
1388
1617
  id: string;
1389
1618
  /**
@@ -1399,6 +1628,7 @@ export interface components {
1399
1628
  /**
1400
1629
  * Chart ID
1401
1630
  * @description Unique identifier for a chart.
1631
+ * @example bath
1402
1632
  */
1403
1633
  chart_id: string;
1404
1634
  georeference: components["schemas"]["Georeference"];
@@ -1415,11 +1645,13 @@ export interface components {
1415
1645
  * Cost Dataset ID
1416
1646
  * Format: uuid
1417
1647
  * @description Unique identifier of the cost dataset.
1648
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
1418
1649
  */
1419
1650
  id: string;
1420
1651
  /**
1421
1652
  * Cost Dataset Name
1422
1653
  * @description A custom name for the cost dataset, it can have a maximum length of 255 characters, contain symbols and spacing, and importantly cannot be renamed afterwards.
1654
+ * @example Bath_October Dataset
1423
1655
  */
1424
1656
  name: string;
1425
1657
  /**
@@ -1450,12 +1682,14 @@ export interface components {
1450
1682
  /**
1451
1683
  * Airspeed
1452
1684
  * @description Nominal aircraft airspeed in metres per second.
1685
+ * @example 20
1453
1686
  */
1454
1687
  airspeed: number;
1455
1688
  /**
1456
1689
  * Airspeed Error
1457
1690
  * @description Deviation from nominal aircraft `airspeed`, assumed to be symmetrical about the nominal value. Cannot be larger than `airspeed` and must not cause the lower bound of airspeed to be less than the wind speed.
1458
1691
  * @default 0
1692
+ * @example 1
1459
1693
  */
1460
1694
  airspeed_error?: number;
1461
1695
  vertical: components["schemas"]["VerticalParameters"];
@@ -1469,6 +1703,7 @@ export interface components {
1469
1703
  /**
1470
1704
  * Chart ID
1471
1705
  * @description Unique identifier for a chart.
1706
+ * @example bath
1472
1707
  */
1473
1708
  chart_id: string;
1474
1709
  /**
@@ -1476,6 +1711,8 @@ export interface components {
1476
1711
  * @deprecated
1477
1712
  * @description Unique identifier for an aircraft.
1478
1713
  * @default phantom
1714
+ * @example phantom
1715
+ * @example hexsoon_h3v2
1479
1716
  */
1480
1717
  aircraft_id?: string;
1481
1718
  /** Sora Classification Id */
@@ -1486,21 +1723,58 @@ export interface components {
1486
1723
  * Time Start
1487
1724
  * Format: date-time
1488
1725
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
1726
+ * @example 2023-10-30T10:57:57Z
1727
+ * @example 2023-10-30T10:57:57+00:00
1489
1728
  */
1490
1729
  time_start: string;
1491
1730
  /**
1492
1731
  * Tse Temporal
1493
1732
  * @description Total system error in the time dimension, in seconds. Includes error due to uncertainty in take-off time, speed, and operational parameters. Defined as the 2-sigma/95% error limit. For example, if the tse_temporal is 300 s then on average an aircraft should be less than 5 minutes ahead or behind schedule for at least 95% of its route.
1733
+ * @example 60
1494
1734
  */
1495
1735
  tse_temporal: number;
1496
1736
  /**
1497
1737
  * Waypoints
1498
1738
  * @description Points defining a Flightplan that must be passed through along with flight parameters. The first waypoint must be of type: WaypointType.START and only occur once
1739
+ * @example [
1740
+ * {
1741
+ * "position": {
1742
+ * "altitude": 100,
1743
+ * "lat": 51.381,
1744
+ * "lng": -2.363
1745
+ * },
1746
+ * "type": "start"
1747
+ * },
1748
+ * {
1749
+ * "flight_parameters": {
1750
+ * "airspeed": 20,
1751
+ * "lateral": {
1752
+ * "contingency_buffer": 50,
1753
+ * "manoeuvre_corridor": 100,
1754
+ * "tse": 30
1755
+ * },
1756
+ * "vertical": {
1757
+ * "tse": 30
1758
+ * }
1759
+ * },
1760
+ * "position": {
1761
+ * "altitude": 100,
1762
+ * "lat": 51.382,
1763
+ * "lng": -2.357
1764
+ * },
1765
+ * "type": "goto",
1766
+ * "wind_parameters": {
1767
+ * "direction": 130,
1768
+ * "speed": 5
1769
+ * }
1770
+ * }
1771
+ * ]
1499
1772
  */
1500
1773
  waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Input"])[];
1501
1774
  /**
1502
1775
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
1503
1776
  * @default NASADEM
1777
+ * @example NASADEM
1504
1778
  */
1505
1779
  terrain_source?: components["schemas"]["TerrainSource"];
1506
1780
  /**
@@ -1520,6 +1794,7 @@ export interface components {
1520
1794
  /**
1521
1795
  * Chart ID
1522
1796
  * @description Unique identifier for a chart.
1797
+ * @example bath
1523
1798
  */
1524
1799
  chart_id: string;
1525
1800
  /**
@@ -1527,6 +1802,8 @@ export interface components {
1527
1802
  * @deprecated
1528
1803
  * @description Unique identifier for an aircraft.
1529
1804
  * @default phantom
1805
+ * @example phantom
1806
+ * @example hexsoon_h3v2
1530
1807
  */
1531
1808
  aircraft_id?: string;
1532
1809
  /** Sora Classification Id */
@@ -1537,21 +1814,58 @@ export interface components {
1537
1814
  * Time Start
1538
1815
  * Format: date-time
1539
1816
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
1817
+ * @example 2023-10-30T10:57:57Z
1818
+ * @example 2023-10-30T10:57:57+00:00
1540
1819
  */
1541
1820
  time_start: string;
1542
1821
  /**
1543
1822
  * Tse Temporal
1544
1823
  * @description Total system error in the time dimension, in seconds. Includes error due to uncertainty in take-off time, speed, and operational parameters. Defined as the 2-sigma/95% error limit. For example, if the tse_temporal is 300 s then on average an aircraft should be less than 5 minutes ahead or behind schedule for at least 95% of its route.
1824
+ * @example 60
1545
1825
  */
1546
1826
  tse_temporal: number;
1547
1827
  /**
1548
1828
  * Waypoints
1549
1829
  * @description Points defining a Flightplan that must be passed through along with flight parameters. The first waypoint must be of type: WaypointType.START and only occur once
1830
+ * @example [
1831
+ * {
1832
+ * "position": {
1833
+ * "altitude": 100,
1834
+ * "lat": 51.381,
1835
+ * "lng": -2.363
1836
+ * },
1837
+ * "type": "start"
1838
+ * },
1839
+ * {
1840
+ * "flight_parameters": {
1841
+ * "airspeed": 20,
1842
+ * "lateral": {
1843
+ * "contingency_buffer": 50,
1844
+ * "manoeuvre_corridor": 100,
1845
+ * "tse": 30
1846
+ * },
1847
+ * "vertical": {
1848
+ * "tse": 30
1849
+ * }
1850
+ * },
1851
+ * "position": {
1852
+ * "altitude": 100,
1853
+ * "lat": 51.382,
1854
+ * "lng": -2.357
1855
+ * },
1856
+ * "type": "goto",
1857
+ * "wind_parameters": {
1858
+ * "direction": 130,
1859
+ * "speed": 5
1860
+ * }
1861
+ * }
1862
+ * ]
1550
1863
  */
1551
1864
  waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Output"])[];
1552
1865
  /**
1553
1866
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
1554
1867
  * @default NASADEM
1868
+ * @example NASADEM
1555
1869
  */
1556
1870
  terrain_source?: components["schemas"]["TerrainSource"];
1557
1871
  /**
@@ -1565,7 +1879,8 @@ export interface components {
1565
1879
  };
1566
1880
  /** FlightplanMeta */
1567
1881
  FlightplanMeta: {
1568
- /** @description State of a flightplan.
1882
+ /**
1883
+ * @description State of a flightplan.
1569
1884
  *
1570
1885
  * - 'Draft' Flightplan is in preparation for submission to accepted state. Modifications and inspections can be
1571
1886
  * made to the flightplan prior to submission for accepted state.
@@ -1576,7 +1891,7 @@ export interface components {
1576
1891
  * Subsequent flight plans will be deconflicted against the volumes associated with this flightplan.
1577
1892
  *
1578
1893
  * - 'Closed' Flightplan is no longer valid and cannot be modified or submitted for accepted state.
1579
- * */
1894
+ */
1580
1895
  state: components["schemas"]["AirspaceRestrictionState"];
1581
1896
  };
1582
1897
  /**
@@ -1588,6 +1903,7 @@ export interface components {
1588
1903
  * Flightplan ID
1589
1904
  * Format: uuid
1590
1905
  * @description Unique identifier of the flightplan.
1906
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
1591
1907
  */
1592
1908
  id: string;
1593
1909
  /**
@@ -1616,7 +1932,19 @@ export interface components {
1616
1932
  * @constant
1617
1933
  */
1618
1934
  type: "MultiPolygon";
1619
- /** Coordinates */
1935
+ /**
1936
+ * Coordinates
1937
+ * @example [
1938
+ * [
1939
+ * [
1940
+ * [
1941
+ * -118.456,
1942
+ * 34.123
1943
+ * ]
1944
+ * ]
1945
+ * ]
1946
+ * ]
1947
+ */
1620
1948
  coordinates: [
1621
1949
  number,
1622
1950
  number
@@ -1639,7 +1967,17 @@ export interface components {
1639
1967
  * @constant
1640
1968
  */
1641
1969
  type: "Polygon";
1642
- /** Coordinates */
1970
+ /**
1971
+ * Coordinates
1972
+ * @example [
1973
+ * [
1974
+ * [
1975
+ * -118.456,
1976
+ * 34.123
1977
+ * ]
1978
+ * ]
1979
+ * ]
1980
+ */
1643
1981
  coordinates: [
1644
1982
  number,
1645
1983
  number
@@ -1688,6 +2026,42 @@ export interface components {
1688
2026
  /**
1689
2027
  * Geocage
1690
2028
  * @description An area that the operation must be contained within.
2029
+ * @example {
2030
+ * "features": [
2031
+ * {
2032
+ * "geometry": {
2033
+ * "coordinates": [
2034
+ * [
2035
+ * [
2036
+ * -2.363,
2037
+ * 51.381
2038
+ * ],
2039
+ * [
2040
+ * -2.391,
2041
+ * 51.381
2042
+ * ],
2043
+ * [
2044
+ * -2.391,
2045
+ * 51.37
2046
+ * ],
2047
+ * [
2048
+ * -2.363,
2049
+ * 51.37
2050
+ * ],
2051
+ * [
2052
+ * -2.363,
2053
+ * 51.381
2054
+ * ]
2055
+ * ]
2056
+ * ],
2057
+ * "type": "Polygon"
2058
+ * },
2059
+ * "properties": {},
2060
+ * "type": "Feature"
2061
+ * }
2062
+ * ],
2063
+ * "type": "FeatureCollection"
2064
+ * }
1691
2065
  */
1692
2066
  "Geocage-Input": {
1693
2067
  /**
@@ -1703,12 +2077,49 @@ export interface components {
1703
2077
  /**
1704
2078
  * Geocage name
1705
2079
  * @description User set name for a Geocage, it can have a maximum of 255 characters, as well as contain symbols and spacing
2080
+ * @example Bath_Geocage 2
1706
2081
  */
1707
2082
  viaName?: string | null;
1708
2083
  };
1709
2084
  /**
1710
2085
  * Geocage
1711
2086
  * @description An area that the operation must be contained within.
2087
+ * @example {
2088
+ * "features": [
2089
+ * {
2090
+ * "geometry": {
2091
+ * "coordinates": [
2092
+ * [
2093
+ * [
2094
+ * -2.363,
2095
+ * 51.381
2096
+ * ],
2097
+ * [
2098
+ * -2.391,
2099
+ * 51.381
2100
+ * ],
2101
+ * [
2102
+ * -2.391,
2103
+ * 51.37
2104
+ * ],
2105
+ * [
2106
+ * -2.363,
2107
+ * 51.37
2108
+ * ],
2109
+ * [
2110
+ * -2.363,
2111
+ * 51.381
2112
+ * ]
2113
+ * ]
2114
+ * ],
2115
+ * "type": "Polygon"
2116
+ * },
2117
+ * "properties": {},
2118
+ * "type": "Feature"
2119
+ * }
2120
+ * ],
2121
+ * "type": "FeatureCollection"
2122
+ * }
1712
2123
  */
1713
2124
  "Geocage-Output": {
1714
2125
  /**
@@ -1724,6 +2135,7 @@ export interface components {
1724
2135
  /**
1725
2136
  * Geocage name
1726
2137
  * @description User set name for a Geocage, it can have a maximum of 255 characters, as well as contain symbols and spacing
2138
+ * @example Bath_Geocage 2
1727
2139
  */
1728
2140
  viaName?: string | null;
1729
2141
  };
@@ -1735,6 +2147,7 @@ export interface components {
1735
2147
  * Geocage ID
1736
2148
  * Format: uuid
1737
2149
  * @description Unique identifier of the geocage.
2150
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
1738
2151
  */
1739
2152
  id: string;
1740
2153
  /**
@@ -1753,22 +2166,25 @@ export interface components {
1753
2166
  /**
1754
2167
  * Coordinate Reference System
1755
2168
  * @description CRS (Coordinate Reference System) of the underlying raster data, typically a UTM zone represented using an EPSG code in standardised format EPSG:EPSG_CODE, where EPSG_CODE is an integer. Refer to https://epsg.org/home.html for more information regarding specific EPSG codes.
2169
+ * @example EPSG:30260
1756
2170
  */
1757
2171
  crs: string;
1758
2172
  /**
1759
2173
  * Resolution
1760
2174
  * @description The resolution of each cell, defined in metres.
2175
+ * @example 40
1761
2176
  */
1762
2177
  resolution: number;
1763
2178
  /**
1764
2179
  * Raster Shape
1765
2180
  * @description Shape of the underlying raster grid defined as (height, width) in cells.
2181
+ * @example 100
2182
+ * @example 100
1766
2183
  */
1767
2184
  shape: number[];
1768
2185
  /**
1769
2186
  * Affine Transform
1770
- * @description
1771
- * Affine transformation represented in GDAL format:
2187
+ * @description Affine transformation represented in GDAL format:
1772
2188
  * [c, a, b, f, d, e]
1773
2189
  *
1774
2190
  * Where:
@@ -1787,7 +2203,6 @@ export interface components {
1787
2203
  * y = f * col + d * row + e
1788
2204
  * Note that this transform is created assuming North-Up convention such that the cell (0,0) represents the NW
1789
2205
  * cell of the raster with the y-coordinate decreasing with increasing y-index.
1790
- *
1791
2206
  */
1792
2207
  affine_transform: number[];
1793
2208
  };
@@ -1859,7 +2274,6 @@ export interface components {
1859
2274
  *
1860
2275
  * - `START`: The beginning of a `Flightplan`
1861
2276
  * - `GOTO` : Fly to and directly pass through a location under certain parameters
1862
- *
1863
2277
  * @constant
1864
2278
  */
1865
2279
  type: "goto";
@@ -1873,17 +2287,23 @@ export interface components {
1873
2287
  * @default {
1874
2288
  * "strict": false
1875
2289
  * }
2290
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
1876
2291
  */
1877
2292
  id?: string;
1878
2293
  /**
1879
2294
  * Index
1880
2295
  * @description The position of the waypoint in the flightplan
2296
+ * @example 0
2297
+ * @example 1
2298
+ * @example 2
1881
2299
  */
1882
2300
  index: number;
1883
2301
  /**
1884
2302
  * Time
1885
2303
  * Format: date-time
1886
2304
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
2305
+ * @example 2023-10-30T10:57:57Z
2306
+ * @example 2023-10-30T10:57:57+00:00
1887
2307
  */
1888
2308
  time: string;
1889
2309
  /**
@@ -1912,6 +2332,7 @@ export interface components {
1912
2332
  /**
1913
2333
  * Final GRC Determination
1914
2334
  * @description The Final GRC determination, based on the availability and correct application of mitigations to the operation after determination of the intrinsic GRC.
2335
+ * @example 6
1915
2336
  * @enum {integer}
1916
2337
  */
1917
2338
  final_grc: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
@@ -1921,23 +2342,30 @@ export interface components {
1921
2342
  /**
1922
2343
  * Ground Risk Buffer
1923
2344
  * @description The ground risk buffer is an area on the ground that surrounds the footprint of the contingency volume. It is expected that if the flight exits the contingency volume during a loss of control of the operation that the flight will be terminated within this lateral distance.
2345
+ * @example 100
1924
2346
  */
1925
2347
  ground_risk_buffer: number;
1926
- /** @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. The values are normalised by source data cell area to derive a density value of people per square metre. */
2348
+ /**
2349
+ * @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. The values are normalised by source data cell area to derive a density value of people per square metre.
2350
+ * @example GHS_2020_R2023_100
2351
+ */
1927
2352
  population_density_source: components["schemas"]["PopulationSource"];
1928
2353
  /** Controlled Ground Area Id */
1929
2354
  controlled_ground_area_id?: string | null;
1930
2355
  /** Atypical Airspace Id */
1931
2356
  atypical_airspace_id?: string | null;
1932
- /** @default {
2357
+ /**
2358
+ * @default {
1933
2359
  * "max_cruise_speed": 20,
1934
2360
  * "characteristic_dimension": 0.5
1935
- * } */
2361
+ * }
2362
+ */
1936
2363
  aircraft?: components["schemas"]["Aircraft"];
1937
2364
  /**
1938
2365
  * Containment Robustness
1939
2366
  * @description Level of technical and operational mitigations intended to contain the flight of the UA within the defined operational volume and ground risk buffer.
1940
2367
  * @default low
2368
+ * @example low
1941
2369
  * @enum {string}
1942
2370
  */
1943
2371
  containment_robustness?: "low" | "medium" | "high";
@@ -1947,24 +2375,28 @@ export interface components {
1947
2375
  /**
1948
2376
  * Mitigation 1(A)
1949
2377
  * @description Strategic mitigations for ground risk.
2378
+ * @example none
1950
2379
  * @enum {string}
1951
2380
  */
1952
2381
  m1a: "none" | "low" | "medium";
1953
2382
  /**
1954
2383
  * Mitigation 1(B)
1955
2384
  * @description Visual Line of Sight (VLOS) - avoid flying over people
2385
+ * @example none
1956
2386
  * @enum {string}
1957
2387
  */
1958
2388
  m1b: "none" | "medium" | "high";
1959
2389
  /**
1960
2390
  * Mitigation 1(C)
1961
2391
  * @description Tactical Mitigations - Ground observation
2392
+ * @example none
1962
2393
  * @enum {string}
1963
2394
  */
1964
2395
  m1c: "none" | "low";
1965
2396
  /**
1966
2397
  * Mitigation 2
1967
2398
  * @description Efforts to reduce UA impact dynamics
2399
+ * @example none
1968
2400
  * @enum {string}
1969
2401
  */
1970
2402
  m2: "none" | "medium" | "high";
@@ -1974,6 +2406,7 @@ export interface components {
1974
2406
  /**
1975
2407
  * Residual Air Risk Classification
1976
2408
  * @description Determination of Air Risk after the application of any strategic mitigations intended to control the crewed aircraft type, encounter rates or time of exposure, prior to take-off
2409
+ * @example arc-c
1977
2410
  * @enum {string}
1978
2411
  */
1979
2412
  residual_arc: "arc-a" | "arc-b" | "arc-c" | "arc-d";
@@ -1989,6 +2422,7 @@ export interface components {
1989
2422
  /**
1990
2423
  * Residual Air Risk Classification
1991
2424
  * @description Determination of Air Risk after the application of any strategic mitigations intended to control the crewed aircraft type, encounter rates or time of exposure, prior to take-off
2425
+ * @example arc-c
1992
2426
  * @enum {string}
1993
2427
  */
1994
2428
  id: "arc-a" | "arc-b" | "arc-c" | "arc-d";
@@ -2214,16 +2648,19 @@ export interface components {
2214
2648
  /**
2215
2649
  * Tse
2216
2650
  * @description Total system error in a horizontal plane, in metres. Includes positional error due to pathing, navigation and instrumentation. Defined as the 2-sigma/95% error limit. For example, if the tse_lateral is 30 m then on average an aircraft should be less than 30 metres away from its planned route at least 95% of the time.
2651
+ * @example 30
2217
2652
  */
2218
2653
  tse: number;
2219
2654
  /**
2220
2655
  * Manoeuvre Corridor
2221
2656
  * @description Distance horizontally either side of the mean flight path reserved for any typical manoeuvre, in metres
2657
+ * @example 100
2222
2658
  */
2223
2659
  manoeuvre_corridor: number;
2224
2660
  /**
2225
2661
  * Contingency Buffer
2226
2662
  * @description Specific provision outside of manoeuvre corridor to be used during any unexpected and unforeseen emergencies, in metres
2663
+ * @example 50
2227
2664
  */
2228
2665
  contingency_buffer: number;
2229
2666
  };
@@ -2232,14 +2669,22 @@ export interface components {
2232
2669
  /**
2233
2670
  * Self
2234
2671
  * @description URL for the resource
2672
+ * @example https://via.volantautonomy.com/api/v1.0/flightplans/e036bf71-bf94-4280-0350-6037f989e228
2673
+ * @example https://via.volantautonomy.com/api/v1.0/pathing_tasks/e036bf71-bf94-4280-0350-6037f989e228
2235
2674
  */
2236
2675
  self: string;
2237
2676
  };
2238
2677
  /** LoginRequest */
2239
2678
  LoginRequest: {
2240
- /** Username */
2679
+ /**
2680
+ * Username
2681
+ * @example user@volantautonomy.com
2682
+ */
2241
2683
  username: string;
2242
- /** Password */
2684
+ /**
2685
+ * Password
2686
+ * @example supersecret
2687
+ */
2243
2688
  password: string;
2244
2689
  };
2245
2690
  /** LoginResponse */
@@ -2247,13 +2692,18 @@ export interface components {
2247
2692
  /**
2248
2693
  * Access Token
2249
2694
  * @description JSON Web Token as defined in RFC 7519
2695
+ * @example eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJoZWxsbyI6IndvcmxkIn0.Z63-5gvW8ri78IEGlIgj-YtHCJZrcEbQf3WDrT-S8jE
2250
2696
  */
2251
2697
  access_token: string;
2252
- /** @description The type of authorization token */
2698
+ /**
2699
+ * @description The type of authorization token
2700
+ * @example Bearer
2701
+ */
2253
2702
  token_type: components["schemas"]["TokenType"];
2254
2703
  /**
2255
2704
  * Expires In
2256
2705
  * @description The time before token expiry in seconds
2706
+ * @example 18000
2257
2707
  */
2258
2708
  expires_in: number;
2259
2709
  };
@@ -2266,9 +2716,14 @@ export interface components {
2266
2716
  /**
2267
2717
  * Aircraft ID
2268
2718
  * @description Unique identifier for an aircraft.
2719
+ * @example phantom
2720
+ * @example hexsoon_h3v2
2269
2721
  */
2270
2722
  aircraft_id: string;
2271
- /** Altitude */
2723
+ /**
2724
+ * Altitude
2725
+ * @example 100
2726
+ */
2272
2727
  altitude: number;
2273
2728
  /**
2274
2729
  * Category
@@ -2297,15 +2752,13 @@ export interface components {
2297
2752
  ground_risk_bias?: number | null;
2298
2753
  /**
2299
2754
  * Cost Bias
2300
- * @description
2301
- * Overall consideration given to costs when determining a path versus reaching the checkpoint in the minimum time whilst
2755
+ * @description Overall consideration given to costs when determining a path versus reaching the checkpoint in the minimum time whilst
2302
2756
  * respecting other restrictions. Ignoring all cost without other restrictions will result in the straight-line path
2303
2757
  * between two checkpoints whilst minimising cost will produce a significantly more complex path in an attempt to
2304
2758
  * reduce any theoretically incurred cost of flight.
2305
2759
  *
2306
2760
  * * 0: Ignore cost
2307
2761
  * * 1: Minimise cost
2308
- *
2309
2762
  * @default 0.8
2310
2763
  */
2311
2764
  cost_bias?: number;
@@ -2313,12 +2766,14 @@ export interface components {
2313
2766
  * Ground Risk Weighting
2314
2767
  * @description Weight multiplier to apply to ground risk when combining cost fields.
2315
2768
  * @default 1
2769
+ * @example 1
2316
2770
  */
2317
2771
  ground_risk_weighting?: number;
2318
2772
  /**
2319
2773
  * Cost Dataset Weighting
2320
2774
  * @description Weight multiplier to apply to the provided Cost Dataset when combining cost fields. Without a cost dataset being provided, this will have no effect on the output cost field.
2321
2775
  * @default 1
2776
+ * @example 1
2322
2777
  */
2323
2778
  cost_dataset_weighting?: number;
2324
2779
  /**
@@ -2333,29 +2788,68 @@ export interface components {
2333
2788
  /**
2334
2789
  * Waypoints
2335
2790
  * @description Points defining a Flightplan that must be passed through along with flight parameters. The first waypoint must be of type: WaypointType.START and only occur once
2791
+ * @example [
2792
+ * {
2793
+ * "position": {
2794
+ * "altitude": 100,
2795
+ * "lat": 51.381,
2796
+ * "lng": -2.363
2797
+ * },
2798
+ * "type": "start"
2799
+ * },
2800
+ * {
2801
+ * "flight_parameters": {
2802
+ * "airspeed": 20,
2803
+ * "lateral": {
2804
+ * "contingency_buffer": 50,
2805
+ * "manoeuvre_corridor": 100,
2806
+ * "tse": 30
2807
+ * },
2808
+ * "vertical": {
2809
+ * "tse": 30
2810
+ * }
2811
+ * },
2812
+ * "position": {
2813
+ * "altitude": 100,
2814
+ * "lat": 51.382,
2815
+ * "lng": -2.357
2816
+ * },
2817
+ * "type": "goto",
2818
+ * "wind_parameters": {
2819
+ * "direction": 130,
2820
+ * "speed": 5
2821
+ * }
2822
+ * }
2823
+ * ]
2336
2824
  */
2337
2825
  waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Output"])[];
2338
2826
  /**
2339
2827
  * Time Start
2340
2828
  * Format: date-time
2341
2829
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
2830
+ * @example 2023-10-30T10:57:57Z
2831
+ * @example 2023-10-30T10:57:57+00:00
2342
2832
  */
2343
2833
  time_start: string;
2344
2834
  /**
2345
2835
  * Time End
2346
2836
  * Format: date-time
2347
2837
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
2838
+ * @example 2023-10-30T10:57:57Z
2839
+ * @example 2023-10-30T10:57:57+00:00
2348
2840
  */
2349
2841
  time_end: string;
2350
2842
  };
2351
2843
  /** PathingTaskMeta */
2352
2844
  PathingTaskMeta: {
2353
- /** @description State of a pathing task.
2845
+ /**
2846
+ * @description State of a pathing task.
2354
2847
  *
2355
2848
  * - 'queued' The pathing task is waiting to be calculated.
2356
2849
  * - 'in-progress' The pathing task is being calculated.
2357
2850
  * - 'successful' The pathing task is complete and the waypoints that make up the risk-minimised and de-conflicted path are available.
2358
- * - 'failed' The pathing task failed, a path is unachievable. */
2851
+ * - 'failed' The pathing task failed, a path is unachievable.
2852
+ */
2359
2853
  state: components["schemas"]["PathingTaskState"];
2360
2854
  /**
2361
2855
  * Error Code
@@ -2378,11 +2872,17 @@ export interface components {
2378
2872
  /**
2379
2873
  * Checkpoint Indexes
2380
2874
  * @description Indexes of checkpoints from initial request in returned waypoints, only provided if the pathing task is "successful".
2875
+ * @example [
2876
+ * 0,
2877
+ * 4,
2878
+ * 9
2879
+ * ]
2381
2880
  */
2382
2881
  checkpoint_indexes?: number[] | null;
2383
2882
  /**
2384
2883
  * Compute Time
2385
2884
  * @description The total time taken to generate the pathing result given in seconds
2885
+ * @example 1
2386
2886
  */
2387
2887
  compute_time?: number | null;
2388
2888
  };
@@ -2391,6 +2891,7 @@ export interface components {
2391
2891
  /**
2392
2892
  * Chart ID
2393
2893
  * @description Unique identifier for a chart.
2894
+ * @example bath
2394
2895
  */
2395
2896
  chart_id: string;
2396
2897
  /**
@@ -2398,6 +2899,8 @@ export interface components {
2398
2899
  * @deprecated
2399
2900
  * @description Unique identifier for an aircraft.
2400
2901
  * @default phantom
2902
+ * @example phantom
2903
+ * @example hexsoon_h3v2
2401
2904
  */
2402
2905
  aircraft_id?: string;
2403
2906
  /** Sora Classification Id */
@@ -2405,6 +2908,7 @@ export interface components {
2405
2908
  /**
2406
2909
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
2407
2910
  * @default NASADEM
2911
+ * @example NASADEM
2408
2912
  */
2409
2913
  terrain_source?: components["schemas"]["TerrainSource"];
2410
2914
  /** Geocage Id */
@@ -2432,6 +2936,7 @@ export interface components {
2432
2936
  /**
2433
2937
  * Tse Temporal
2434
2938
  * @description Total system error in the time dimension, in seconds. Includes error due to uncertainty in take-off time, speed, and operational parameters. Defined as the 2-sigma/95% error limit. For example, if the tse_temporal is 300 s then on average an aircraft should be less than 5 minutes ahead or behind schedule for at least 95% of its route.
2939
+ * @example 60
2435
2940
  */
2436
2941
  tse_temporal: number;
2437
2942
  /**
@@ -2445,6 +2950,47 @@ export interface components {
2445
2950
  /**
2446
2951
  * Checkpoints
2447
2952
  * @description Points defining the Pathing Task that must be passed through along with flight parameters and settings for pathing. The first checkpoint must be of type: PathingCheckpointType.START and only occur once
2953
+ * @example [
2954
+ * {
2955
+ * "position": {
2956
+ * "altitude": 100,
2957
+ * "lat": 51.381,
2958
+ * "lng": -2.363
2959
+ * },
2960
+ * "type": "start"
2961
+ * },
2962
+ * {
2963
+ * "parameters": {
2964
+ * "flight_parameters": {
2965
+ * "airspeed": 20,
2966
+ * "lateral": {
2967
+ * "contingency_buffer": 50,
2968
+ * "manoeuvre_corridor": 100,
2969
+ * "tse": 30
2970
+ * },
2971
+ * "vertical": {
2972
+ * "tse": 30
2973
+ * }
2974
+ * },
2975
+ * "pathing_settings": {
2976
+ * "cost_bias": 0.8,
2977
+ * "cost_dataset_weighting": 1,
2978
+ * "deconflict": true,
2979
+ * "ground_risk_weighting": 1
2980
+ * },
2981
+ * "wind_parameters": {
2982
+ * "direction": 130,
2983
+ * "speed": 5
2984
+ * }
2985
+ * },
2986
+ * "position": {
2987
+ * "altitude": 100,
2988
+ * "lat": 51.382,
2989
+ * "lng": -2.357
2990
+ * },
2991
+ * "type": "goto"
2992
+ * }
2993
+ * ]
2448
2994
  */
2449
2995
  checkpoints: (components["schemas"]["StartPathingCheckpoint"] | components["schemas"]["GotoPathingCheckpoint"])[];
2450
2996
  };
@@ -2458,6 +3004,7 @@ export interface components {
2458
3004
  * Pathing Task ID
2459
3005
  * Format: uuid
2460
3006
  * @description Unique identifier of the pathing task
3007
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
2461
3008
  */
2462
3009
  id: string;
2463
3010
  /**
@@ -2503,7 +3050,33 @@ export interface components {
2503
3050
  */
2504
3051
  coordinates: components["schemas"]["Wgs84Point"][];
2505
3052
  };
2506
- /** RasterRequest */
3053
+ /**
3054
+ * RasterRequest
3055
+ * @example {
3056
+ * "azimuth": 0,
3057
+ * "polygon": {
3058
+ * "vertices": [
3059
+ * {
3060
+ * "lat": 51.3841,
3061
+ * "lng": -2.3692
3062
+ * },
3063
+ * {
3064
+ * "lat": 51.3748,
3065
+ * "lng": -2.3692
3066
+ * },
3067
+ * {
3068
+ * "lat": 51.3748,
3069
+ * "lng": -2.3493
3070
+ * },
3071
+ * {
3072
+ * "lat": 51.3841,
3073
+ * "lng": -2.3493
3074
+ * }
3075
+ * ]
3076
+ * },
3077
+ * "spacing": 500
3078
+ * }
3079
+ */
2507
3080
  RasterRequest: {
2508
3081
  /**
2509
3082
  * Raster Search Area
@@ -2513,21 +3086,57 @@ export interface components {
2513
3086
  /**
2514
3087
  * Azimuth
2515
3088
  * @description Intended Azimuth of raster search pattern defined in degrees where 0 is North
3089
+ * @example 0
2516
3090
  */
2517
3091
  azimuth: number;
2518
3092
  /**
2519
3093
  * Spacing
2520
3094
  * @description Orthogonal distance between any two passes across the polygon in metres
3095
+ * @example 500
2521
3096
  */
2522
3097
  spacing: number;
2523
3098
  /**
2524
3099
  * Invert Raster Pattern
2525
3100
  * @description Begin raster pattern from the opposite edge
2526
3101
  * @default false
3102
+ * @example false
2527
3103
  */
2528
3104
  invert?: boolean;
2529
3105
  };
2530
- /** RasterResponse */
3106
+ /**
3107
+ * RasterResponse
3108
+ * @example {
3109
+ * "attributes": {
3110
+ * "coordinates": [
3111
+ * {
3112
+ * "lat": 51.37480028880775,
3113
+ * "lng": -2.3536535297394745
3114
+ * },
3115
+ * {
3116
+ * "lat": 51.3841002824567,
3117
+ * "lng": -2.3535225303521625
3118
+ * },
3119
+ * {
3120
+ * "lat": 51.38410041335802,
3121
+ * "lng": -2.360707707069097
3122
+ * },
3123
+ * {
3124
+ * "lat": 51.374800411705664,
3125
+ * "lng": -2.360837250473595
3126
+ * },
3127
+ * {
3128
+ * "lat": 51.3748000941861,
3129
+ * "lng": -2.368020975102519
3130
+ * },
3131
+ * {
3132
+ * "lat": 51.38410010369618,
3133
+ * "lng": -2.3678928876840883
3134
+ * }
3135
+ * ]
3136
+ * },
3137
+ * "type": "flight_pattern"
3138
+ * }
3139
+ */
2531
3140
  RasterResponse: {
2532
3141
  /**
2533
3142
  * Type
@@ -2557,6 +3166,7 @@ export interface components {
2557
3166
  /**
2558
3167
  * SAIL
2559
3168
  * @description The SAIL represents the level of confidence that the UAS operation will stay under control.
3169
+ * @example V
2560
3170
  * @enum {string}
2561
3171
  */
2562
3172
  sail: "NA" | "I" | "II" | "III" | "IV" | "V" | "VI" | "VII";
@@ -2586,6 +3196,7 @@ export interface components {
2586
3196
  * SORA Classification ID
2587
3197
  * Format: uuid
2588
3198
  * @description A unique identifier representing a specific set of SORA parameters
3199
+ * @example 550e8400-e29b-41d4-a716-443655440001
2589
3200
  */
2590
3201
  id: string;
2591
3202
  /**
@@ -2602,21 +3213,25 @@ export interface components {
2602
3213
  /**
2603
3214
  * Final GRC Determination
2604
3215
  * @description The Final GRC determination, based on the availability and correct application of mitigations to the operation after determination of the intrinsic GRC.
3216
+ * @example 6
2605
3217
  */
2606
3218
  final_grc: components["schemas"]["FinalGRC"] | "Category C";
2607
3219
  /**
2608
3220
  * Intrinsic UAS Ground Risk Class (iGRC)
2609
3221
  * @description The intrinsic UAS ground risk relates to the risk of a person being fatally struck by the UAS (in the case where the UAS operation is out of control) absent of any mitigations being present
3222
+ * @example 6
2610
3223
  */
2611
3224
  intrinsic_grc: components["schemas"]["IntrinsicGRC"] | "Category C";
2612
3225
  /**
2613
3226
  * Max Operational Population Density
2614
3227
  * @description The maximum population density overflown within the nominal flight operational volume and ground risk buffer, defined in people/km². Determined in the assessment of intrinsic ground risk before application of any mitigations.
3228
+ * @example 20000
2615
3229
  */
2616
3230
  max_operational_population_density: number;
2617
3231
  /**
2618
3232
  * Residual Air Risk Classification
2619
3233
  * @description Determination of Air Risk after the application of any strategic mitigations intended to control the crewed aircraft type, encounter rates or time of exposure, prior to take-off
3234
+ * @example arc-c
2620
3235
  * @enum {string}
2621
3236
  */
2622
3237
  residual_arc: "arc-a" | "arc-b" | "arc-c" | "arc-d";
@@ -2624,6 +3239,7 @@ export interface components {
2624
3239
  /**
2625
3240
  * SAIL
2626
3241
  * @description The SAIL represents the level of confidence that the UAS operation will stay under control.
3242
+ * @example V
2627
3243
  */
2628
3244
  sail: ("NA" | "I" | "II" | "III" | "IV" | "V" | "VI" | "VII") | "Category C";
2629
3245
  containment: components["schemas"]["ContainmentRequirements"];
@@ -2633,25 +3249,64 @@ export interface components {
2633
3249
  /**
2634
3250
  * Chart ID
2635
3251
  * @description Unique identifier for a chart.
3252
+ * @example bath
2636
3253
  */
2637
3254
  chart_id: string;
2638
3255
  /**
2639
3256
  * Waypoints
2640
3257
  * @description Points defining a Flightplan that must be passed through along with flight parameters. The first waypoint must be of type: WaypointType.START and only occur once
3258
+ * @example [
3259
+ * {
3260
+ * "position": {
3261
+ * "altitude": 100,
3262
+ * "lat": 51.381,
3263
+ * "lng": -2.363
3264
+ * },
3265
+ * "type": "start"
3266
+ * },
3267
+ * {
3268
+ * "flight_parameters": {
3269
+ * "airspeed": 20,
3270
+ * "lateral": {
3271
+ * "contingency_buffer": 50,
3272
+ * "manoeuvre_corridor": 100,
3273
+ * "tse": 30
3274
+ * },
3275
+ * "vertical": {
3276
+ * "tse": 30
3277
+ * }
3278
+ * },
3279
+ * "position": {
3280
+ * "altitude": 100,
3281
+ * "lat": 51.382,
3282
+ * "lng": -2.357
3283
+ * },
3284
+ * "type": "goto",
3285
+ * "wind_parameters": {
3286
+ * "direction": 130,
3287
+ * "speed": 5
3288
+ * }
3289
+ * }
3290
+ * ]
2641
3291
  */
2642
3292
  waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Input"])[];
2643
3293
  aircraft: components["schemas"]["Aircraft"];
2644
3294
  ground_risk_mitigations: components["schemas"]["JarusV25GroundRiskMitigations"];
2645
- /** @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. The values are normalised by source data cell area to derive a density value of people per square metre. */
3295
+ /**
3296
+ * @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. The values are normalised by source data cell area to derive a density value of people per square metre.
3297
+ * @example GHS_2020_R2023_100
3298
+ */
2646
3299
  population_density_source: components["schemas"]["PopulationSource"];
2647
3300
  /**
2648
3301
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
2649
3302
  * @default NASADEM
3303
+ * @example NASADEM
2650
3304
  */
2651
3305
  terrain_source?: components["schemas"]["TerrainSource"];
2652
3306
  /**
2653
3307
  * Ground Risk Buffer
2654
3308
  * @description The ground risk buffer is an area on the ground that surrounds the footprint of the contingency volume. It is expected that if the flight exits the contingency volume during a loss of control of the operation that the flight will be terminated within this lateral distance.
3309
+ * @example 100
2655
3310
  */
2656
3311
  ground_risk_buffer: number;
2657
3312
  /**
@@ -2680,22 +3335,58 @@ export interface components {
2680
3335
  /**
2681
3336
  * Chart ID
2682
3337
  * @description Unique identifier for a chart.
3338
+ * @example bath
2683
3339
  */
2684
3340
  chart_id: string;
2685
3341
  /**
2686
3342
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
2687
3343
  * @default NASADEM
3344
+ * @example NASADEM
2688
3345
  */
2689
3346
  terrain_source?: components["schemas"]["TerrainSource"];
2690
3347
  aircraft: components["schemas"]["Aircraft"];
2691
3348
  /**
2692
3349
  * Waypoints
2693
3350
  * @description Points defining a Flightplan that must be passed through along with flight parameters. The first waypoint must be of type: WaypointType.START and only occur once
3351
+ * @example [
3352
+ * {
3353
+ * "position": {
3354
+ * "altitude": 100,
3355
+ * "lat": 51.381,
3356
+ * "lng": -2.363
3357
+ * },
3358
+ * "type": "start"
3359
+ * },
3360
+ * {
3361
+ * "flight_parameters": {
3362
+ * "airspeed": 20,
3363
+ * "lateral": {
3364
+ * "contingency_buffer": 50,
3365
+ * "manoeuvre_corridor": 100,
3366
+ * "tse": 30
3367
+ * },
3368
+ * "vertical": {
3369
+ * "tse": 30
3370
+ * }
3371
+ * },
3372
+ * "position": {
3373
+ * "altitude": 100,
3374
+ * "lat": 51.382,
3375
+ * "lng": -2.357
3376
+ * },
3377
+ * "type": "goto",
3378
+ * "wind_parameters": {
3379
+ * "direction": 130,
3380
+ * "speed": 5
3381
+ * }
3382
+ * }
3383
+ * ]
2694
3384
  */
2695
3385
  waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Input"])[];
2696
3386
  /**
2697
3387
  * Ground Risk Buffer
2698
3388
  * @description The ground risk buffer is an area on the ground that surrounds the footprint of the contingency volume. It is expected that if the flight exits the contingency volume during a loss of control of the operation that the flight will be terminated within this lateral distance.
3389
+ * @example 100
2699
3390
  */
2700
3391
  ground_risk_buffer: number;
2701
3392
  };
@@ -2739,7 +3430,6 @@ export interface components {
2739
3430
  *
2740
3431
  * - `START`: The beginning of a `Flightplan`
2741
3432
  * - `GOTO` : Fly to and directly pass through a location under certain parameters
2742
- *
2743
3433
  * @constant
2744
3434
  */
2745
3435
  type: "start";
@@ -2751,17 +3441,23 @@ export interface components {
2751
3441
  * @default {
2752
3442
  * "strict": false
2753
3443
  * }
3444
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
2754
3445
  */
2755
3446
  id?: string;
2756
3447
  /**
2757
3448
  * Index
2758
3449
  * @description The position of the waypoint in the flightplan
3450
+ * @example 0
3451
+ * @example 1
3452
+ * @example 2
2759
3453
  */
2760
3454
  index: number;
2761
3455
  /**
2762
3456
  * Time
2763
3457
  * Format: date-time
2764
3458
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
3459
+ * @example 2023-10-30T10:57:57Z
3460
+ * @example 2023-10-30T10:57:57+00:00
2765
3461
  */
2766
3462
  time: string;
2767
3463
  /**
@@ -2777,7 +3473,8 @@ export interface components {
2777
3473
  };
2778
3474
  /** StateRequest */
2779
3475
  StateRequest: {
2780
- /** @description State of a flightplan.
3476
+ /**
3477
+ * @description State of a flightplan.
2781
3478
  *
2782
3479
  * - 'Draft' Flightplan is in preparation for submission to accepted state. Modifications and inspections can be
2783
3480
  * made to the flightplan prior to submission for accepted state.
@@ -2788,7 +3485,7 @@ export interface components {
2788
3485
  * Subsequent flight plans will be deconflicted against the volumes associated with this flightplan.
2789
3486
  *
2790
3487
  * - 'Closed' Flightplan is no longer valid and cannot be modified or submitted for accepted state.
2791
- * */
3488
+ */
2792
3489
  state: components["schemas"]["AirspaceRestrictionState"];
2793
3490
  };
2794
3491
  /** StatisticsAttributes */
@@ -2796,11 +3493,13 @@ export interface components {
2796
3493
  /**
2797
3494
  * Duration
2798
3495
  * @description The nominal time to complete the flightplan, given in seconds
3496
+ * @example 187.8
2799
3497
  */
2800
3498
  duration: number;
2801
3499
  /**
2802
3500
  * Total Cost
2803
3501
  * @description The estimated total cost to complete the flightplan, given in GBP
3502
+ * @example 5.62
2804
3503
  */
2805
3504
  total_cost: number;
2806
3505
  };
@@ -2813,6 +3512,7 @@ export interface components {
2813
3512
  * Flightplan ID
2814
3513
  * Format: uuid
2815
3514
  * @description Unique identifier of the flightplan.
3515
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
2816
3516
  */
2817
3517
  id: string;
2818
3518
  /**
@@ -2849,6 +3549,24 @@ export interface components {
2849
3549
  /**
2850
3550
  * Profile
2851
3551
  * @description Pairs (planar projected distance along flightplan, elevation of overflown terrain Above Mean Sea Level (AMSL) at that distance), given in metres.
3552
+ * @example [
3553
+ * [
3554
+ * 0,
3555
+ * 95.4
3556
+ * ],
3557
+ * [
3558
+ * 14.6,
3559
+ * 75.33
3560
+ * ],
3561
+ * [
3562
+ * 28,
3563
+ * -2.4
3564
+ * ],
3565
+ * [
3566
+ * 41.12,
3567
+ * 16
3568
+ * ]
3569
+ * ]
2852
3570
  */
2853
3571
  profile: [
2854
3572
  number,
@@ -2864,6 +3582,7 @@ export interface components {
2864
3582
  * Flightplan ID
2865
3583
  * Format: uuid
2866
3584
  * @description Unique identifier of the flightplan.
3585
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
2867
3586
  */
2868
3587
  id: string;
2869
3588
  /**
@@ -2889,6 +3608,7 @@ export interface components {
2889
3608
  /**
2890
3609
  * ARC Display Name
2891
3610
  * @description ARC sub-category display name
3611
+ * @example ARC-c (Class E or G Airspace)
2892
3612
  */
2893
3613
  name: string;
2894
3614
  /** Implemented */
@@ -2923,7 +3643,7 @@ export interface components {
2923
3643
  * - 'arc-d1' - ARC-d (Class A Airspace)
2924
3644
  *
2925
3645
  * - 'arc-d2' - ARC-d (Class C or D Airspace in area with known Instrument Flight Procedures)
2926
- *
3646
+ * @example arc-c1
2927
3647
  * @enum {string}
2928
3648
  */
2929
3649
  id: "arc-a1" | "arc-a2" | "arc-a3" | "arc-a4" | "arc-a5" | "arc-b1" | "arc-c1" | "arc-c2" | "arc-c3" | "arc-c4" | "arc-d1" | "arc-d2";
@@ -2940,6 +3660,7 @@ export interface components {
2940
3660
  /**
2941
3661
  * Final GRC Determination
2942
3662
  * @description The Final GRC determination, based on the availability and correct application of mitigations to the operation after determination of the intrinsic GRC.
3663
+ * @example 6
2943
3664
  * @enum {integer}
2944
3665
  */
2945
3666
  final_grc: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
@@ -2950,30 +3671,40 @@ export interface components {
2950
3671
  * Strategic Air Risk Mitigations
2951
3672
  * @description Strategic air risk mitigations to be applied when determining the Residual ARC from the Initial ARC. These are given as a mapping between the Initial ARC and a reduction in the air risk class.
2952
3673
  * @default {}
3674
+ * @example {
3675
+ * "arc-c1": 1
3676
+ * }
2953
3677
  */
2954
3678
  air_risk_mitigations?: {
2955
- [key: string]: (1 | 2) | undefined;
3679
+ [key: string]: 1 | 2;
2956
3680
  };
2957
3681
  /**
2958
3682
  * Ground Risk Buffer
2959
3683
  * @description The ground risk buffer is an area on the ground that surrounds the footprint of the contingency volume. It is expected that if the flight exits the contingency volume during a loss of control of the operation that the flight will be terminated within this lateral distance.
3684
+ * @example 100
2960
3685
  */
2961
3686
  ground_risk_buffer: number;
2962
- /** @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. The values are normalised by source data cell area to derive a density value of people per square metre. */
3687
+ /**
3688
+ * @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. The values are normalised by source data cell area to derive a density value of people per square metre.
3689
+ * @example GHS_2020_R2023_100
3690
+ */
2963
3691
  population_density_source: components["schemas"]["PopulationSource"];
2964
3692
  /** Controlled Ground Area Id */
2965
3693
  controlled_ground_area_id?: string | null;
2966
3694
  /** Atypical Airspace Id */
2967
3695
  atypical_airspace_id?: string | null;
2968
- /** @default {
3696
+ /**
3697
+ * @default {
2969
3698
  * "max_cruise_speed": 20,
2970
3699
  * "characteristic_dimension": 0.5
2971
- * } */
3700
+ * }
3701
+ */
2972
3702
  aircraft?: components["schemas"]["Aircraft"];
2973
3703
  /**
2974
3704
  * Containment Robustness
2975
3705
  * @description Level of technical and operational mitigations intended to contain the flight of the UA within the defined operational volume and ground risk buffer.
2976
3706
  * @default low
3707
+ * @example low
2977
3708
  * @enum {string}
2978
3709
  */
2979
3710
  containment_robustness?: "low" | "medium" | "high";
@@ -3018,24 +3749,28 @@ export interface components {
3018
3749
  /**
3019
3750
  * Mitigation 1(A)
3020
3751
  * @description Strategic mitigations for ground risk.
3752
+ * @example none
3021
3753
  * @enum {string}
3022
3754
  */
3023
3755
  m1a: "none" | "low" | "medium";
3024
3756
  /**
3025
3757
  * Mitigation 1(B)
3026
3758
  * @description Visual Line of Sight (VLOS) - avoid flying over people
3759
+ * @example none
3027
3760
  * @enum {string}
3028
3761
  */
3029
3762
  m1b: "none" | "medium" | "high";
3030
3763
  /**
3031
3764
  * Mitigation 1(C)
3032
3765
  * @description Tactical Mitigations - Ground observation
3766
+ * @example none
3033
3767
  * @enum {string}
3034
3768
  */
3035
3769
  m1c: "none" | "low";
3036
3770
  /**
3037
3771
  * Mitigation 2
3038
3772
  * @description Efforts to reduce UA impact dynamics
3773
+ * @example none
3039
3774
  * @enum {string}
3040
3775
  */
3041
3776
  m2: "none" | "medium" | "high";
@@ -3045,6 +3780,7 @@ export interface components {
3045
3780
  /**
3046
3781
  * Residual Air Risk Classification
3047
3782
  * @description Determination of Air Risk after the application of any strategic mitigations intended to control the crewed aircraft type, encounter rates or time of exposure, prior to take-off
3783
+ * @example arc-c
3048
3784
  * @enum {string}
3049
3785
  */
3050
3786
  residual_arc: "arc-a" | "arc-b" | "arc-c" | "arc-d";
@@ -3057,9 +3793,12 @@ export interface components {
3057
3793
  * Strategic Air Risk Mitigations
3058
3794
  * @description Strategic air risk mitigations to be applied when determining the Residual ARC from the Initial ARC. These are given as a mapping between the Initial ARC and a reduction in the air risk class.
3059
3795
  * @default {}
3796
+ * @example {
3797
+ * "arc-c1": 1
3798
+ * }
3060
3799
  */
3061
3800
  air_risk_mitigations?: {
3062
- [key: string]: (1 | 2) | undefined;
3801
+ [key: string]: 1 | 2;
3063
3802
  };
3064
3803
  };
3065
3804
  /** UkResidualArcResponse */
@@ -3068,6 +3807,7 @@ export interface components {
3068
3807
  /**
3069
3808
  * Residual Air Risk Classification
3070
3809
  * @description Determination of Air Risk after the application of any strategic mitigations intended to control the crewed aircraft type, encounter rates or time of exposure, prior to take-off
3810
+ * @example arc-c
3071
3811
  * @enum {string}
3072
3812
  */
3073
3813
  id: "arc-a" | "arc-b" | "arc-c" | "arc-d";
@@ -3077,6 +3817,7 @@ export interface components {
3077
3817
  /**
3078
3818
  * SAIL
3079
3819
  * @description The SAIL represents the level of confidence that the UAS operation will stay under control.
3820
+ * @example V
3080
3821
  * @enum {string}
3081
3822
  */
3082
3823
  sail: "NA" | "I" | "II" | "III" | "IV" | "V" | "VI" | "VII";
@@ -3096,22 +3837,58 @@ export interface components {
3096
3837
  /**
3097
3838
  * Chart ID
3098
3839
  * @description Unique identifier for a chart.
3840
+ * @example bath
3099
3841
  */
3100
3842
  chart_id: string;
3101
3843
  /**
3102
3844
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
3103
3845
  * @default NASADEM
3846
+ * @example NASADEM
3104
3847
  */
3105
3848
  terrain_source?: components["schemas"]["TerrainSource"];
3106
3849
  aircraft: components["schemas"]["Aircraft"];
3107
3850
  /**
3108
3851
  * Waypoints
3109
3852
  * @description Points defining a Flightplan that must be passed through along with flight parameters. The first waypoint must be of type: WaypointType.START and only occur once
3853
+ * @example [
3854
+ * {
3855
+ * "position": {
3856
+ * "altitude": 100,
3857
+ * "lat": 51.381,
3858
+ * "lng": -2.363
3859
+ * },
3860
+ * "type": "start"
3861
+ * },
3862
+ * {
3863
+ * "flight_parameters": {
3864
+ * "airspeed": 20,
3865
+ * "lateral": {
3866
+ * "contingency_buffer": 50,
3867
+ * "manoeuvre_corridor": 100,
3868
+ * "tse": 30
3869
+ * },
3870
+ * "vertical": {
3871
+ * "tse": 30
3872
+ * }
3873
+ * },
3874
+ * "position": {
3875
+ * "altitude": 100,
3876
+ * "lat": 51.382,
3877
+ * "lng": -2.357
3878
+ * },
3879
+ * "type": "goto",
3880
+ * "wind_parameters": {
3881
+ * "direction": 130,
3882
+ * "speed": 5
3883
+ * }
3884
+ * }
3885
+ * ]
3110
3886
  */
3111
3887
  waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Input"])[];
3112
3888
  /**
3113
3889
  * Ground Risk Buffer
3114
3890
  * @description The ground risk buffer is an area on the ground that surrounds the footprint of the contingency volume. It is expected that if the flight exits the contingency volume during a loss of control of the operation that the flight will be terminated within this lateral distance.
3891
+ * @example 100
3115
3892
  */
3116
3893
  ground_risk_buffer: number;
3117
3894
  };
@@ -3138,27 +3915,32 @@ export interface components {
3138
3915
  /**
3139
3916
  * Final GRC Determination
3140
3917
  * @description The Final GRC determination, based on the availability and correct application of mitigations to the operation after determination of the intrinsic GRC.
3918
+ * @example 6
3141
3919
  */
3142
3920
  final_grc: (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10) | "Category C";
3143
3921
  /**
3144
3922
  * Intrinsic UAS Ground Risk Class (iGRC)
3145
3923
  * @description The intrinsic UAS ground risk relates to the risk of a person being fatally struck by the UAS in the case where the UAS operation is out of control) absent of any mitigations being present
3924
+ * @example 6
3146
3925
  */
3147
3926
  intrinsic_grc: (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10) | "Category C";
3148
3927
  /**
3149
3928
  * Max Operational Population Density
3150
3929
  * @description The maximum population density overflown within the nominal flight operational volume and ground risk buffer, defined in people/km². Determined in the assessment of intrinsic ground risk before application of any mitigations.
3930
+ * @example 20000
3151
3931
  */
3152
3932
  max_operational_population_density: number;
3153
3933
  /**
3154
3934
  * Residual Air Risk Classification
3155
3935
  * @description Determination of Air Risk after the application of any strategic mitigations intended to control the crewed aircraft type, encounter rates or time of exposure, prior to take-off
3936
+ * @example arc-c
3156
3937
  * @enum {string}
3157
3938
  */
3158
3939
  residual_arc: "arc-a" | "arc-b" | "arc-c" | "arc-d";
3159
3940
  /**
3160
3941
  * SAIL
3161
3942
  * @description The SAIL represents the level of confidence that the UAS operation will stay under control.
3943
+ * @example V
3162
3944
  */
3163
3945
  sail: ("NA" | "I" | "II" | "III" | "IV" | "V" | "VI" | "VII") | "Category C";
3164
3946
  containment: components["schemas"]["UkContainmentRequirements"];
@@ -3168,11 +3950,45 @@ export interface components {
3168
3950
  /**
3169
3951
  * Chart ID
3170
3952
  * @description Unique identifier for a chart.
3953
+ * @example bath
3171
3954
  */
3172
3955
  chart_id: string;
3173
3956
  /**
3174
3957
  * Waypoints
3175
3958
  * @description Points defining a Flightplan that must be passed through along with flight parameters. The first waypoint must be of type: WaypointType.START and only occur once
3959
+ * @example [
3960
+ * {
3961
+ * "position": {
3962
+ * "altitude": 100,
3963
+ * "lat": 51.381,
3964
+ * "lng": -2.363
3965
+ * },
3966
+ * "type": "start"
3967
+ * },
3968
+ * {
3969
+ * "flight_parameters": {
3970
+ * "airspeed": 20,
3971
+ * "lateral": {
3972
+ * "contingency_buffer": 50,
3973
+ * "manoeuvre_corridor": 100,
3974
+ * "tse": 30
3975
+ * },
3976
+ * "vertical": {
3977
+ * "tse": 30
3978
+ * }
3979
+ * },
3980
+ * "position": {
3981
+ * "altitude": 100,
3982
+ * "lat": 51.382,
3983
+ * "lng": -2.357
3984
+ * },
3985
+ * "type": "goto",
3986
+ * "wind_parameters": {
3987
+ * "direction": 130,
3988
+ * "speed": 5
3989
+ * }
3990
+ * }
3991
+ * ]
3176
3992
  */
3177
3993
  waypoints: (components["schemas"]["StartWaypoint"] | components["schemas"]["GotoWaypoint-Input"])[];
3178
3994
  aircraft: components["schemas"]["Aircraft"];
@@ -3181,20 +3997,28 @@ export interface components {
3181
3997
  * Strategic Air Risk Mitigations
3182
3998
  * @description Strategic air risk mitigations to be applied when determining the Residual ARC from the Initial ARC. These are given as a mapping between the Initial ARC and a reduction in the air risk class.
3183
3999
  * @default {}
4000
+ * @example {
4001
+ * "arc-c1": 1
4002
+ * }
3184
4003
  */
3185
4004
  air_risk_mitigations?: {
3186
- [key: string]: (1 | 2) | undefined;
4005
+ [key: string]: 1 | 2;
3187
4006
  };
3188
- /** @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. The values are normalised by source data cell area to derive a density value of people per square metre. */
4007
+ /**
4008
+ * @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. The values are normalised by source data cell area to derive a density value of people per square metre.
4009
+ * @example GHS_2020_R2023_100
4010
+ */
3189
4011
  population_density_source: components["schemas"]["PopulationSource"];
3190
4012
  /**
3191
4013
  * @description Terrain Elevation Data Source. Data has been reprojected and resampled to a square grid in UTM coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest value present in any of the cells of the source grid it intersects. Terrain is reported as elevation in metres above the EGM2008 Geoid (EPSG:3855) and does not include buildings or man-made structures.
3192
4014
  * @default NASADEM
4015
+ * @example NASADEM
3193
4016
  */
3194
4017
  terrain_source?: components["schemas"]["TerrainSource"];
3195
4018
  /**
3196
4019
  * Ground Risk Buffer
3197
4020
  * @description The ground risk buffer is an area on the ground that surrounds the footprint of the contingency volume. It is expected that if the flight exits the contingency volume during a loss of control of the operation that the flight will be terminated within this lateral distance.
4021
+ * @example 100
3198
4022
  */
3199
4023
  ground_risk_buffer: number;
3200
4024
  /**
@@ -3232,6 +4056,7 @@ export interface components {
3232
4056
  /**
3233
4057
  * Tse
3234
4058
  * @description Total system error in a vertical plane, in metres. Includes positional error due to pathing, navigation and instrumentation. Defined as the 2-sigma/95% error limit. For example, if the tse_vertical is 30 metres then on average an aircraft should be less than 30 metres away from its planned route at least 95% of the time.
4059
+ * @example 30
3235
4060
  */
3236
4061
  tse: number;
3237
4062
  };
@@ -3243,9 +4068,15 @@ export interface components {
3243
4068
  */
3244
4069
  "Volume3D-Input": {
3245
4070
  outline_polygon: components["schemas"]["Polygon"];
3246
- /** Altitude Lower */
4071
+ /**
4072
+ * Altitude Lower
4073
+ * @example 100
4074
+ */
3247
4075
  altitude_lower: number;
3248
- /** Altitude Upper */
4076
+ /**
4077
+ * Altitude Upper
4078
+ * @example 100
4079
+ */
3249
4080
  altitude_upper: number;
3250
4081
  };
3251
4082
  /**
@@ -3256,9 +4087,15 @@ export interface components {
3256
4087
  */
3257
4088
  "Volume3D-Output": {
3258
4089
  outline_polygon: components["schemas"]["Polygon"];
3259
- /** Altitude Lower */
4090
+ /**
4091
+ * Altitude Lower
4092
+ * @example 100
4093
+ */
3260
4094
  altitude_lower: number;
3261
- /** Altitude Upper */
4095
+ /**
4096
+ * Altitude Upper
4097
+ * @example 100
4098
+ */
3262
4099
  altitude_upper: number;
3263
4100
  };
3264
4101
  /** Volume4D */
@@ -3268,12 +4105,16 @@ export interface components {
3268
4105
  * Time Start
3269
4106
  * Format: date-time
3270
4107
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
4108
+ * @example 2023-10-30T10:57:57Z
4109
+ * @example 2023-10-30T10:57:57+00:00
3271
4110
  */
3272
4111
  time_start: string;
3273
4112
  /**
3274
4113
  * Time End
3275
4114
  * Format: date-time
3276
4115
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
4116
+ * @example 2023-10-30T10:57:57Z
4117
+ * @example 2023-10-30T10:57:57+00:00
3277
4118
  */
3278
4119
  time_end: string;
3279
4120
  };
@@ -3284,12 +4125,16 @@ export interface components {
3284
4125
  * Time Start
3285
4126
  * Format: date-time
3286
4127
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
4128
+ * @example 2023-10-30T10:57:57Z
4129
+ * @example 2023-10-30T10:57:57+00:00
3287
4130
  */
3288
4131
  time_start: string;
3289
4132
  /**
3290
4133
  * Time End
3291
4134
  * Format: date-time
3292
4135
  * @description RFC3339-formatted (section 5.6) and ISO8601-compatible. The date/time separator must be 'T' and the time zone must be 'Z' or '+00:00'. Values must be between '1970-01-01T00:00:00Z' and '2100-01-01T00:00:00Z'.
4136
+ * @example 2023-10-30T10:57:57Z
4137
+ * @example 2023-10-30T10:57:57+00:00
3293
4138
  */
3294
4139
  time_end: string;
3295
4140
  };
@@ -3320,6 +4165,7 @@ export interface components {
3320
4165
  * Volume ID
3321
4166
  * Format: uuid
3322
4167
  * @description Unique Identifier for a volume
4168
+ * @example a2103691-6cf8-4cc4-b33c-2409967d6913
3323
4169
  */
3324
4170
  id: string;
3325
4171
  /**
@@ -3339,6 +4185,7 @@ export interface components {
3339
4185
  /**
3340
4186
  * Maximum Length
3341
4187
  * @description Maximum 4D volume length prior to application of buffering. Overrides default multiplicative behaviour from 4D Volume width. Omission of this field specifies no maximum, a reasonable multiplier of 4D Volume width will be applied to determine length.
4188
+ * @example 1000
3342
4189
  */
3343
4190
  maximum_length?: number | null;
3344
4191
  };
@@ -3347,6 +4194,45 @@ export interface components {
3347
4194
  /**
3348
4195
  * Waypoints
3349
4196
  * @description Detailed points defining a Flightplan that must be passed through along with flight parameters, including additional calculated fields.
4197
+ * @example [
4198
+ * {
4199
+ * "altitude_amsl": 100,
4200
+ * "id": "03e5572a-f733-49af-bc14-8a18bd53ee39",
4201
+ * "index": 0,
4202
+ * "planar_distance": 0,
4203
+ * "position": {
4204
+ * "altitude": 100,
4205
+ * "lat": 51.381,
4206
+ * "lng": -2.363
4207
+ * },
4208
+ * "time": "2023-10-30T10:57:57Z",
4209
+ * "type": "start"
4210
+ * },
4211
+ * {
4212
+ * "altitude_amsl": 100,
4213
+ * "flight_parameters": {
4214
+ * "airspeed": 20,
4215
+ * "lateral": {
4216
+ * "contingency_buffer": 50,
4217
+ * "manoeuvre_corridor": 100,
4218
+ * "tse": 30
4219
+ * },
4220
+ * "vertical": {
4221
+ * "tse": 30
4222
+ * }
4223
+ * },
4224
+ * "id": "5348d52d-2c15-4fe8-bfe9-419d6499cf15",
4225
+ * "index": 1,
4226
+ * "planar_distance": 430,
4227
+ * "position": {
4228
+ * "altitude": 100,
4229
+ * "lat": 51.382,
4230
+ * "lng": -2.357
4231
+ * },
4232
+ * "time": "2023-10-30T10:58:15Z",
4233
+ * "type": "goto"
4234
+ * }
4235
+ * ]
3350
4236
  */
3351
4237
  waypoints: (components["schemas"]["StartWaypointDetail"] | components["schemas"]["GotoWaypointDetail"])[];
3352
4238
  };
@@ -3359,6 +4245,7 @@ export interface components {
3359
4245
  * Flightplan ID
3360
4246
  * Format: uuid
3361
4247
  * @description Unique identifier of the flightplan.
4248
+ * @example 03e5572a-f733-49af-bc14-8a18bd53ee39
3362
4249
  */
3363
4250
  id: string;
3364
4251
  /**
@@ -3377,11 +4264,13 @@ export interface components {
3377
4264
  /**
3378
4265
  * Lat
3379
4266
  * @description Degrees of latitude north of the equator, with reference to the WGS84 ellipsoid.
4267
+ * @example 34.123
3380
4268
  */
3381
4269
  lat: number;
3382
4270
  /**
3383
4271
  * Lng
3384
4272
  * @description Degrees of longitude east of the Prime Meridian, with reference to the WGS84 ellipsoid.
4273
+ * @example -118.456
3385
4274
  */
3386
4275
  lng: number;
3387
4276
  };
@@ -3393,14 +4282,19 @@ export interface components {
3393
4282
  /**
3394
4283
  * Lat
3395
4284
  * @description Degrees of latitude north of the equator, with reference to the WGS84 ellipsoid.
4285
+ * @example 34.123
3396
4286
  */
3397
4287
  lat: number;
3398
4288
  /**
3399
4289
  * Lng
3400
4290
  * @description Degrees of longitude east of the Prime Meridian, with reference to the WGS84 ellipsoid.
4291
+ * @example -118.456
3401
4292
  */
3402
4293
  lng: number;
3403
- /** Altitude */
4294
+ /**
4295
+ * Altitude
4296
+ * @example 100
4297
+ */
3404
4298
  altitude: number;
3405
4299
  };
3406
4300
  /** WindParameters */
@@ -3415,12 +4309,14 @@ export interface components {
3415
4309
  * - 90 degrees means that wind is moving from East to West
3416
4310
  * - 270 degrees means that wind is moving West to East
3417
4311
  * @default 0
4312
+ * @example 20
3418
4313
  */
3419
4314
  direction?: number;
3420
4315
  /**
3421
4316
  * Speed
3422
4317
  * @description The mean wind speed in metres per second
3423
4318
  * @default 0
4319
+ * @example 5
3424
4320
  */
3425
4321
  speed?: number;
3426
4322
  };
@@ -3849,9 +4745,7 @@ export interface operations {
3849
4745
  flightplan_statistics_v1_flightplans__flightplan_id__statistics_get: {
3850
4746
  parameters: {
3851
4747
  query?: {
3852
- /** @description
3853
- * External user defined [Cost Dataset](#Cost%20Datasets) to use when calculating statistics of the flightplan.
3854
- * */
4748
+ /** @description External user defined [Cost Dataset](#Cost%20Datasets) to use when calculating statistics of the flightplan. */
3855
4749
  cost_dataset_id?: string | null;
3856
4750
  /** @description Weight multiplier to apply to ground risk when combining cost fields. */
3857
4751
  ground_risk_weighting?: number;
@@ -4600,9 +5494,7 @@ export interface operations {
4600
5494
  };
4601
5495
  requestBody?: never;
4602
5496
  responses: {
4603
- /** @description A stream of Server-Sent Events (SSE).
4604
- *
4605
- * */
5497
+ /** @description A stream of Server-Sent Events (SSE). */
4606
5498
  200: {
4607
5499
  headers: {
4608
5500
  [name: string]: unknown;
@@ -5353,7 +6245,8 @@ export interface operations {
5353
6245
  query: {
5354
6246
  /** @description The Final GRC determination, based on the availability and correct application of mitigations to the operation after determination of the intrinsic GRC. */
5355
6247
  final_grc: components["schemas"]["FinalGRC"];
5356
- /** @description Qualitative classification of the rate at which a UAS would encounter a manned aircraft in a given airspace environment.
6248
+ /**
6249
+ * @description Qualitative classification of the rate at which a UAS would encounter a manned aircraft in a given airspace environment.
5357
6250
  *
5358
6251
  * - 'arc-a1' - ARC-a (NMAC Encounter Rate)
5359
6252
  *
@@ -5390,7 +6283,7 @@ export interface operations {
5390
6283
  * - 'arc-d3' - ARC-d (>500ft AGL but <FL600 and TMZ)
5391
6284
  *
5392
6285
  * - 'arc-d4' - ARC-d (>500ft AGL but <FL600 Mode-C Veil)
5393
- * */
6286
+ */
5394
6287
  arc: components["schemas"]["ARC"][];
5395
6288
  };
5396
6289
  header?: never;
@@ -5480,7 +6373,8 @@ export interface operations {
5480
6373
  query?: never;
5481
6374
  header?: never;
5482
6375
  path: {
5483
- /** @description Qualitative classification of the rate at which a UAS would encounter a manned aircraft in a given airspace environment.
6376
+ /**
6377
+ * @description Qualitative classification of the rate at which a UAS would encounter a manned aircraft in a given airspace environment.
5484
6378
  *
5485
6379
  * - 'arc-a1' - ARC-a (NMAC Encounter Rate)
5486
6380
  *
@@ -5517,7 +6411,7 @@ export interface operations {
5517
6411
  * - 'arc-d3' - ARC-d (>500ft AGL but <FL600 and TMZ)
5518
6412
  *
5519
6413
  * - 'arc-d4' - ARC-d (>500ft AGL but <FL600 Mode-C Veil)
5520
- * */
6414
+ */
5521
6415
  arc_id: string;
5522
6416
  };
5523
6417
  cookie?: never;
@@ -5729,7 +6623,8 @@ export interface operations {
5729
6623
  query: {
5730
6624
  /** @description The Final GRC determination, based on the availability and correct application of mitigations to the operation after determination of the intrinsic GRC. */
5731
6625
  final_grc: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
5732
- /** @description Qualitative classification of the air environment.
6626
+ /**
6627
+ * @description Qualitative classification of the air environment.
5733
6628
  *
5734
6629
  * - 'arc-a1' - ARC-a (NMAC Encounter Rate)
5735
6630
  *
@@ -5754,7 +6649,7 @@ export interface operations {
5754
6649
  * - 'arc-d1' - ARC-d (Class A Airspace)
5755
6650
  *
5756
6651
  * - 'arc-d2' - ARC-d (Class C or D Airspace in area with known Instrument Flight Procedures)
5757
- * */
6652
+ */
5758
6653
  arc: ("arc-a1" | "arc-a2" | "arc-a3" | "arc-a4" | "arc-a5" | "arc-b1" | "arc-c1" | "arc-c2" | "arc-c3" | "arc-c4" | "arc-d1" | "arc-d2")[];
5759
6654
  };
5760
6655
  header?: never;
@@ -5844,7 +6739,8 @@ export interface operations {
5844
6739
  query?: never;
5845
6740
  header?: never;
5846
6741
  path: {
5847
- /** @description Qualitative classification of the air environment.
6742
+ /**
6743
+ * @description Qualitative classification of the air environment.
5848
6744
  *
5849
6745
  * - 'arc-a1' - ARC-a (NMAC Encounter Rate)
5850
6746
  *
@@ -5869,7 +6765,7 @@ export interface operations {
5869
6765
  * - 'arc-d1' - ARC-d (Class A Airspace)
5870
6766
  *
5871
6767
  * - 'arc-d2' - ARC-d (Class C or D Airspace in area with known Instrument Flight Procedures)
5872
- * */
6768
+ */
5873
6769
  arc_id: "arc-a1" | "arc-a2" | "arc-a3" | "arc-a4" | "arc-a5" | "arc-b1" | "arc-c1" | "arc-c2" | "arc-c3" | "arc-c4" | "arc-d1" | "arc-d2";
5874
6770
  };
5875
6771
  cookie?: never;