Skip to content

[Changed] Update response reference for unprocessable entity and improved initialEvent description #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eric-murray merged 2 commits into from
Oct 9, 2026
Merged

[Changed] Update response reference for unprocessable entity and improved initialEvent description #138

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40f275f
Refactor API response references and descriptions
eric-murray Oct 9, 2026
4d52553
Merge branch 'camaraproject:main' into eric-murray-patch-1
eric-murray Oct 9, 2026
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
6 changes: 3 additions & 3 deletions code/API_definitions/device-data-volume-subscriptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,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"

Expand Down Expand Up @@ -416,8 +416,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:
Expand Down
Loading