From 1ee28410c67fee5987cadf4b0455569eee42ed7c Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 29 Aug 2025 14:31:13 +0800 Subject: [PATCH 01/21] Update region-device-count.yaml for m4 --- code/API_definitions/region-device-count.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml index 86b3a7b..a9d84b6 100644 --- a/code/API_definitions/region-device-count.yaml +++ b/code/API_definitions/region-device-count.yaml @@ -58,7 +58,7 @@ info: As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - version: 0.2.0-rc.1 + version: 0.2.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -67,7 +67,7 @@ externalDocs: description: Project documentation at CAMARA url: https://github.com/camaraproject/RegionDeviceCount servers: - - url: '{apiRoot}/region-device-count/v0.2rc1' + - url: '{apiRoot}/region-device-count/v0.2' variables: apiRoot: default: http://localhost:9091 From 895b9efbb0613a3fad7d6930a1e14602a47a0797 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 29 Aug 2025 14:31:58 +0800 Subject: [PATCH 02/21] Update region-device-count.feature --- code/Test_definitions/region-device-count.feature | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/code/Test_definitions/region-device-count.feature b/code/Test_definitions/region-device-count.feature index 6eee943..8a6d255 100644 --- a/code/Test_definitions/region-device-count.feature +++ b/code/Test_definitions/region-device-count.feature @@ -1,5 +1,5 @@ @RegionDeviceCount -Feature: CAMARA Region Device Count API v0.2.0-rc.1 - Operations for device count in specified area +Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in specified area # Input to be provided by the implementation to the tester # @@ -17,10 +17,10 @@ Feature: CAMARA Region Device Count API v0.2.0-rc.1 - Operations for device coun # * An Area outside the supported region # * A combination of request parameters including area, start time, and end time, such that the number of connected devices in the area is below the local regulatory privacy threshold # -# References to OAS spec schemas refer to schemas specifies in region-device-count.yaml, version 0.2.0-rc.1 +# References to OAS spec schemas refer to schemas specifies in region-device-count.yaml, version 0.2.0 Background: Common Region Device Count setup - Given the resource "{api-root}/regionDeviceCount/v0.2rc1/count" set as base-url + Given the resource "{api-root}/regionDeviceCount/v0.2/count" set as base-url And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" @@ -277,3 +277,4 @@ Scenario: Error 400 when the response is too big for a sync and async response And the response property "$.status" is 400 And the response property "$.code" is "REGION_DEVICE_COUNT.UNSUPPPORTED_REQUEST" And the response property "$.message" contains a user friendly text + From 1d3026d25fa5bed7208248cb3f3a2377f28a6a96 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 29 Aug 2025 14:36:38 +0800 Subject: [PATCH 03/21] Update CHANGELOG.md for m4 --- CHANGELOG.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2f0e674..df6b223 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,13 +1,40 @@ # Changelog Region Device Count ## Table of Contents -- **[r2.1](#r21)** -- **[r1.3](#r12)** -- **[r1.2](#r12)** -- **[r1.1](#r11)** +- **[r2.2](#r22)** +- [r2.1](#r21) +- [r1.3](#r12) +- [r1.2](#r12) +- [r1.1](#r11) **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.** +# r2.2 + +## Release Notes + + +This release contains the definition and documentation of +* region-device-count 0.2.0 + +The API definition(s) are based on +* Commonalities [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) +* Identity and Consent Management [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) + +## region-device-count v0.2.0 +**region-device-count v0.2.0 is the first public version for v0.2.0 of the region-device-count API.** + + +### Changed +* Remove the 401 AUTHENTICATION_REQUIRED code in https://github.com/camaraproject/RegionDeviceCount/pull/58 +* Update pattern for x-correlator in https://github.com/camaraproject/RegionDeviceCount/pull/58 + + API definition **with inline documentation**: +[[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.1/code/API_definitions/region-device-count.yaml) +[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.1/code/API_definitions/region-device-count.yaml&nocors) +[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.1/code/API_definitions/region-device-count.yaml) + + # r2.1 ## Release Notes @@ -126,3 +153,4 @@ The API definition(s) are based on * Add test file in https://github.com/camaraproject/RegionDeviceCount/pull/46 + From 015a7155a28cb1748238bfbe5d5376448f9db8a9 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 29 Aug 2025 14:45:19 +0800 Subject: [PATCH 04/21] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 54d085f..c4d48ea 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,11 @@ Sandbox API Repository to describe, develop, document, and test the RegionDevice - -* `NEW`: Pre-release r2.1 with version 0.2.0-rc.1 of the API region-device-count is available [here](https://github.com/camaraproject/RegionDeviceCount/tree/r2.1). - [[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.1/code/API_definitions/region-device-count.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.1/code/API_definitions/region-device-count.yaml&nocors) - [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.1/code/API_definitions/region-device-count.yaml) + * **NEW**: Public release [r2.2](https://github.com/camaraproject/RegionDeviceCount/releases/tag/r2.2) with subscription-status v0.2.0 is now available. + * API definition **with inline documentation**: + [[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.2/code/API_definitions/region-device-count.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) + [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml) * For changes see [CHANGELOG.md](https://github.com/camaraproject/RegionDeviceCount/blob/main/CHANGELOG.md) From e26bb832c9700ad5a60f12a3217665f6161986d4 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 29 Aug 2025 14:46:03 +0800 Subject: [PATCH 05/21] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c4d48ea..9edf146 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Sandbox API Repository to describe, develop, document, and test the RegionDevice - * **NEW**: Public release [r2.2](https://github.com/camaraproject/RegionDeviceCount/releases/tag/r2.2) with subscription-status v0.2.0 is now available. + * **NEW**: Public release [r2.2](https://github.com/camaraproject/RegionDeviceCount/releases/tag/r2.2) with region-device-count v0.2.0 is now available. * API definition **with inline documentation**: [[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.2/code/API_definitions/region-device-count.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) From 3063954a4474c3fca037d3bcf585136f156e6275 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 29 Aug 2025 14:47:19 +0800 Subject: [PATCH 06/21] Update region-device-count-API-Readiness-Checklist.md --- .../region-device-count-API-Readiness-Checklist.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/documentation/API_documentation/region-device-count-API-Readiness-Checklist.md b/documentation/API_documentation/region-device-count-API-Readiness-Checklist.md index ad9fe13..6f78154 100644 --- a/documentation/API_documentation/region-device-count-API-Readiness-Checklist.md +++ b/documentation/API_documentation/region-device-count-API-Readiness-Checklist.md @@ -1,13 +1,13 @@ # API Readiness Checklist -Checklist for region-device-count v0.2.0-rc.1 in r1.3 +Checklist for region-device-count v0.2.0 in r2.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/region-device-count.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) | -| 4 | API versioning convention applied | M | M | M | M | Y | v0.2.0-rc.1 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) | +| 4 | API versioning convention applied | M | M | M | M | Y | v0.2.0 | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/region-device-count.yaml) | | 6 | User stories | O | O | O | M | Y | [UserStory1-Emergency_Rescue](/documentation/API_documentation/RDC_User_Story_Emergency_Rescue.md) [UserStory2-Outdoor_Live_Streaming](/documentation/API_documentation/RDC_User_Story_Outdoor_Live_Streaming.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/region-device-count.feature) | @@ -17,3 +17,4 @@ Checklist for region-device-count v0.2.0-rc.1 in r1.3 | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | N | | | 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81134323/RegionDeviceCount+API+description ) | + From d9f183967240c36a55c868fe15a8d7527330c58c Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 29 Aug 2025 18:51:57 +0800 Subject: [PATCH 07/21] Update region-device-count.feature --- code/Test_definitions/region-device-count.feature | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/region-device-count.feature b/code/Test_definitions/region-device-count.feature index 4c8d620..bca385a 100644 --- a/code/Test_definitions/region-device-count.feature +++ b/code/Test_definitions/region-device-count.feature @@ -110,7 +110,7 @@ Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in And the response header "Content-Type" is "application/json" And the response header "x-correlator" has same value as the request header "x-correlator" And the request with the response body will be received at the address of the request property "$.sink" - And the request will have header "Authorization" set to "Bearer: " + the value of the request property "$.sinkCredential.accessToken" + And the request will have header "Authorization" set to "Bearer " + the value of the request property "$.sinkCredential.accessToken" And the request body received complies with the OAS schema at "/components/schemas/RegionDeviceCountResponse" # Generic errors @@ -271,4 +271,5 @@ Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in And the response header "Content-Type" is "application/json" And the response property "$.status" is 400 And the response property "$.code" is "REGION_DEVICE_COUNT.UNSUPPPORTED_REQUEST" - And the response property "$.message" contains a user friendly text \ No newline at end of file + + And the response property "$.message" contains a user friendly text From 430302db428ab1b25503f6d598775abd4b3cf031 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Wed, 3 Sep 2025 14:41:33 +0800 Subject: [PATCH 08/21] Update region-device-count.yaml Updates descriptions in ErrorModel --- code/API_definitions/region-device-count.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml index a9d84b6..26f44ce 100644 --- a/code/API_definitions/region-device-count.yaml +++ b/code/API_definitions/region-device-count.yaml @@ -486,10 +486,10 @@ components: description: HTTP response status code code: type: string - description: Code given to this error + description: A human-readable code to describe the error message: type: string - description: Detailed error description + description: A human-readable description of what the event represents responses: Generic400: description: Bad Request From 3f66dfd5996b0cc3b3d5bc13b5ae0fd76425841d Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Mon, 8 Sep 2025 18:08:15 +0800 Subject: [PATCH 09/21] Update CHANGELOG.md --- CHANGELOG.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index df6b223..2ea5c79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,7 @@ ## Release Notes -This release contains the definition and documentation of +This public release contains the definition and documentation of * region-device-count 0.2.0 The API definition(s) are based on @@ -30,9 +30,9 @@ The API definition(s) are based on * Update pattern for x-correlator in https://github.com/camaraproject/RegionDeviceCount/pull/58 API definition **with inline documentation**: -[[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.1/code/API_definitions/region-device-count.yaml) -[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.1/code/API_definitions/region-device-count.yaml&nocors) -[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.1/code/API_definitions/region-device-count.yaml) +[[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.2/code/API_definitions/region-device-count.yaml) +[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) +[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml) # r2.1 @@ -154,3 +154,4 @@ The API definition(s) are based on + From 91159b2611ac02ee1658c3a9e4c1e9b7595bf269 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Mon, 8 Sep 2025 18:11:44 +0800 Subject: [PATCH 10/21] Update region-device-count.yaml --- code/API_definitions/region-device-count.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml index 26f44ce..f19179b 100644 --- a/code/API_definitions/region-device-count.yaml +++ b/code/API_definitions/region-device-count.yaml @@ -9,9 +9,9 @@ info: This API allows for the API Consumer to query device count in the specified area during a certain time interval.The query area can be a circle or a polygon composed of longitude and latitude points. This functionality can be used for multiple use cases, some of the possible use cases for this API are: - - [Emergency Rescue](https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/main/documentation/API_documentation/RDC_User_Story_Emergency_Rescue.md) + - [Emergency Rescue](https://raw.bgithub.xyz/camaraproject/RegionDeviceCount/main/documentation/API_documentation/RDC_User_Story_Emergency_Rescue.md) - - [Outdoor Live Streaming](https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/main/documentation/API_documentation/RDC_User_Story_Outdoor_Live_Streaming.md) + - [Outdoor Live Streaming](https://raw.bgithub.xyz/camaraproject/RegionDeviceCount/main/documentation/API_documentation/RDC_User_Story_Outdoor_Live_Streaming.md) # Relevant terms and definitions @@ -208,13 +208,13 @@ components: starttime: type: string format: date-time - description: Starting timestamp for counting the number of devices in the area. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z) + description: Starting timestamp for counting the number of devices in the area. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. nullable: true example: "2023-07-03T14:27:08.312+02:00" endtime: type: string format: date-time - description: Ending timestamp for counting the number of devices in the area. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-04T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z) + description: Ending timestamp for counting the number of devices in the area. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. nullable: true example: "2023-07-04T14:27:08.312+02:00" filter: From 3642880606fa0029d60673c26519dc97c76012d0 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Mon, 8 Sep 2025 18:13:03 +0800 Subject: [PATCH 11/21] Update region-device-count.feature --- code/Test_definitions/region-device-count.feature | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/region-device-count.feature b/code/Test_definitions/region-device-count.feature index bca385a..3a9598f 100644 --- a/code/Test_definitions/region-device-count.feature +++ b/code/Test_definitions/region-device-count.feature @@ -19,7 +19,8 @@ Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in # References to OAS spec schemas refer to schemas specifies in region-device-count.yaml, version 0.2.0 Background: Common Region Device Count setup - Given the resource "{api-root}/regionDeviceCount/v0.2/count" set as base-url + Given an environment at "apiRoot" + And the resource "/regionDeviceCount/v0.2/count" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" @@ -273,3 +274,4 @@ Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in And the response property "$.code" is "REGION_DEVICE_COUNT.UNSUPPPORTED_REQUEST" And the response property "$.message" contains a user friendly text + From 70b1370995a529c66341a1d884318cbcacd8b7fd Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Mon, 8 Sep 2025 18:19:16 +0800 Subject: [PATCH 12/21] Update region-device-count.feature --- code/Test_definitions/region-device-count.feature | 2 -- 1 file changed, 2 deletions(-) diff --git a/code/Test_definitions/region-device-count.feature b/code/Test_definitions/region-device-count.feature index 3a9598f..b6c8d28 100644 --- a/code/Test_definitions/region-device-count.feature +++ b/code/Test_definitions/region-device-count.feature @@ -272,6 +272,4 @@ Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in And the response header "Content-Type" is "application/json" And the response property "$.status" is 400 And the response property "$.code" is "REGION_DEVICE_COUNT.UNSUPPPORTED_REQUEST" - And the response property "$.message" contains a user friendly text - From 2cd636f2158b3964ccb8d8602c1445886dd65a70 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Tue, 9 Sep 2025 09:59:55 +0800 Subject: [PATCH 13/21] Add notificationsBearerAuth definition --- code/API_definitions/region-device-count.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml index f19179b..495cf0e 100644 --- a/code/API_definitions/region-device-count.yaml +++ b/code/API_definitions/region-device-count.yaml @@ -182,6 +182,11 @@ components: openId: type: openIdConnect openIdConnectUrl: https://example.com/.well-known/openid-configuration + notificationsBearerAuth: + description: Bearer authentication for notifications + type: http + scheme: bearer + bearerFormat: "{$request.body#sinkCredential.credentialType}" parameters: x-correlator: name: x-correlator From 44cf36c029d3838bcd1ce7f1508980915e8836f4 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Tue, 9 Sep 2025 17:29:26 +0800 Subject: [PATCH 14/21] Add info.description --- code/API_definitions/region-device-count.yaml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml index 495cf0e..6ae61d6 100644 --- a/code/API_definitions/region-device-count.yaml +++ b/code/API_definitions/region-device-count.yaml @@ -48,8 +48,14 @@ info: # Authorization and Authentication - Region Device Count API does not involve the input and output of user personal data.Therefore, the access to Region Device Count APII is defined as `Client Credentials - 2-legged`. Please refer to [Identify and Consent Management](https://github.com/camaraproject/IdentityAndConsentManagement/) for the latest detailed specification of this authentication/authorization flow. + The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile. + + The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation. + In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. + + Region Device Count API does not involve the input and output of user personal data.Therefore, the access to Region Device Count APII is defined as `Client Credentials - 2-legged`. Please refer to [Identify and Consent Management](https://github.com/camaraproject/IdentityAndConsentManagement/) for the latest detailed specification of this authentication/authorization flow. + # Additional CAMARA error responses The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. From be99d7f72033a251470398232d2b29d0e38f9a55 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Tue, 9 Sep 2025 18:13:22 +0800 Subject: [PATCH 15/21] Update region-device-count.feature --- code/Test_definitions/region-device-count.feature | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/region-device-count.feature b/code/Test_definitions/region-device-count.feature index b6c8d28..b0af032 100644 --- a/code/Test_definitions/region-device-count.feature +++ b/code/Test_definitions/region-device-count.feature @@ -20,7 +20,7 @@ Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in Background: Common Region Device Count setup Given an environment at "apiRoot" - And the resource "/regionDeviceCount/v0.2/count" + And the resource "/region-device-count/v0.2/count" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" @@ -273,3 +273,4 @@ Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in And the response property "$.status" is 400 And the response property "$.code" is "REGION_DEVICE_COUNT.UNSUPPPORTED_REQUEST" And the response property "$.message" contains a user friendly text + From 30711eaed33328e13dcf05a1ff9092aa12107280 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Tue, 9 Sep 2025 18:21:55 +0800 Subject: [PATCH 16/21] Update region-device-count.yaml --- code/API_definitions/region-device-count.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml index 6ae61d6..543f7f1 100644 --- a/code/API_definitions/region-device-count.yaml +++ b/code/API_definitions/region-device-count.yaml @@ -55,7 +55,7 @@ info: In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. Region Device Count API does not involve the input and output of user personal data.Therefore, the access to Region Device Count APII is defined as `Client Credentials - 2-legged`. Please refer to [Identify and Consent Management](https://github.com/camaraproject/IdentityAndConsentManagement/) for the latest detailed specification of this authentication/authorization flow. - + # Additional CAMARA error responses The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. From d2f703c634e0b2f3c0b59209637c3a73be6840d5 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Tue, 9 Sep 2025 18:26:20 +0800 Subject: [PATCH 17/21] Update region-device-count.feature --- code/Test_definitions/region-device-count.feature | 1 - 1 file changed, 1 deletion(-) diff --git a/code/Test_definitions/region-device-count.feature b/code/Test_definitions/region-device-count.feature index b0af032..1229625 100644 --- a/code/Test_definitions/region-device-count.feature +++ b/code/Test_definitions/region-device-count.feature @@ -273,4 +273,3 @@ Feature: CAMARA Region Device Count API v0.2.0 - Operations for device count in And the response property "$.status" is 400 And the response property "$.code" is "REGION_DEVICE_COUNT.UNSUPPPORTED_REQUEST" And the response property "$.message" contains a user friendly text - From 8f1fe6877011037bf67998a08bef3119c668582d Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Wed, 10 Sep 2025 11:17:45 +0800 Subject: [PATCH 18/21] Update scope of region-device-count.yaml --- code/API_definitions/region-device-count.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml index 543f7f1..76e6bd5 100644 --- a/code/API_definitions/region-device-count.yaml +++ b/code/API_definitions/region-device-count.yaml @@ -182,7 +182,7 @@ paths: $ref: '#/components/responses/Generic429' security: - openId: - - region-device-count + - region-device-count:count components: securitySchemes: openId: From 1f3b6030027e206f8c6a2599dbac6029f887b122 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 12 Sep 2025 09:44:12 +0800 Subject: [PATCH 19/21] Update README.md to align with API description in wiki --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9edf146..df4f38a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - - - - - - - - + + + + + + + + # RegionDeviceCount @@ -16,7 +16,7 @@ Sandbox API Repository to describe, develop, document, and test the RegionDevice ## Scope * Service APIs for “RegionDeviceCount” (see APIBacklog.md) * It provides the API consumer with the ability to: - * query device count in the specified area during a certain time interval.The query area can be a circle or a polygon composed of longitude and latitude points. + * query device count in the specified area during a certain time interval.The query area can be a circle or a polygon composed of longitude and latitude points.In addition, this API also provides a filtering function. Customers can filter devices by passing in different constraints. Currently, it supports two filtering conditions: roaming status and device type, and it is designed to be extended in the future * NOTE: The scope of this API should be limited (at least at a first stage) to 4G and 5G. * Describe, develop, document and test the APIs (with 1-2 Telcos) * Started: December 2023 @@ -28,8 +28,8 @@ Sandbox API Repository to describe, develop, document, and test the RegionDevice * **NEW**: Public release [r2.2](https://github.com/camaraproject/RegionDeviceCount/releases/tag/r2.2) with region-device-count v0.2.0 is now available. * API definition **with inline documentation**: [[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.2/code/API_definitions/region-device-count.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) - [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.bgithub.xyz/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) + [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.bgithub.xyz/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml) * For changes see [CHANGELOG.md](https://github.com/camaraproject/RegionDeviceCount/blob/main/CHANGELOG.md) From e6c706bf261debc13b5959138ec1493bddff4ca4 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 12 Sep 2025 09:59:45 +0800 Subject: [PATCH 20/21] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index df4f38a..b4b63ba 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - - - - - - - - + + + + + + + + # RegionDeviceCount @@ -28,8 +28,8 @@ Sandbox API Repository to describe, develop, document, and test the RegionDevice * **NEW**: Public release [r2.2](https://github.com/camaraproject/RegionDeviceCount/releases/tag/r2.2) with region-device-count v0.2.0 is now available. * API definition **with inline documentation**: [[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.2/code/API_definitions/region-device-count.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.bgithub.xyz/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) - [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.bgithub.xyz/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) + [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml) * For changes see [CHANGELOG.md](https://github.com/camaraproject/RegionDeviceCount/blob/main/CHANGELOG.md) From 6a19e258a0292d8d1395ea04bfa6c609c40ed355 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 12 Sep 2025 18:38:14 +0800 Subject: [PATCH 21/21] Update region-device-count.yaml --- code/API_definitions/region-device-count.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml index 76e6bd5..2baf32f 100644 --- a/code/API_definitions/region-device-count.yaml +++ b/code/API_definitions/region-device-count.yaml @@ -9,9 +9,9 @@ info: This API allows for the API Consumer to query device count in the specified area during a certain time interval.The query area can be a circle or a polygon composed of longitude and latitude points. This functionality can be used for multiple use cases, some of the possible use cases for this API are: - - [Emergency Rescue](https://raw.bgithub.xyz/camaraproject/RegionDeviceCount/main/documentation/API_documentation/RDC_User_Story_Emergency_Rescue.md) + - [Emergency Rescue](https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/main/documentation/API_documentation/RDC_User_Story_Emergency_Rescue.md) - - [Outdoor Live Streaming](https://raw.bgithub.xyz/camaraproject/RegionDeviceCount/main/documentation/API_documentation/RDC_User_Story_Outdoor_Live_Streaming.md) + - [Outdoor Live Streaming](https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/main/documentation/API_documentation/RDC_User_Story_Outdoor_Live_Streaming.md) # Relevant terms and definitions