From 0f8e70e6abccf55f3a3c72002f71f74af955b506 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 23 Jul 2024 14:22:09 +0200 Subject: [PATCH 01/10] Add location-retrieval CHANGELOG and README Add location-retrieval CHANGELOG and README --- location-retrieval CHANGELOG.md | 70 +++++++++++++++++++++++++++++++++ location-retrieval README.md | 42 ++++++++++++++++++++ 2 files changed, 112 insertions(+) create mode 100644 location-retrieval CHANGELOG.md create mode 100644 location-retrieval README.md diff --git a/location-retrieval CHANGELOG.md b/location-retrieval CHANGELOG.md new file mode 100644 index 0000000..a82f9a3 --- /dev/null +++ b/location-retrieval CHANGELOG.md @@ -0,0 +1,70 @@ +# Changelog location-retrieval from DeviceLocation API family + +## Table of Contents + +- [v0.3.0](#v030rc1) +- [v0.2.0](#v020) +- [v0.1.0](#v010) + +**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.** + +# v0.3.0.rc1 + + +## Please note: + +- **This release contains significant breaking changes compared to v0.1.0, and it is not backward compatible** + - Especially a lot of the parameter names changed in line with the agreed glossary within CAMARA Commonalities +- 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 + +## Added + + +* Test Definition in Test_Definitions directory (PR229) +* Add x-correlator as header parameter (commonalities alignement) (PR172) + +## Changed + +* Make the '+' mandatory for the phone number (PR178) +* Remove minimum 60 seconds to maxAge (PR188) + - Absence of maxAge means "any age" + - maxAge=0 means a fresh calculation. +* Cosmetic change following megalinter integration by @bigludo7 +* Update Authorization and authentication part accordingly to ICM (PR217) +* Align the documentation part of the API with the fact that lastLocationTime is mandatory in all response. (PR199) +* - Aligned error code list & description with Commonalities (PR221) + +### Fixed + +* n/a + +### Removed + +* n/a + +# v0.2.0 +There is no location-retrieval v0.2.0 API. + +As v0.2.0 was used only for the release of the Device location API family (with location-retrieval in v0.1) and to avoid confusion we skipped re-use of v0.2 for the API itself. + +# v0.1.0 + +**This is the fist alpha version of the location-retrieval API but it was part of second alpha version of the DeviceLocation API family.** + +- API [definition](https://github.com/camaraproject/DeviceLocation/blob/release-0.2.0-rc3/code/API_definitions/location-retrieval.yaml) **with inline documentation**. + + +## Added + + +* First alpha version of the new API `location-retrieval`, v0.1.0: + + - Initial version already aligned with latest guidelines. + - Returns 2 possible location areas: `CIRCLE` and `POLYGON`. + + + + + diff --git a/location-retrieval README.md b/location-retrieval README.md new file mode 100644 index 0000000..1b2d59c --- /dev/null +++ b/location-retrieval README.md @@ -0,0 +1,42 @@ + + + + + + + +# Location Retrieval API +Repository to describe, develop, document and test the Location retrieval API +**Location retrieval API is part of the Device Location API family** + +## Scope +* Service APIs for “location-retrieval” (see APIBacklog.md) +* It provides the customer with the ability to retrieve the location of a device. +* 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: July 2022 +* Location: virtually + +## Meetings +* Meetings are held virtually for the Device location API family +* Schedule: bi-weekly (odd weeks), Tuesday, 9 AM CET/CEST +* Meeting link: [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91878854906?password=7e620a89-fcb5-4d2d-927a-17e3a0d1d28e) +* Slack channel: [camara-project.slack.com](https://join.slack.com/t/camara-project/shared_invite/zt-26gy3e64n-o7Riy3MoXmzdaDEL3wlngg) #sp-device-location + +## 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**. +* **It is important to note that previous release was done at API family level** +* **The latest available release for the location retrieval API is 0.3.0-rc1** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments. +* The release Tag is [r1.1](https://github.com/camaraproject/DeviceLocation/releases/tag/r1.1) + * API definition **with inline documentation:** + - **location-retrieval v0.3.0**, which is the first alpha release. + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceLocation/blob/r1.1/code/API_definitions/location-retrieval.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/location-retrieval.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/location-retrieval.yaml) + +* **Please note that** the previous release version was at the **device location family level** - it included all three APIs: location-verification, location-retrieval and geofencing. The release 0.2.0 of the API family is available within the [release-v0.2.0 branch](https://github.com/camaraproject/DeviceLocation/tree/release-v0.2.0). + + +## Contributorship and mailing list +* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit . +* A message to all Contributors of this Sub Project can be sent using . From c6a8ff6c7ef5f626a60b8535020f29bd4a71a45c Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 23 Jul 2024 14:25:46 +0200 Subject: [PATCH 02/10] add x-camara-commonalities: 0.4.0 --- code/API_definitions/location-retrieval.yaml | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index 165fdb5..a1ada58 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -64,28 +64,22 @@ info: # Further info and support (FAQs will be added in a later version of the documentation) - termsOfService: http://swagger.io/terms/ contact: email: project-email@sample.com - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html version: 0.2.0-wip + x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/ - servers: - url: '{apiRoot}/location-retrieval/v0' variables: apiRoot: default: http://localhost:9091 - description: API root - + description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath` tags: - name: Location retrieval description: Retrieve the location of a device - paths: /retrieve: post: From 3a24701d1c29e1f9605366b5979f9be61fc526a6 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 23 Jul 2024 15:04:07 +0200 Subject: [PATCH 03/10] Update code/API_definitions/location-retrieval.yaml Co-authored-by: Jose Luis Urien --- code/API_definitions/location-retrieval.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index a1ada58..eb36810 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -66,7 +66,8 @@ info: (FAQs will be added in a later version of the documentation) contact: email: project-email@sample.com - version: 0.2.0-wip + version: 0.3.0-rc.1 + x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at Camara From 6a4a542e884de5d1ba9b5b0d629745a789723600 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 23 Jul 2024 15:04:14 +0200 Subject: [PATCH 04/10] Update code/API_definitions/location-retrieval.yaml Co-authored-by: Jose Luis Urien --- code/API_definitions/location-retrieval.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index eb36810..575bc92 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -73,7 +73,8 @@ externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/ servers: - - url: '{apiRoot}/location-retrieval/v0' + - url: '{apiRoot}/location-retrieval/v0.3rc1' + variables: apiRoot: default: http://localhost:9091 From 83974761d875433a5d9773d8c4f41e1ed422b736 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 23 Jul 2024 15:07:30 +0200 Subject: [PATCH 05/10] update version in API-Readiness-Checklist.md --- .../location-retrieval-API-Readiness-Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index 732c29a..7e304d8 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for location-retrieval api-version in v0.2 +Checklist for location-retrieval api-version in v0.3 As we target an **initial** maturity level release the column **Status** is filled accordingly: NA: Not Applicable, TBD: To Be Done @@ -24,4 +24,4 @@ As we target an **initial** maturity level release the column **Status** is fill Note: It is normal that the checklists of the (final) release-candidate and its subsequent public-release are the same, while additional release assets are required for a subsequent stable public-release. -The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist) \ No newline at end of file +The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist) From 6e7903d7819e73e4c2d286acde5b3a71ffd01662 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 15:20:08 +0200 Subject: [PATCH 06/10] Delete location-retrieval CHANGELOG.md --- location-retrieval CHANGELOG.md | 70 --------------------------------- 1 file changed, 70 deletions(-) delete mode 100644 location-retrieval CHANGELOG.md diff --git a/location-retrieval CHANGELOG.md b/location-retrieval CHANGELOG.md deleted file mode 100644 index a82f9a3..0000000 --- a/location-retrieval CHANGELOG.md +++ /dev/null @@ -1,70 +0,0 @@ -# Changelog location-retrieval from DeviceLocation API family - -## Table of Contents - -- [v0.3.0](#v030rc1) -- [v0.2.0](#v020) -- [v0.1.0](#v010) - -**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.** - -# v0.3.0.rc1 - - -## Please note: - -- **This release contains significant breaking changes compared to v0.1.0, and it is not backward compatible** - - Especially a lot of the parameter names changed in line with the agreed glossary within CAMARA Commonalities -- 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 - -## Added - - -* Test Definition in Test_Definitions directory (PR229) -* Add x-correlator as header parameter (commonalities alignement) (PR172) - -## Changed - -* Make the '+' mandatory for the phone number (PR178) -* Remove minimum 60 seconds to maxAge (PR188) - - Absence of maxAge means "any age" - - maxAge=0 means a fresh calculation. -* Cosmetic change following megalinter integration by @bigludo7 -* Update Authorization and authentication part accordingly to ICM (PR217) -* Align the documentation part of the API with the fact that lastLocationTime is mandatory in all response. (PR199) -* - Aligned error code list & description with Commonalities (PR221) - -### Fixed - -* n/a - -### Removed - -* n/a - -# v0.2.0 -There is no location-retrieval v0.2.0 API. - -As v0.2.0 was used only for the release of the Device location API family (with location-retrieval in v0.1) and to avoid confusion we skipped re-use of v0.2 for the API itself. - -# v0.1.0 - -**This is the fist alpha version of the location-retrieval API but it was part of second alpha version of the DeviceLocation API family.** - -- API [definition](https://github.com/camaraproject/DeviceLocation/blob/release-0.2.0-rc3/code/API_definitions/location-retrieval.yaml) **with inline documentation**. - - -## Added - - -* First alpha version of the new API `location-retrieval`, v0.1.0: - - - Initial version already aligned with latest guidelines. - - Returns 2 possible location areas: `CIRCLE` and `POLYGON`. - - - - - From 0396f15641933e8d0b5572748afb30c767ed15f1 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 15:20:33 +0200 Subject: [PATCH 07/10] Delete location-retrieval README.md --- location-retrieval README.md | 42 ------------------------------------ 1 file changed, 42 deletions(-) delete mode 100644 location-retrieval README.md diff --git a/location-retrieval README.md b/location-retrieval README.md deleted file mode 100644 index 1b2d59c..0000000 --- a/location-retrieval README.md +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - -# Location Retrieval API -Repository to describe, develop, document and test the Location retrieval API -**Location retrieval API is part of the Device Location API family** - -## Scope -* Service APIs for “location-retrieval” (see APIBacklog.md) -* It provides the customer with the ability to retrieve the location of a device. -* 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: July 2022 -* Location: virtually - -## Meetings -* Meetings are held virtually for the Device location API family -* Schedule: bi-weekly (odd weeks), Tuesday, 9 AM CET/CEST -* Meeting link: [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91878854906?password=7e620a89-fcb5-4d2d-927a-17e3a0d1d28e) -* Slack channel: [camara-project.slack.com](https://join.slack.com/t/camara-project/shared_invite/zt-26gy3e64n-o7Riy3MoXmzdaDEL3wlngg) #sp-device-location - -## 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**. -* **It is important to note that previous release was done at API family level** -* **The latest available release for the location retrieval API is 0.3.0-rc1** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments. -* The release Tag is [r1.1](https://github.com/camaraproject/DeviceLocation/releases/tag/r1.1) - * API definition **with inline documentation:** - - **location-retrieval v0.3.0**, which is the first alpha release. - - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceLocation/blob/r1.1/code/API_definitions/location-retrieval.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/location-retrieval.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/location-retrieval.yaml) - -* **Please note that** the previous release version was at the **device location family level** - it included all three APIs: location-verification, location-retrieval and geofencing. The release 0.2.0 of the API family is available within the [release-v0.2.0 branch](https://github.com/camaraproject/DeviceLocation/tree/release-v0.2.0). - - -## Contributorship and mailing list -* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit . -* A message to all Contributors of this Sub Project can be sent using . From 01d3accce3829dbd7ce6cd350015cd91fc913b23 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 26 Jul 2024 09:13:22 +0200 Subject: [PATCH 08/10] Update documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../location-retrieval-API-Readiness-Checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index 7e304d8..83ae87e 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -1,6 +1,7 @@ # API Readiness Checklist -Checklist for location-retrieval api-version in v0.3 +Checklist for location-retrieval 0.3.0-rc.1 in r1.1 + As we target an **initial** maturity level release the column **Status** is filled accordingly: NA: Not Applicable, TBD: To Be Done From 8f7b327f7679a13cef60239db8612918654dd8b8 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Mon, 29 Jul 2024 11:26:19 +0200 Subject: [PATCH 09/10] Update code/API_definitions/location-retrieval.yaml --- code/API_definitions/location-retrieval.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index 26a1792..200340e 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -89,7 +89,7 @@ info: (FAQs will be added in a later version of the documentation) contact: email: project-email@sample.com - version: 0.3.0-rc.1 + version: wip x-camara-commonalities: 0.4.0 externalDocs: From 26215b52b8d6a8c32616b3b9608e580d0facc908 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Mon, 29 Jul 2024 11:26:27 +0200 Subject: [PATCH 10/10] Update code/API_definitions/location-retrieval.yaml --- code/API_definitions/location-retrieval.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index 200340e..a013c8e 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -96,7 +96,7 @@ externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/ servers: - - url: '{apiRoot}/location-retrieval/v0.3rc1' + - url: '{apiRoot}/location-retrieval/vwip' variables: apiRoot: