Skip to content

[Changed] Refactor subscription schemas for Commonalities r4.4 and add initialEvent #113

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 1 commit into from
Sep 14, 2026
+10 −5
Merged

[Changed] Refactor subscription schemas for Commonalities r4.4 and add initialEvent #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions code/API_definitions/device-data-volume-subscriptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.3

Check failure on line 1 in code/API_definitions/device-data-volume-subscriptions.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

$ref target does not exist 

[S-229] '#/components/schemas/ConfigBase' does not exist @ 'code/common/CAMARA_event_common.yaml' | Suggestion: The $ref points to a JSON pointer that does not exist in the target file. Check the pointer name against the target's components section — a schema renamed or removed in a newer Commonalities release is the usual cause. Fix the reference in this API definition; do not edit code/common/.
info:
title: Device Data Volume Subscriptions
description: |
Expand Down Expand Up @@ -358,21 +358,26 @@
$ref: "../common/CAMARA_event_common.yaml#/components/schemas/SubscriptionId"

schemas:
SubscriptionDetailLocal:
SubscriptionDetail:

Check warning on line 361 in code/API_definitions/device-data-volume-subscriptions.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused 

[S-211] Potentially unused component has been detected. | Suggestion: Remove the component if it is obsolete, or reference it from the API definition.
description: The details of the requested device data volume 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/SubscriptionDetailLocal"

Check failure on line 375 in code/API_definitions/device-data-volume-subscriptions.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

$ref target does not exist 

[S-229] '#/components/schemas/SubscriptionDetailLocal' does not exist | Suggestion: The $ref points to a JSON pointer that does not exist in the target file. Check the pointer name against the target's components section — a schema renamed or removed in a newer Commonalities release is the usual cause. Fix the reference in this API definition; do not edit code/common/.
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
type: boolean

ApiEventType:
type: string
Expand Down Expand Up @@ -443,7 +448,7 @@
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:
Expand Down Expand Up @@ -501,7 +506,7 @@
items:
$ref: "#/components/schemas/ApiEventType"
config:
$ref: "#/components/schemas/ConfigLocal"
$ref: "#/components/schemas/Config"
discriminator:
propertyName: protocol
mapping:
Expand Down
Loading