From a40ec9ecb128655c9775561bb3ad77f74d1ab7f3 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Mon, 14 Sep 2026 14:41:57 +0100 Subject: [PATCH 1/4] Update schema names for Commonalities r4.4 --- ...evice-reachability-status-subscriptions.yaml | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/code/API_definitions/device-reachability-status-subscriptions.yaml b/code/API_definitions/device-reachability-status-subscriptions.yaml index cd90c59..7761d3b 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,7 +400,7 @@ components: $ref: "../common/CAMARA_event_common.yaml#/components/schemas/SubscriptionId" schemas: - CreateSubscriptionDetailLocal: + CreateSubscriptionDetail: description: The detail of the requested event subscription. type: object properties: @@ -410,11 +410,16 @@ components: ConfigLocal: 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: From 70915c489282366bec861ac0acab113eedc8aa11 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Mon, 14 Sep 2026 14:44:40 +0100 Subject: [PATCH 2/4] Sync info.description templates with Commonalities r4.4 --- code/API_definitions/device-reachability-status.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/code/API_definitions/device-reachability-status.yaml b/code/API_definitions/device-reachability-status.yaml index 9b2d9b9..dfb5fc6 100644 --- a/code/API_definitions/device-reachability-status.yaml +++ b/code/API_definitions/device-reachability-status.yaml @@ -72,13 +72,11 @@ info: - Identifying the intended device from a unique identifier for that device, such as its source IP address and port - Check with the SIM provider whether a unique "secondary" phone number is already associated with each device, and use the secondary phone number to identify the intended device if available. - - # Additional CAMARA error responses 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. From db868725e8ae553c9cf314b0cb5fe974499cf18c Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Mon, 14 Sep 2026 15:00:19 +0100 Subject: [PATCH 3/4] Rename ConfigLocal to Config in YAML schema Renamed 'ConfigLocal' to 'Config' in the device reachability status subscriptions schema. --- .../device-reachability-status-subscriptions.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/device-reachability-status-subscriptions.yaml b/code/API_definitions/device-reachability-status-subscriptions.yaml index 7761d3b..0ae89b3 100644 --- a/code/API_definitions/device-reachability-status-subscriptions.yaml +++ b/code/API_definitions/device-reachability-status-subscriptions.yaml @@ -407,7 +407,7 @@ components: 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/ConfigBase" From 177c8faa82d147360a958a51fdfcf93b4e8b143d Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Mon, 14 Sep 2026 15:10:56 +0100 Subject: [PATCH 4/4] Update device reachability status YAML with error notes Added note about non-exhaustive error codes in API specification. --- code/API_definitions/device-reachability-status.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/code/API_definitions/device-reachability-status.yaml b/code/API_definitions/device-reachability-status.yaml index dfb5fc6..db4921b 100644 --- a/code/API_definitions/device-reachability-status.yaml +++ b/code/API_definitions/device-reachability-status.yaml @@ -72,6 +72,8 @@ info: - Identifying the intended device from a unique identifier for that device, such as its source IP address and port - Check with the SIM provider whether a unique "secondary" phone number is already associated with each device, and use the secondary phone number to identify the intended device if available. + + # Additional CAMARA error responses 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`.