Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 34 additions & 2 deletions CHANGELOG.md
Comment thread
bigludo7 marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

## Table of Contents

- **[r2.1](#r21)**
- [r1.2](#r12)
- **[r2.2](#r22) Fall25**
- [r2.1](#r21)
- [r1.2](#r12) Fall24
- [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.**
Expand All @@ -15,6 +16,37 @@ The below sections record the changes for each API version in each release as fo
* for subsequent release-candidate(s), only the delta to the previous release-candidate
* for a public release, the consolidated changes since the previous public release

# r2.2

This **public release** contains the definition and documentation of
* most-frequent-location 0.2.0

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

## most-frequent-location v0.2.0

**most-frequent-location v0.2.0 is the public release of the Most Frequent Location API**

- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/MostFrequentLocation/blob/r2.2/code/API_definitions/most-frequent-location.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.2/code/API_definitions/most-frequent-location.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.2/code/API_definitions/most-frequent-location.yaml)

### Changed
- Update `device` error codes by @fernandopradocabrillo in https://github.com/camaraproject/MostFrequentLocation/pull/23
- Error model defined in Spring25 meta-release by @fernandopradocabrillo in https://github.com/camaraproject/MostFrequentLocation/pull/23
- Update test plan with latest changes aligning with commonalities by @fernandopradocabrillo in https://github.com/camaraproject/MostFrequentLocation/pull/23
- Align `info.description` section with Commonalities by @fernandopradocabrillo in https://github.com/camaraproject/MostFrequentLocation/pull/23
- Update `x-correlator` format by @fernandopradocabrillo in https://github.com/camaraproject/MostFrequentLocation/pull/23

### Removed
- AUTHENTICATION_REQUIRED and 5XX errors by @fernandopradocabrillo in https://github.com/camaraproject/MostFrequentLocation/pull/23
- `INVALID_TOKEN_CONTEXT` error by @fernandopradocabrillo in https://github.com/camaraproject/MostFrequentLocation/pull/23

**Full Changelog**: https://github.com/camaraproject/MostFrequentLocation/commits/r1.2...r2.2

# r2.1

This **public release** contains the definition and documentation of
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,16 @@ Sandbox API Repository to describe, develop, document, and test the MostFrequent

* 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 Most Frequent Location with v0.2.0-rc.1 is [r2.1](https://github.com/camaraproject/MostFrequentLocation/tree/r2.1)**. The release Tag is [r2.1](https://github.com/camaraproject/MostFrequentLocation/releases/tag/r2.1).
- Contains the following API definitions **with inline documentation**:
- 0.2.0-rc.1 most-frequent-location: [YAML spec file](https://github.com/camaraproject/MostFrequentLocation/blob/r2.1/code/API_definitions/most-frequent-location.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.1/code/API_definitions/most-frequent-location.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.1/code/API_definitions/most-frequent-location.yaml&nocors)
* **The latest public release of CAMARA Most Frequent Location with v0.1.0 is [r1.2](https://github.com/camaraproject/MostFrequentLocation/tree/r1.2)**. The release Tag is [r1.2](https://github.com/camaraproject/MostFrequentLocation/releases/tag/r1.2).
- Contains the following API definitions **with inline documentation**:
- 0.1.0 most-frequent-location: [YAML spec file](https://github.com/camaraproject/MostFrequentLocation/blob/r1.2/code/API_definitions/most-frequent-location.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r1.2/code/API_definitions/most-frequent-location.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r1.2/code/API_definitions/most-frequent-location.yaml&nocors)
* `NEW`:**The latest public release of CAMARA Most Frequent Location with v0.2.0 is [r2.2](https://github.com/camaraproject/MostFrequentLocation/tree/r2.2)**. The release Tag is [r2.2](https://github.com/camaraproject/MostFrequentLocation/releases/tag/r2.2).
- Contains v0.2.0 most-frequent-location API definition **with inline documentation**:
- [YAML spec file](https://github.com/camaraproject/MostFrequentLocation/blob/r2.2/code/API_definitions/most-frequent-location.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.2/code/API_definitions/most-frequent-location.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.2/code/API_definitions/most-frequent-location.yaml&nocors)

## Contributing

* Meetings
* Schedule: Bi-weekly, Thursday, 09:00 CEST (07:00 UTC)
* Meetings are held virtually
* Schedule: On-demand
* [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/MostFrequentLocation+2024+Minutes)
* Slack channel: [camara-project.slack.com](https://camara-project.slack.com/archives/C07BHCZ3XUY) #sp-location-insights
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/most-frequent-location.yaml
Comment thread
bigludo7 marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,13 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: wip
version: 0.2.0
x-camara-commonalities: 0.6
externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/MostFrequentLocation
servers:
- url: "{apiRoot}/most-frequent-location/vwip"
- url: "{apiRoot}/most-frequent-location/v0.2"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
8 changes: 4 additions & 4 deletions code/Test_definitions/most-frequent-location.feature
Comment thread
bigludo7 marked this conversation as resolved.
Comment thread
bigludo7 marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Most Frequent Location API, vwip
Feature: CAMARA Most Frequent Location API, v0.2.0
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -10,15 +10,15 @@ Feature: CAMARA Most Frequent Location API, vwip
# * A device object applicable for Most Frequent Location service.
# * A device object identifying a device commercialized by the implementation for which the service is not applicable, if any.

# References to OAS spec schemas refer to schemas specifies in most-frequent-location.yaml, version wip
# References to OAS spec schemas refer to schemas specifies in most-frequent-location.yaml

Background: Common verifyFrequentLocation setup
Given an environment at "apiRoot"
And the resource "/most-frequent-location/vwip/verify"
And the resource "/most-frequent-location/v0.2/verify"
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"
# Properties not explicitly overwitten in the Scenarios can take any values compliant with the schema
# Properties not explicitly overwritten in the Scenarios can take any values compliant with the schema
And the request body is set by default to a request body compliant with the schema at "/components/schemas/VerifyFrequentLocationRequest"

# Success scenarios
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# API Readiness Checklist

Checklist for most-frequent-location v0.2.0-rc.1 in release r2.1
Checklist for most-frequent-location v0.2.0 in release r2.2

| Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> stable | Status | Reference information |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
| 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 | [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) |
| 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 | |
| 5 | API documentation | M | M | M | M | Y | Embedded documentation into API spec - [link](/code/API_definitions/most-frequent-location.yaml) |
| 6 | User stories | O | O | O | M | N | |
Expand Down