Prepare API location-retrieval version 0.3.0-rc.1

code/API_definitions/location-retrieval.yaml

@@ -64,28 +64,24 @@ info:
     # Further info and support
 
     (FAQs will be added in a later version of the documentation)
-  termsOfService: http://swagger.io/terms/
   contact:
     email: [email protected]
-  license:
-    name: Apache 2.0
-    url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: 0.2.0-wip
+  version: 0.3.0-rc.1
+
+  x-camara-commonalities: 0.4.0
 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
-        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:

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)
+The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist)

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`.
+
+
+
+
+

location-retrieval README.md

@@ -0,0 +1,42 @@
+<a href="https://github.com/camaraproject/DeviceLocation/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/DeviceLocation?style=plastic"></a>
+<a href="https://github.com/camaraproject/DeviceLocation/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/DeviceLocation?style=plastic"></a>
+<a href="https://github.com/camaraproject/DeviceLocation/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/DeviceLocation?style=plastic"></a>
+<a href="https://github.com/camaraproject/DeviceLocation/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/DeviceLocation?style=plastic"></a>
+<a href="https://github.com/camaraproject/DeviceLocation" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/DeviceLocation?style=plastic"></a>
+<a href="https://github.com/camaraproject/DeviceLocation/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a>
+
+# 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 <https://lists.camaraproject.org/g/sp-dlo>.
+* A message to all Contributors of this Sub Project can be sent using <[email protected]>.