From 40f275f2c5292f316fd5505b9ab9f013418cc1e8 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Fri, 9 Oct 2026 13:13:47 +0100 Subject: [PATCH] Refactor API response references and descriptions Updated response reference for unprocessable entity and improved initialEvent description. --- code/API_definitions/device-data-volume-subscriptions.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/code/API_definitions/device-data-volume-subscriptions.yaml b/code/API_definitions/device-data-volume-subscriptions.yaml index 2dea567..bf3a894 100644 --- a/code/API_definitions/device-data-volume-subscriptions.yaml +++ b/code/API_definitions/device-data-volume-subscriptions.yaml @@ -230,7 +230,7 @@ paths: "409": $ref: "../common/CAMARA_event_common.yaml#/components/responses/CreateSubscriptionConflict409" "422": - $ref: "../common/CAMARA_event_common.yaml#/components/responses/CreateSubscriptionUnprocessableEntity422" + $ref: "../common/CAMARA_event_common.yaml#/components/responses/CreateSubscriptionDevice422" "429": $ref: "#/components/responses/TooManyRequestsOrQuotaExceeded429" @@ -412,8 +412,8 @@ components: $ref: "#/components/schemas/SubscriptionDetail" 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 `data-10-percent-remaining` events. If API consumer sets initialEvent to true and remaining device data allowance is less than 10% of the full allowance, an event is triggered + Set to `true` if the API consumer wants to get an event as soon as the subscription is created and current situation matches the event trigger. + Example: The API consumer requests `data-10-percent-remaining` events. If the API consumer sets `initialEvent` to true, and the remaining device data allowance is equal to 10% of the full allowance, an initial event is triggered. type: boolean ApiEventType: