diff --git a/code/API_definitions/device-reachability-status-subscriptions.yaml b/code/API_definitions/device-reachability-status-subscriptions.yaml index cd90c59..0ae89b3 100644 --- a/code/API_definitions/device-reachability-status-subscriptions.yaml +++ b/code/API_definitions/device-reachability-status-subscriptions.yaml @@ -122,7 +122,7 @@ info: The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. + Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified from the `x-camara-commonalities` field, the changelog and the metadata of the released API version. As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. @@ -400,21 +400,26 @@ components: $ref: "../common/CAMARA_event_common.yaml#/components/schemas/SubscriptionId" schemas: - CreateSubscriptionDetailLocal: + CreateSubscriptionDetail: description: The detail of the requested event subscription. type: object properties: device: $ref: "../common/CAMARA_common.yaml#/components/schemas/Device" - ConfigLocal: + Config: description: Config schema allowing for device to be specified as part of subscription detail allOf: - - $ref: "../common/CAMARA_event_common.yaml#/components/schemas/Config" + - $ref: "../common/CAMARA_event_common.yaml#/components/schemas/ConfigBase" - type: object properties: subscriptionDetail: - $ref: "#/components/schemas/CreateSubscriptionDetailLocal" + $ref: "#/components/schemas/CreateSubscriptionDetail" + initialEvent: + description: | + Set to `true` by API consumer if consumer wants to get an event as soon as the subscription is created and current situation reflects event request. + Example: Consumer requests `reachability-disconnected` events. If API consumer sets initialEvent to true and device is not connected to the mobile network, an event is triggered + type: boolean ApiEventType: type: string @@ -484,7 +489,7 @@ components: items: $ref: "#/components/schemas/ApiEventType" config: - $ref: "#/components/schemas/ConfigLocal" + $ref: "#/components/schemas/Config" id: $ref: "../common/CAMARA_event_common.yaml#/components/schemas/SubscriptionId" startsAt: @@ -561,7 +566,7 @@ components: items: $ref: "#/components/schemas/ApiEventType" config: - $ref: "#/components/schemas/ConfigLocal" + $ref: "#/components/schemas/Config" discriminator: propertyName: protocol mapping: diff --git a/code/API_definitions/device-reachability-status.yaml b/code/API_definitions/device-reachability-status.yaml index 9b2d9b9..db4921b 100644 --- a/code/API_definitions/device-reachability-status.yaml +++ b/code/API_definitions/device-reachability-status.yaml @@ -78,7 +78,7 @@ info: The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. + Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified from the `x-camara-commonalities` field, the changelog and the metadata of the released API version. As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.