Skip to content
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.

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

Spring 25 release #47

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
74f2590
Update CHANGELOG.md
chinaunicomyangfan Jan 20, 2025
ae4c50d
Update region-device-count.yaml
chinaunicomyangfan Jan 20, 2025
c2addba
Update README.md
chinaunicomyangfan Jan 20, 2025
263ed0a
Update CHANGELOG.md
chinaunicomyangfan Jan 20, 2025
ef8013a
Rename RDC_User_Story_Emergency Rescue.md to RDC_User_Story_Emergency…
chinaunicomyangfan Jan 21, 2025
a225530
Update and rename RDC_User_Story_Outdoor Live Streaming.md to RDC_Use…
chinaunicomyangfan Jan 21, 2025
55eb678
Update region-device-count-API-Readiness-Checklist.md
chinaunicomyangfan Jan 21, 2025
dcdf595
Update region-device-count.yaml to prepare for Spring25 release
chinaunicomyangfan Jan 21, 2025
134358d
Update CHANGELOG.md
chinaunicomyangfan Jan 21, 2025
627aa51
Merge branch 'camaraproject:main' into versionChange
chinaunicomyangfan Jan 21, 2025
f1b670e
Merge branch 'camaraproject:main' into versionChange
chinaunicomyangfan Feb 7, 2025
bc1df48
Enduce unnecessary error code
chinaunicomyangfan Feb 7, 2025
f0ff3a6
Fix megalint error
chinaunicomyangfan Feb 7, 2025
673da71
Fix Megalint error
chinaunicomyangfan Feb 7, 2025
0474526
Fix Megalint Error
chinaunicomyangfan Feb 7, 2025
98142b7
Update README.md
chinaunicomyangfan Feb 7, 2025
7810e7d
Delete code/API_definitions/README.MD
chinaunicomyangfan Feb 7, 2025
0ed2293
Update CHANGELOG.md
chinaunicomyangfan Feb 7, 2025
a374342
Update region-device-count-API-Readiness-Checklist.md
chinaunicomyangfan Feb 8, 2025
6bc8945
add the schema for the x-correlator and change the 429 examples
chinaunicomyangfan Feb 11, 2025
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
34 changes: 32 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,44 @@
# Changelog Region Device Count

# r0.1
## Table of Contents
- **[r1.1](#r11)**

**Initial contribution of two API definitions for Region Device Count**, including initial documentation and implementation code.
**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 it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**


# r1.1
## Release Notes

This pre-release contains the definition and documentation of
* region-device-count 0.1.0-rc.1

The API definition(s) are based on
* Commonalities v0.5.0
* Identity and Consent Management v0.3.0


## region-device-count v0.1.0-rc.1

**region-device-count v0.1.0-rc.1 is the first release-candidate version for v0.1.0 of the region-device-count API. The following changes have been made for v0.1.0 through https://github.com/camaraproject/RegionDeviceCount/pull/47**

* Error model aligment with commonalities, which implies use of normalization values (i.e. enums) for `status` and `code`
* Removal of 404,405,406,5xx errors
* Change the validation rule of the `Filter` parameter from `oneOf` to `anyOf`
* Fix MegaLinter error

API definition **with inline documentation**:
[[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r1.1/code/API_definitions/region-device-count.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r1.1/code/API_definitions/region-device-count.yaml&nocors)
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r1.1/code/API_definitions/region-device-count.yaml)

**Initial contribution of API definitions for Region Device Count**, including initial documentation and implementation code.

## What's Changed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please think about if you want to document also some of the changes done within this PR #47.
As this is the very first release you can as an alternative also just summarize as "first version of ..."

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes made in PR #47 have been recorded in the CHANGELOG.md file. see 0ed2293

* Initial yaml file including regionUserCount api in https://github.com/camaraproject/RegionDeviceCount/pull/5
* Change the API name from regionUserCount to regionDeviceCount in https://github.com/camaraproject/RegionDeviceCount/pull/27
* Add startime and endtime parameters to support querying the number of devices within a certain time period in https://github.com/camaraproject/RegionDeviceCount/pull/31
* Added filter parameter in the request parameters to filter the roaming status and type of the device in https://github.com/camaraproject/RegionDeviceCount/pull/38
* Add capability for async response behaviour in https://github.com/camaraproject/RegionDeviceCount/pull/42
* Add test file in https://github.com/camaraproject/RegionDeviceCount/pull/46


5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ Repository to describe, develop, document and test the RegionDeviceCount API
<!-- The latest public release is available here: https://github.com/camaraproject/§repo_name§/releases/latest -->
<!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/§repo_name§/blob/main/CHANGELOG.md) -->

* **Pre-release r1.1 with region-device-count v0.1.0-rc.1:**
[[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r1.1/code/API_definitions/region-device-count.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r1.1/code/API_definitions/region-device-count.yaml&nocors)
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r1.1/code/API_definitions/region-device-count.yaml)

## Contributing
* Meetings are held virtually <!-- for new API families request a meeting link from the LF admin team or replace the information with the existing meeting information (of the API family) -->
* Schedule: Bi-Weekly on Fridays 11:00 CET/CEST / 09:00 UTC
Expand Down
1 change: 0 additions & 1 deletion code/API_definitions/README.MD

This file was deleted.

Loading