Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions code/API_definitions/predictive-connectivity-data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@
- notificationsBearerAuth: []
components:
securitySchemes:
openId:

Check warning on line 280 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "openId.description" property must be truthy
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
notificationsBearerAuth:
Expand All @@ -298,7 +298,7 @@
schema:
$ref: "#/components/schemas/XCorrelator"
schemas:
XCorrelator:

Check warning on line 301 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "XCorrelator.description" property must be truthy
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
Expand Down Expand Up @@ -383,7 +383,7 @@
POLYGON - The area is defined as a polygon.
enum:
- POLYGON
Polygon:

Check notice on line 386 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused

[S-211] Potentially unused component has been detected. | Suggestion%3A Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: Polygonal area. The Polygon should be a simple polygon, i.e. should not intersect itself.
allOf:
- $ref: "#/components/schemas/Area"
Expand Down Expand Up @@ -433,11 +433,13 @@
service levels are as follows:
- C2: Command and Control. Consists in connecting an unmanned aerial vehicle with its remote controller. This link allows data transmission in both directions, facilitating real-time operation and feedback.
- STREAM_4K: Streaming in 4K quality.
- TELE_OPERATION: Intended for vehicle tele-operation in the automotive sector. Combination of low-latency actuation and low-latency, high-throughput sensor feedback (e.g. camera feeds).
- BEST_EFFORT: This service level provides a qualitative estimation of coverage based on each operator's own prediction models or public coverage maps. It does not imply any guarantee of network performance or service availability. The values of GC, MC, NC, and ND should be interpreted as approximate indicators of expected connectivity quality, not as results derived from standardised thresholds.
type: string
enum:
- C2
- STREAM_4K
- TELE_OPERATION
- BEST_EFFORT
NetworkType:
description: >-
Expand All @@ -449,7 +451,7 @@
enum:
- 4G
- 5G
SinkCredential:

Check warning on line 454 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "SinkCredential.description" property must be truthy
type: object
properties:
credentialType:
Expand All @@ -469,7 +471,7 @@
REFRESHTOKEN: '#/components/schemas/RefreshTokenCredential'
required:
- credentialType
PlainCredential:

Check notice on line 474 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused

[S-211] Potentially unused component has been detected. | Suggestion%3A Spectral does not follow discriminator mappings — verify the schema is truly unused.
type: object
description: A plain credential as a combination of an identifier and a secret.
allOf:
Expand All @@ -485,7 +487,7 @@
secret:
description: The secret might be a password or passphrase.
type: string
AccessTokenCredential:

Check notice on line 490 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused

[S-211] Potentially unused component has been detected. | Suggestion%3A Spectral does not follow discriminator mappings — verify the schema is truly unused.
type: object
description: An access token credential.
allOf:
Expand All @@ -512,7 +514,7 @@
- accessToken
- accessTokenExpiresUtc
- accessTokenType
RefreshTokenCredential:

Check notice on line 517 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused

[S-211] Potentially unused component has been detected. | Suggestion%3A Spectral does not follow discriminator mappings — verify the schema is truly unused.
type: object
description: An access token credential with a refresh token.
allOf:
Expand Down Expand Up @@ -582,14 +584,14 @@
- layerThickness
- timedConnectivityData
- status
AcceptedAsyncResponse:

Check warning on line 587 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "AcceptedAsyncResponse.description" property must be truthy
type: object
properties:
operationId:
$ref: '#/components/schemas/OperationId'
required:
- operationId
ConnectivityDataAsyncResponse:

Check warning on line 594 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "ConnectivityDataAsyncResponse.description" property must be truthy
allOf:
- $ref: '#/components/schemas/ConnectivityDataResponse'
- type: object
Expand Down Expand Up @@ -718,14 +720,14 @@
nullable: true
description: Signal strength value in dBm, or null if no data is available
example: -85.5
Connectivity:

Check warning on line 723 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "Connectivity.description" property must be truthy
type: string
enum:
- GC
- MC
- NC
- ND
ErrorInfo:

Check warning on line 730 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "ErrorInfo.description" property must be truthy
type: object
required:
- status
Expand Down Expand Up @@ -1036,7 +1038,7 @@
code: TOO_MANY_REQUESTS
message: Rate limit reached.
examples:
ConnectivityDataSupportedAreaResponseExample:

Check warning on line 1041 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "ConnectivityDataSupportedAreaResponseExample.description" property must be truthy
value:
layerThickness: 30
timedConnectivityData:
Expand Down Expand Up @@ -1087,7 +1089,7 @@
- NC
- NC
status: SUPPORTED_AREA
ConnectivityDataPartOfAreaNotSupportedResponseExample:

Check warning on line 1092 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "ConnectivityDataPartOfAreaNotSupportedResponseExample.description" property must be truthy
value:
layerThickness: 30
timedConnectivityData:
Expand Down Expand Up @@ -1138,7 +1140,7 @@
- NC
- NC
status: PART_OF_AREA_NOT_SUPPORTED
ConnectivityDataAreaNotSupportedResponseExample:

Check warning on line 1143 in code/API_definitions/predictive-connectivity-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description

[S-011] Property description is missing or empty%3A "ConnectivityDataAreaNotSupportedResponseExample.description" property must be truthy
value:
layerThickness: 30
timedConnectivityData: []
Expand Down