Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre-Release r2.1 #290

Merged
merged 28 commits into from
Feb 5, 2025
Merged

Pre-Release r2.1 #290

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
97c685e
release: update specifications with their new version
maxl2287 Jan 23, 2025
92f561e
feat: delete not needed README.MD
maxl2287 Jan 23, 2025
ec0c734
release: update feature-files for new version
maxl2287 Jan 23, 2025
5d40c61
release: update geofencing-subscriptions-API-Readiness-Checklist.md
maxl2287 Jan 23, 2025
ef57061
release: update location-retrieval-API-Readiness-Checklist.md
maxl2287 Jan 23, 2025
724f5cf
release: update location-verification-API-Readiness-Checklist.md and …
maxl2287 Jan 23, 2025
4290cf5
fix: correct changes on location-retrieval-API-Readiness-Checklist.md…
maxl2287 Jan 23, 2025
8f0bcd0
release: update CHANGELOG.md for r2.1
maxl2287 Jan 23, 2025
c969f56
release: update CHANGELOG.md for r2.1
maxl2287 Jan 23, 2025
769efe9
Merge remote-tracking branch 'upstream/main' into prepare-release-r2.1
maxl2287 Jan 23, 2025
7d49e71
release: add pull-request references to CHANGELOG.md
maxl2287 Jan 23, 2025
50cf5b3
Merge remote-tracking branch 'upstream/main' into prepare-release-r2.1
maxl2287 Jan 23, 2025
5b1f5c8
release: update CHANGELOG.md based on latest MultiSim info.discription
maxl2287 Jan 23, 2025
4472dc8
fix: update version in location-verification-API-Readiness-Checklist.md
maxl2287 Jan 23, 2025
94ebe8a
Update CHANGELOG.md
maxl2287 Jan 23, 2025
07ec2b2
fix: correct checklist row (8) for geofencing-subscriptions-API-Readi…
maxl2287 Jan 24, 2025
6cec18f
release: updated root README.md with new versions
maxl2287 Jan 24, 2025
3b9b8af
Merge branch 'main' into prepare-release-r2.1
maxl2287 Jan 24, 2025
a0b7970
Add pattern for x-correlator & fix 429 documentation
bigludo7 Jan 28, 2025
9d44258
Add pattern for x-correlator & fix 429 documentation
bigludo7 Jan 28, 2025
a32303f
Add pattern for x-correlator & fix 429 documentation
bigludo7 Jan 28, 2025
9d6f70b
Add pattern for x-correlator & 429 documentation in changelog
bigludo7 Jan 28, 2025
f8c861f
release: update commonalities version in OAS to 0.5
maxl2287 Feb 3, 2025
d1b46a5
release: update release references to commonalities and ICM in Checkl…
maxl2287 Feb 3, 2025
8e13f41
Update README.md
maxl2287 Feb 4, 2025
e46b463
fix: updated "# Authorization and authentication"-section based on IC…
maxl2287 Feb 4, 2025
bcf6583
fix: suggested changes in CHANGELOG.md and added "Breaking changes"-note
maxl2287 Feb 4, 2025
dab6568
fix: update API Readiness Checklist documentation reference
maxl2287 Feb 4, 2025
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
76 changes: 75 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## Table of Contents

