From 9b1a56d1c06e2941356a6360eeea9e6b68cf2cf8 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Mon, 25 Nov 2024 16:35:20 +0100 Subject: [PATCH 1/6] update pre-release version in yaml --- code/API_definitions/most-frequent-location.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/most-frequent-location.yaml b/code/API_definitions/most-frequent-location.yaml index 50e7c93..40220cb 100644 --- a/code/API_definitions/most-frequent-location.yaml +++ b/code/API_definitions/most-frequent-location.yaml @@ -72,12 +72,12 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.1.0-rc.1 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: "{apiRoot}/most-frequent-location/vwip" + - url: "{apiRoot}/most-frequent-location/v0.1rc1" variables: apiRoot: default: http://localhost:9091 From d882bfe5616cd6ce0fc16037ebe5323baf696d38 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Mon, 25 Nov 2024 17:37:41 +0100 Subject: [PATCH 2/6] update readme and changelog --- CHANGELOG.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 85 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..44d0103 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,45 @@ +# Changelog LocationInsights + +## Table of Contents + +- [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.** + +# r1.1 +## Release Notes + +This release contains the definition and documentation of +* most-frequent-location v0.1.0-rc.1 + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.1 + +## most-frequent-location v0.1.0-rc.1 + +**most-frequent-location v0.1.0-rc.1 is the 1st release candidate of the version 0.1.0** + +- 0.1.0-rc.1 Most Frequent Location API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/LocationInsights/blob/r1.1/code/API_definitions/most-frequent-location.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/LocationInsights/blob/r1.1/code/API_definitions/most-frequent-location.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/LocationInsights/blob/r1.1/code/API_definitions/most-frequent-location.yaml) + +**Main changes** +* Initial version of the API + +## Added +* Include initial proposal for Most Frequent Location API - Telefónica by @fernandopradocabrillo in https://github.com/camaraproject/LocationInsights/pull/6 +* align-device-with-commonalities by @fernandopradocabrillo in https://github.com/camaraproject/LocationInsights/pull/9 +* Corrections in yaml examples for request body and response errors by @fernandopradocabrillo in https://github.com/camaraproject/LocationInsights/pull/11 +* Assumptions to use the API with postalCode but without countryName by @javier-carrocalabor in https://github.com/camaraproject/LocationInsights/pull/15 +* Include linter workflow files by @fernandopradocabrillo in https://github.com/camaraproject/LocationInsights/pull/16 +* Include test plan by @fernandopradocabrillo in https://github.com/camaraproject/LocationInsights/pull/13 + +## New Contributors +* @hdamker made their first contribution in https://github.com/camaraproject/LocationInsights/pull/1 +* @wrathwolf made their first contribution in https://github.com/camaraproject/LocationInsights/pull/2 +* @fernandopradocabrillo made their first contribution in https://github.com/camaraproject/LocationInsights/pull/4 +* @javier-carrocalabor made their first contribution in https://github.com/camaraproject/LocationInsights/pull/15 + +**Full Changelog**: https://github.com/camaraproject/LocationInsights/commits/r1.1 diff --git a/README.md b/README.md new file mode 100644 index 0000000..c9e22a9 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ + + + + + + + + +# LocationInsights + +Repository to describe, develop, document and test the LocationInsights API family + +## Scope + +* Service APIs for “LocationInsights” (see APIBacklog.md) +* It provides the customer with the ability to: + * "MostFrequentLocation": validate, in terms of scoring, of the user's expected home area + * "DeviceVisitLocation" query the latest visit locations of a device within a given time window + * NOTE: The scope of this API family should be limited (at least at the first stage) to 4G and 5G. +* Describe, develop, document and test the APIs (with 1-2 Telcos) +* Started: May 2024 + +## Release Information + +* Note: Please be aware that the project will have 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 + +* `NEW`:**The latest pre-release of CAMARA Location Insights is [r1.1](https://github.com/camaraproject/LocationInsights/tree/r1.1)**. The pre-release Tag is [r1.1](https://github.com/camaraproject/LocationInsights/releases/tag/r1.1). + - Contains the following API definitions **with inline documentation**: + - 0.1.0-rc.1 most-frequent-location: [YAML spec file](https://github.com/camaraproject/LocationInsights/blob/r1.1/code/API_definitions/most-frequent-location.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/LocationInsights/r1.1/code/API_definitions/most-frequent-location.yaml&nocors) | [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/LocationInsights/r1.1/code/API_definitions/most-frequent-location.yaml&nocors) + +## Contributing + +* Meetings + * Schedule: Bi-weekly, Thursday, 09:00 CEST (07:00 UTC) + * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/99479758031?password=c705dd6f-a1c5-44e4-af97-331a18395fb8) + * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564467/LocationInsights+2024+Minutes) + * Slack channel: [camara-project.slack.com](https://camara-project.slack.com/archives/C07BHCZ3XUY) #sp-location-insights +* Mailing List + * Subscribe / Unsubscribe to the mailing list of this Sub Project . + * A message to the community of this Sub Project can be sent using . From 883bba1b3ea050d714dfc3e352d8e64685ac902c Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Mon, 25 Nov 2024 17:42:22 +0100 Subject: [PATCH 3/6] include api readiness checklist --- ...requent-location-API-Readiness-Checklist.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 documentation/SupportingDocuments/most-frequent-location-API-Readiness-Checklist.md diff --git a/documentation/SupportingDocuments/most-frequent-location-API-Readiness-Checklist.md b/documentation/SupportingDocuments/most-frequent-location-API-Readiness-Checklist.md new file mode 100644 index 0000000..009d078 --- /dev/null +++ b/documentation/SupportingDocuments/most-frequent-location-API-Readiness-Checklist.md @@ -0,0 +1,18 @@ +# API Readiness Checklist + +Checklist for most-frequent-location 0.1.0-rc.1 in r1.1 + +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | +|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/most-frequent-location.yaml) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r0.4.0](https://github.com/camaraproject/Commonalities/tree/r0.4.0) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r0.2.1](https://github.com/camaraproject/IdentityAndConsentManagement/tree/r0.2.1) | +| 4 | API versioning convention applied | M | M | M | M | Y | | +| 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/most-frequent-location.yaml) | +| 6 | User stories | O | O | O | M | N | | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/most-frequent-location-check.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_definitions/most-frequent-location-check.feature) | +| 9 | Test result statement | O | O | O | M | N | | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | +| 12 | Previous public release was certified | O | O | O | M | N | | From 678c13366b45c554c66c70bc2903da59c54bc087 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Tue, 26 Nov 2024 13:29:20 +0100 Subject: [PATCH 4/6] fix linter --- code/API_definitions/most-frequent-location.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/most-frequent-location.yaml b/code/API_definitions/most-frequent-location.yaml index 40220cb..dd34dd9 100644 --- a/code/API_definitions/most-frequent-location.yaml +++ b/code/API_definitions/most-frequent-location.yaml @@ -90,7 +90,7 @@ paths: post: security: - openId: - - most-frequent-location:verify + - most-frequent-location:verify tags: - Frequent location verification summary: Verify the most frequent location of a device From f15608d07a970801276793a19e734cf31358508f Mon Sep 17 00:00:00 2001 From: Fernando Prado Cabrillo Date: Tue, 10 Dec 2024 16:35:54 +0100 Subject: [PATCH 5/6] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 44d0103..5a38d43 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,8 +37,6 @@ The API definition(s) are based on * Include test plan by @fernandopradocabrillo in https://github.com/camaraproject/LocationInsights/pull/13 ## New Contributors -* @hdamker made their first contribution in https://github.com/camaraproject/LocationInsights/pull/1 -* @wrathwolf made their first contribution in https://github.com/camaraproject/LocationInsights/pull/2 * @fernandopradocabrillo made their first contribution in https://github.com/camaraproject/LocationInsights/pull/4 * @javier-carrocalabor made their first contribution in https://github.com/camaraproject/LocationInsights/pull/15 From a6a76c440ea225a3702c51190b616aec333a49e8 Mon Sep 17 00:00:00 2001 From: Fernando Prado Cabrillo Date: Tue, 10 Dec 2024 16:41:18 +0100 Subject: [PATCH 6/6] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5a38d43..bb60a15 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,8 +22,8 @@ The API definition(s) are based on - 0.1.0-rc.1 Most Frequent Location API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/LocationInsights/blob/r1.1/code/API_definitions/most-frequent-location.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/LocationInsights/blob/r1.1/code/API_definitions/most-frequent-location.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/LocationInsights/blob/r1.1/code/API_definitions/most-frequent-location.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/LocationInsights/r1.1/code/API_definitions/most-frequent-location.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/LocationInsights/r1.1/code/API_definitions/most-frequent-location.yaml) **Main changes** * Initial version of the API