Skip to content

[Fixed] Correct info.description documentation regarding identified device notification #90

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
akoshunyadi merged 1 commit into from
Jul 31, 2026
+1 −1
Merged

[Fixed] Correct info.description documentation regarding identified device notification #90

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
2 changes: 1 addition & 1 deletion code/API_definitions/device-roaming-status-subscriptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

* **Device**: A device refers to any physical entity that can connect to a network and participate in network communication.

At least one identifier for the device out of four options must be provided: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device. Where more than one device identifier is provided, only one identifier will be selected by the implementation and this choice indicated to the API consumer in the session creation response.
At least one identifier for the device out of four options must be provided: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device. Where more than one device identifier is provided, only one identifier will be selected by the implementation and this choice indicated to the API consumer in the subscription creation response.

Note: Network Access Identifier is defined for future use and will not be supported with this version of the API.

Expand Down Expand Up @@ -684,7 +684,7 @@
subscriptionId:
$ref: "../common/CAMARA_event_common.yaml#/components/schemas/SubscriptionId"

EventRoamingStatus:

Check notice on line 687 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: event structure for roaming status change
allOf:
- $ref: "#/components/schemas/ApiNotificationEvent"
Expand All @@ -709,7 +709,7 @@
countryName:
$ref: "#/components/schemas/CountryName"

EventRoamingOn:

Check notice on line 712 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: event structure for roaming on change
allOf:
- $ref: "#/components/schemas/ApiNotificationEvent"
Expand All @@ -718,7 +718,7 @@
data:
$ref: "#/components/schemas/BasicDeviceEventData"

EventRoamingOff:

Check notice on line 721 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: event structure for roaming off change
allOf:
- $ref: "#/components/schemas/ApiNotificationEvent"
Expand All @@ -727,7 +727,7 @@
data:
$ref: "#/components/schemas/BasicDeviceEventData"

EventRoamingChangeCountry:

Check notice on line 730 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: event structure for roaming change country
allOf:
- $ref: "#/components/schemas/ApiNotificationEvent"
Expand All @@ -750,7 +750,7 @@
countryName:
$ref: "#/components/schemas/CountryName"

EventSubscriptionStarted:

Check notice on line 753 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: event structure for event subscription started
allOf:
- $ref: "#/components/schemas/SubscriptionLifecycleEvent"
Expand All @@ -764,7 +764,7 @@
$ref: "../common/CAMARA_common.yaml#/components/schemas/DeviceResponse"
- $ref: "../common/CAMARA_event_common.yaml#/components/schemas/SubscriptionStarted"

EventSubscriptionUpdated:

Check notice on line 767 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: event structure for event subscription updated
allOf:
- $ref: "#/components/schemas/SubscriptionLifecycleEvent"
Expand All @@ -778,7 +778,7 @@
$ref: "../common/CAMARA_common.yaml#/components/schemas/DeviceResponse"
- $ref: "../common/CAMARA_event_common.yaml#/components/schemas/SubscriptionUpdated"

EventSubscriptionEnded:

Check notice on line 781 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: event structure for event subscription ended
allOf:
- $ref: "#/components/schemas/SubscriptionLifecycleEvent"
Expand All @@ -800,7 +800,7 @@
pattern: ^https:\/\/.+$
example: "https://endpoint.example.com/sink"

HTTPSubscriptionRequest:

Check notice on line 803 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: Subscription request for HTTP-based event delivery.
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
Expand All @@ -809,7 +809,7 @@
protocolSettings:
$ref: "../common/CAMARA_event_common.yaml#/components/schemas/HTTPSettings"

HTTPSubscriptionResponse:

Check notice on line 812 in code/API_definitions/device-roaming-status-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: Spectral does not follow discriminator mappings — verify the schema is truly unused.
description: Subscription resource returned for HTTP-based event delivery.
allOf:
- $ref: "#/components/schemas/Subscription"
Expand Down
Loading