Skip to content

Commit

Permalink
Merge branch 'main' into chore/include-x-correlator
Browse files Browse the repository at this point in the history
  • Loading branch information
akoshunyadi authored Apr 11, 2024
2 parents e384c90 + 5628f9a commit 255bf7b
Show file tree
Hide file tree
Showing 7 changed files with 449 additions and 42 deletions.
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,49 @@
# Changelog DeviceStatus
## Table of Contents
- [v0.5.1](#v051)
- [v0.5.0](#v050)
- [v0.5.0-rc](#v050-rc)
- [v0.4.1](#v041)
- [v0.2.0](#v020)

# v0.5.1
**This is a bugfix release for the third alpha version of the CAMARA DeviceStatus API**
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.1/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml)

## Please note:
- This is an alpha version, it should be considered as a draft.
- There are bug fixes to be expected and incompatible changes in upcoming versions.
- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments.

### Main Changes
* Minor bugfixes
* Changes in the inline documentation

### Added
* NA

### Changed
* Change description that subscriptionExpireTime is optional by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/120
* Updated in-line documentation for Roaming to clarify that country information can optionally be returned in the response. by @trehman-gsma in https://github.com/camaraproject/DeviceStatus/pull/127

### Fixed
* fix: move "countryCode" out of "device" in ROAMING_CHANGE_COUNTRY-example by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/106
* fix: add missing "subscriptionId" in "RoamingStatus"-data for CloudEvent by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/109
* fix: change INVALID_INPUT for INVALID_ARGUMENT according to guidelines by @fernandopradocabrillo in https://github.com/camaraproject/DeviceStatus/pull/129

### Removed
* NA

## New Contributors
* @trehman-gsma made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/127
* @fernandopradocabrillo made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/129

**Full Changelog**: https://github.com/camaraproject/DeviceStatus/compare/v0.5.0...v0.5.1


# v0.5.0
**This is the third alpha version of the CAMARA DeviceStatus API**
- API definition **with inline documentation**:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ Repository to describe, develop, document and test the DeviceStatus API family
## Status and released versions
* Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.

* The latest available and released version 0.5.0 of the API is available within the [release-0.5.0 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.0)
* The latest available and released version 0.5.1 of the API is available within the [release-0.5.1 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.1)
- API definition with inline documentation:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.0/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0/code/API_definitions/device-status.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.1/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml)

## Contributorship and mailing list
* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-dst>.
Expand Down
45 changes: 7 additions & 38 deletions code/API_definitions/device-status.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ info:
- via direct request with the roaming situation in the response.
- via a subscription request - in this case the roaming situation is not in the response but event notification is sent back to the event subscriber when roaming situation has changed.
The verification of the roaming situation depends on the network's ability. Additionally to the roaming status, when the device is in roaming situation, visited country information is send back in the response.
The verification of the roaming situation depends on the network's ability. Additionally to the roaming status, when the device is in roaming situation, visited country information could be returned in the response.
## Connectivity Status
Expand Down Expand Up @@ -81,7 +81,7 @@ info:
Note: Additionally to these list, ``org.camaraproject.device-status.v0.subscription-ends`` notification `type` is sent when the subscription ends.
This notification does not require dedicated subscription.
It is used when the subscription expire time (required by the requester) has been reached or if the API server has to stop sending notification prematurely.
It is used when the subscription expire time (optionally set by the requester) has been reached or if the API server has to stop sending notification prematurely.
### Notifications callback
Expand Down Expand Up @@ -388,24 +388,7 @@ paths:
schema:
$ref: "#/components/schemas/SubscriptionInfo"
"400":
description: Invalid input
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
examples:
Generic400:
summary: Schema validation failed
value:
code: INVALID_INPUT
status: 400
message: "Schema validation failed at ..."
subscriptionIdRequired:
summary: eventSubscription id is required
value:
code: INVALID_INPUT
status: 400
message: "Expected property is missing: subscriptionId"
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
Expand Down Expand Up @@ -444,24 +427,7 @@ paths:
schema:
$ref: "#/components/schemas/SubscriptionAsync"
"400":
description: Invalid input
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
examples:
Generic400:
summary: Schema validation failed
value:
code: INVALID_INPUT
status: 400
message: "Schema validation failed at ..."
subscriptionIdRequired:
summary: eventSubscription id is required
value:
code: INVALID_INPUT
status: 400
message: "Expected property is missing: subscriptionId"
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
Expand Down Expand Up @@ -941,6 +907,8 @@ components:
$ref: "#/components/schemas/CountryCode"
countryName:
$ref: "#/components/schemas/CountryName"
subscriptionId:
$ref: "#/components/schemas/SubscriptionId"

RoamingChangeCountry:
description: Event detail structure for org.camaraproject.device-status.v0.roaming-on event
Expand Down Expand Up @@ -1064,6 +1032,7 @@ components:
status: 503
code: "UNAVAILABLE"
message: "Service unavailable"

examples:
ROAMING_STATUS:
value:
Expand Down
82 changes: 82 additions & 0 deletions documentation/MeetingMinutes/MoM-2024-02-14.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Camara DeviceStatus meeting - MOM-2024-02-14

*February 14th, 2024*

## Attendees

* Akos Hunyadi (Deutsche Telekom)
* Fernando Prado Cabrillo (Telefonica)
* Jorge Garcia Hospital (Telefonica)
* Ludovic Robert (Orange)
* Rafal Artych (Deutsche Telekom)
* Sachin Kumar (Vodafone)

DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)

## Agenda

* Open PRs
* Open Issues
* Open Discussions
* API Roadmap
* AOB


## Open PRs
* [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
* Renaming the POST endpoints according to the design guidelines. No discussion, can be merged after approvals.

* [#109 fix: add missing "subscriptionId" in "RoamingStatus"-data for CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/109)
* No discussion, can be merged after approvals.

* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
* The enums for event-types include dots which causes problems at the code generation (Java) at DT.
* Additional feedback from dev teams would be helpful to priotize the issue.
* A possible change in the design guideline could be a solution.
* The PR has been marked as draft until an agreed solution is ellaborated.

## Open issues:

* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
* The name should correlate with similar properties at other APIs
* Is the information on 3GPP available at all?

* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
* The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)

* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
* No discussion, a PR should be created.

* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)

* [#97 Update response codes to string, following other CAMARA APIs](https://github.com/camaraproject/DeviceStatus/issues/97)
* The corresponding PR is open: [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)

* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
* The corresponding PR is open: [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)



## Open discussions
* [#105 v0.5.0 - Difference between "subscriptionExpireTime" & "expiresAt" in "SubscriptionInfo"](https://github.com/camaraproject/DeviceStatus/discussions/105)
* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
* [#98 Roaming Status - AgeOfInformation (or last_updated_timestamp)](https://github.com/camaraproject/DeviceStatus/discussions/98)
* An issue [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110) has been created, the discussion can be closed.
* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)

## API Roadmap

### Release 0.5.0
* Status: release created on 31.01.2024

### Release 0.6.0
* Planned release date: tbd
* Status: wip
* Content:


## AOB
* Next call will be on 28.02.2024 11:00 CET
* An issue for creation of the necessary feature file for testing should be created too.
88 changes: 88 additions & 0 deletions documentation/MeetingMinutes/MoM-2024-02-28.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Camara DeviceStatus meeting - MOM-2024-02-28

*February 28th, 2024*

## Attendees

* Akos Hunyadi (Deutsche Telekom)
* Fernando Prado Cabrillo (Telefonica)
* Joachim Dahlgren (Ericsson)
* Rafal Artych (Deutsche Telekom)
* Sachin Kumar (Vodafone)

DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)

## Agenda

* Open PRs
* Open Issues
* Open Discussions
* API Roadmap
* AOB


## Open PRs
* [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
* No discussion
* Reviews are missing.

* [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
* Renaming the POST endpoints according to the design guidelines.
* No discussion, can be merged after approvals.

* [#109 fix: add missing "subscriptionId" in "RoamingStatus"-data for CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/109)
* No discussion, can be merged after approvals.

* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
* The enums for event-types include dots which causes problems at the code generation (Java) at DT.
* Additional feedback from dev teams would be helpful to priotize the issue.
* A possible change in the design guideline could be a solution.
* The PR has been marked as draft until an agreed solution is ellaborated.

## Open issues:

* [#117 Send a CloudEvent when DELETE /subscriptions/{subscriptionId}](https://github.com/camaraproject/DeviceStatus/issues/117)
* Same issue exists in Device Location
* Should be addressed in Commonalities

* [#116 subscriptionExpireTime is declared as "required" in the subscription-ends - note, but is optional currently](https://github.com/camaraproject/DeviceStatus/issues/116)

* [#115 /Connectivity API there is no indication for which particular subscriber event (DATA/SMS)](https://github.com/camaraproject/DeviceStatus/issues/115)

* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
* The name should correlate with similar properties at other APIs

* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
* The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)

* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
* The corresponding PR is open: [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)

* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)

* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
* The corresponding PR is open: [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)



## Open discussions
* **[#114 Test Data : Device Status](https://github.com/camaraproject/DeviceStatus/discussions/114)**
* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)

## API Roadmap

### Release 0.5.0
* Status: release created on 31.01.2024

### Release 0.6.0
* Planned release date: tbd
* Status: wip
* Content: A proposal for the content should be created (Ákos)


## AOB
* Next call will be on 13.03.2024 11:00 CET
* An issue for creation of the necessary feature file for testing should be created.
Loading

0 comments on commit 255bf7b

Please sign in to comment.