Skip to content
Merged
Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion code/API_definitions/predictive-connectivity-data.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.3

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

View check run for this annotation

camara-validation / CAMARA Validation

CloudEvent type format is wrong

[P-015] No event type enum values found in code/API_definitions/predictive-connectivity-data.yaml — subscription APIs should define EventType schemas Suggestion: Define a named event type schema (e.g. ApiEventType) that constrains the CloudEvent `type` value via allOf, rather than inlining the enum directly in CloudEvent.properties.type.enum. See the implicit-events API template in Commonalities artifacts/api-templates/ (tracked in camaraproject/Commonalities#608).
info:
title: Predictive Connectivity Data
description: |
Expand Down Expand Up @@ -273,7 +273,7 @@
parameters:
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
requestBody:
content:

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

View check run for this annotation

camara-validation / CAMARA Validation

Notification must use application/cloudevents+json

[S-035] Notification callback content type must include 'application/cloudevents+json', found: application/json
application/json:
schema:
$ref: '#/components/schemas/ConnectivityDataAsyncResponse'
Expand Down Expand Up @@ -312,6 +312,7 @@
RetrieveConnectivityRequest:
type: object
description: Request object for retrieving connectivity data in a specified area.
additionalProperties: false
properties:
serviceLevel:
$ref: '#/components/schemas/ServiceLevel'
Expand All @@ -328,7 +329,7 @@
format: int32
description: >-
Precision required of response cells. Precision defines a geohash level and corresponds to the length of the geohash for each cell. More information at [Geohash system](https://en.wikipedia.org/wiki/Geohash).
If not included the default precision level 7 is used by default.
When `area.areaType` is `POLYGON`, if not included the default precision level 7 is used.
Values within the schema range (1–12) that are not supported by the MNO return the error response `422 PREDICTIVE_CONNECTIVITY_DATA.UNSUPPORTED_PRECISION`. Values outside the schema range are invalid per the OpenAPI definition and return `400 INVALID_ARGUMENT` via request validation.
This property MUST only be set when `area.areaType` is `POLYGON`. When `area.areaType` is `GEOHASHLIST`, each requested geohash determines the granularity of its own response cell; if `precision` is sent, the API returns a `400 INVALID_ARGUMENT` error.
minimum: 1
Expand Down Expand Up @@ -471,7 +472,7 @@
maxItems: 168
status:
$ref: '#/components/schemas/ResponseStatus'
statusInfo:

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

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 512
description: Information about the status, mandatory when property `status` is `OPERATION_NOT_COMPLETED` for adding extra information about the error.
Expand Down Expand Up @@ -506,7 +507,7 @@
$ref: '#/components/schemas/OperationId'
required:
- operationId
OperationId:

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

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: The unique identifier of the asynchronous operation that is returned when the operation is initiated.
Expand Down
Loading