- **[r1.2](#r12)**
- **[r2.1](#r21)**
- [r1.2](#r12)
- [r1.1](#r11)
- [v0.2.0](#v020)
- [v0.1.0](#v010)
Expand All @@ -15,6 +16,79 @@ The below sections record the changes for each API version in each release as fo
* for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
* for a public API version, the consolidated changes since the release of the previous public API version
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved

# r2.1

## Release Notes

This **public release** contains the definition and documentation of
* location-verification v2.0.0-rc.1
* location-retrieval v0.4.0-rc.1
* geofencing-subscriptions v0.4.0-rc.1

The API definition(s) are based on
* Commonalities v0.5.0
* Identity and Consent Management v0.2.1
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved

**Changelog since v0.2.0**
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved

* Full Changelog with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/r1.2...r2.1

## location-verification v2.0.0-rc.1
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved

### Added

* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291

### Changed

* Decrease radius minimum to "1" for circle-area by @maxl2287 in #285
* Error schemas updated with enums by @jlurien in #281
* Some error status and codes have been updated by @jlurien in #281
* Section with guidelines about how to identify the device from access token and request body has been updated by @jlurien in #281
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved

### Fixed
* Update errormessage for unsupported device identifiers by @maxl2287 in #261
* Add quote-marks for `lastLocationTime` - examples by @maxl2287 in #287

## location-retrieval v0.4.0-rc.1
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved

### Added

* Add management of `maxSurface` in request by @bigludo7 in #262
* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291

### Changed

* Error schemas updated with enums by @bigludo7 in #283
* Some error status and codes have been updated by @bigludo7 in #283
* Section with guidelines about how to identify the device from access token and request body has been updated by @bigludo7 in #283
* Test definitions aligned with API specification update by @bigludo7 in #283

### Fixed

* Update errormessage for unsupported device identifiers by @maxl2287 in #261
* Add quote-marks for `lastLocationTime` - examples by @maxl2287 in #287

## geofencing-subscriptions v0.4.0-rc.1

### Added

* Add test-definitions for HTTP-422 error-cases for geofencing-API by @maxl2287 in #289
* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291


### Changed

* Decrease radius minimum to "1" for circle-area by @maxl2287 in #285
* Error schemas updated with enums by @maxl2287 in #284
* Some error status and codes have been updated by @maxl2287 in #284
* Add a note that initial events will be counted when `subscriptionMaxEvents` is combined with initialEvent=true by @maxl2287 in #284

### Fixed
* remove `allOf` in `sinkCredential` by @maxl2287 in #265
* Correct the example for subscriptions regarding `initialEvent` and error `MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED` by @dfischer-tech in #267
* Add quote-marks for `subscriptionExpireTime` - examples by @maxl2287 in #287

# r1.2

## Release Notes
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/geofencing-subscriptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ info:

(FAQs will be added in a later version of the documentation)

version: wip
version: 0.4.0-rc.1
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand All @@ -100,7 +100,7 @@ externalDocs:
url: https://github.com/camaraproject/DeviceLocation

servers:
- url: "{apiRoot}/geofencing-subscriptions/vwip"
- url: "{apiRoot}/geofencing-subscriptions/v0.4rc1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/location-retrieval.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ info:
# Further info and support

(FAQs will be added in a later version of the documentation)
version: wip
version: 0.4.0-rc.1
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand All @@ -110,7 +110,7 @@ externalDocs:
description: Project documentation at Camara
url: https://github.com/camaraproject/DeviceLocation
servers:
- url: '{apiRoot}/location-retrieval/vwip'
- url: '{apiRoot}/location-retrieval/v0.4rc1'
variables:
apiRoot:
default: http://localhost:9091
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/location-verification.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ info:
# Further info and support

(FAQs will be added in a later version of the documentation)
version: wip
version: 2.0.0-rc.1
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand All @@ -96,7 +96,7 @@ externalDocs:
description: Project documentation at CAMARA
url: https://github.com/camaraproject/DeviceLocation
servers:
- url: "{apiRoot}/location-verification/vwip"
- url: "{apiRoot}/location-verification/v2rc1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
6 changes: 3 additions & 3 deletions code/Test_definitions/geofencing-subscriptions.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
@Geofencing
Feature: Camara Geofencing Subscriptions API, vwip - Operations on subscriptions
Feature: Camara Geofencing Subscriptions API, v0.4.0-rc.1 - Operations on subscriptions

# Input to be provided by the implementation to the tests
# References to OAS spec schemas refer to schemas specified in geofencing-subscriptions.yaml, version vwip
# References to OAS spec schemas refer to schemas specified in geofencing-subscriptions.yaml, version v0.4.0-rc.1

Background: Common Geofencing Subscriptions setup
Given the resource "{apiroot}/geofencing-subscriptions/vwip/" as geofencing base-url
Given the resource "{apiroot}/geofencing-subscriptions/v0.4rc1/" as geofencing base-url
And the header "Authorization" is set to a valid access token
And the header "x-correlator" is set to a UUID value

Expand Down
4 changes: 2 additions & 2 deletions code/Test_definitions/location-retrieval.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Device location retrieval API, vwip - Operation retrieveLocation
Feature: CAMARA Device location retrieval API, v0.4.0-rc.1 - Operation retrieveLocation
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -12,7 +12,7 @@ Feature: CAMARA Device location retrieval API, vwip - Operation retrieveLocation
# References to OAS spec schemas refer to schemas specifies in location-retrieval.yaml

Background: Common retrieveLocation setup
Given the resource "/location-retrieval/vwip/retrieve" |
Given the resource "/location-retrieval/v0.4rc1/retrieve" |
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" is set to a UUID value
Expand Down
4 changes: 2 additions & 2 deletions code/Test_definitions/location-verification.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Device location verification API, vwip - Operation verifyLocation
Feature: CAMARA Device location verification API, v2.0.0-rc.1 - Operation verifyLocation
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -12,7 +12,7 @@ Feature: CAMARA Device location verification API, vwip - Operation verifyLocatio
# References to OAS spec schemas refer to schemas specifies in location-verification.yaml

Background: Common verifyLocation setup
Given the resource "/location-verification/vwip/verify" |
Given the resource "/location-verification/v2rc1/verify"

And the header "Content-Type" is set to "application/json"
And the header "Authorization" is set to a valid access token
Expand Down
1 change: 0 additions & 1 deletion documentation/API_documentation/README.MD
View file
Open in desktop

This file was deleted.

32 changes: 17 additions & 15 deletions ...mentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md
View file
Open in desktop
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# API Readiness Checklist

Checklist for geofencing-subscriptions 0.3.0 in r1.2
Checklist for geofencing-subscriptions 0.4.0-rc.1 in r2.1

| Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> stable | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------------------------:|:-------------------------:|:------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/geofencing-subscriptions.yaml](/code/API_definitions/geofencing-subscriptions.yaml) |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | |
| 3 | Guidelines from ICM applied | O | M | M | M | Y | |
| 4 | API versioning convention applied | M | M | M | M | Y | |
| 5 | API documentation | M | M | M | M | Y | inline in yaml |
| 6 | User stories | O | O | O | M | N | |
| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/geofencing-subscriptions.feature](/code/Test_definitions/geofencing-subscriptions.feature) |
| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
| 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 | [/CHANGELOG.md](/CHANGELOG.md) |
| 12 | Previous public-release was certified | O | O | O | M | N | |
| Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> stable | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------------------------:|:-------------------------:|:------:|:------------------------------------------------------------------------------------------------------------------:|
| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/geofencing-subscriptions.yaml](/code/API_definitions/geofencing-subscriptions.yaml) |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | |
| 3 | Guidelines from ICM applied | O | M | M | M | Y | |
| 4 | API versioning convention applied | M | M | M | M | Y | |
| 5 | API documentation | M | M | M | M | Y | inline in yaml |
| 6 | User stories | O | O | O | M | N | |
| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/geofencing-subscriptions.feature](/code/Test_definitions/geofencing-subscriptions.feature) |
| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/geofencing-subscriptions.feature](/code/Test_definitions/geofencing-subscriptions.feature) |
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved
| 9 | Test result statement | O | O | O | M | N | Test results not available (*) |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
| 12 | Previous public-release was certified | O | O | O | M | N | |

(*) If you encounter issues with the provided test files (.feature), please create an issue in the API Sub-Project to signal these issues so they can be fixed in a patch release.

Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.

Expand Down
Loading
Loading