From 7f93049cc16d478c41851fddecb78161c5f0fe9e Mon Sep 17 00:00:00 2001 From: maheshc01 Date: Wed, 27 Aug 2025 14:19:28 -0500 Subject: [PATCH 1/6] fall25 m4 --- CHANGELOG.md | 31 +++++++++++++++++++ README.md | 16 ++++++---- .../API_definitions/application-profiles.yaml | 4 +-- .../application-profiles.feature | 4 +-- ...cation-profiles-API-Readiness-Checklist.md | 6 ++-- 5 files changed, 48 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dae3aea..db214d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ NOTE: ## Table of contents +- **[r1.2](#r12) (Fall25 public release)** - **[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.** @@ -15,6 +16,36 @@ 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 Note: this API had former releases in the [ConnectivityInsights](https://github.com/camaraproject/ConnectivityInsights/releases) repository. + +# r1.2 +## Release Notes + +This release contains the definition and documentation of +* application-profiles v0.5.0 + +The API definition(s) are based on +* Commonalities v0.6.0 (r3.3) +* Identity and Consent Management v0.4.0 (r3.3) + +* **r1.2 release of ApplicationProfiles has the following API definitions:** + + * **application-profiles v0.5.0** + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml&nocors) + [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml) + + +### Added +* n/a + +### Changed +* n/a + +### Removed +* n/a + +**Full Changelog**: https://github.com/camaraproject/ApplicationProfiles/compare/r1.1...r1.2 + # r1.1 ## Release Notes diff --git a/README.md b/README.md index 4d0b858..d1ad9b7 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,19 @@ Sandbox API Repository to describe, develop, document, and test the ApplicationP ## Release Information -**NEW**: First pre-release [r1.1](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r1.1) with application-profiles v0.5.0-rc.1 is available. +**NEW**: public release [r1.2](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r1.2) is available with the following API versions: + + * **application-profiles v0.5.0** + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml&nocors) + [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml) Prior releases of application-profiles (as a sub project in connectivity insights) up to version 0.4.0 as part of the Fall25 meta-release are available within [ConnectivityInsights](https://github.com/camaraproject/ConnectivityInsights/releases). - - -Pre-releases of this sub project are available in https://github.com/camaraproject/ApplicationProfiles/releases - -For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationProfiles/blob/main/CHANGELOG.md) + +* The latest public release is available here: https://github.com/camaraproject/ApplicationProfiles/releases/latest +* Other releases of this sub project are available in https://github.com/camaraproject/ApplicationProfiles/releases +* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationProfiles/blob/main/CHANGELOG.md) ## Contributing * Meetings are held virtually together with ConnectivityInsights diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml index 910e1a7..00f5f8d 100644 --- a/code/API_definitions/application-profiles.yaml +++ b/code/API_definitions/application-profiles.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Connectivity Insights - Application Profiles x-camara-commonalities: 0.6 - version: wip + version: 0.5.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -64,7 +64,7 @@ externalDocs: description: Project documentation at Camara url: https://github.com/camaraproject/ApplicationProfiles servers: - - url: "{apiRoot}/application-profiles/vwip" + - url: "{apiRoot}/application-profiles/v0.5" variables: apiRoot: default: https://localhost:9091 diff --git a/code/Test_definitions/application-profiles.feature b/code/Test_definitions/application-profiles.feature index 3e934e7..5863acf 100644 --- a/code/Test_definitions/application-profiles.feature +++ b/code/Test_definitions/application-profiles.feature @@ -1,11 +1,11 @@ @Application_Profiles -Feature: CAMARA Application Profiles API, vwip - Operations for Application Profiles +Feature: CAMARA Application Profiles API, v0.5.0 - Operations for Application Profiles # Input to be provided by the implementation to the tests # References to OAS spec schemas refer to schemas specified in application-profiles.yaml Background: Common Application Profiles setup - Given the resource "{apiroot}/application-profiles/vwip" as base-url + Given the resource "{apiroot}/application-profiles/v0.5" as base-url 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" diff --git a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md index 27dab06..12ee979 100644 --- a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md +++ b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md @@ -1,12 +1,12 @@ # API Readiness Checklist -Checklist for application-profiles v0.5.0-rc.1 in r1.1 +Checklist for application-profiles v0.5.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/application-profiles.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 | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/application-profiles-User-Story.md) | From 107a68dc1550db5957bc2e7299a5f6ef4aa6a2bf Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 15 Sep 2025 14:38:07 +0530 Subject: [PATCH 2/6] Added public to the release notes in CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index db214d5..2627feb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,7 +20,7 @@ Note: this API had former releases in the [ConnectivityInsights](https://github. # r1.2 ## Release Notes -This release contains the definition and documentation of +This public release contains the definition and documentation of * application-profiles v0.5.0 The API definition(s) are based on From cc80d8d8db4da854567a3e840690977d7f7d5535 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 15 Sep 2025 14:50:45 +0530 Subject: [PATCH 3/6] Modified r1.2 notes in CHANGELOG.md --- CHANGELOG.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2627feb..e03678b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,15 +34,21 @@ The API definition(s) are based on [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml) [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml) - ### Added -* n/a + +* New `DeviceResponse` object in responses limited to one identifier. +* Clarifications on non-documented error responses. +* Support for compute resource requirements related to the application. ### Changed -* n/a + +* Updated string pattern for `x-correlator`headers. ### Removed -* n/a + +* `verificationResult: UNKNOWN` for 200 responses. +* Error `422 IDENTIFIER_MISMATCH`. +* Error `401 AUTHENTICATION_REQUIRED`. **Full Changelog**: https://github.com/camaraproject/ApplicationProfiles/compare/r1.1...r1.2 From 846639bdbb33772bb6a62c29c71563c7d7c9b1a8 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 15 Sep 2025 14:57:03 +0530 Subject: [PATCH 4/6] Modified the resource url in application-profiles.feature --- code/Test_definitions/application-profiles.feature | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/application-profiles.feature b/code/Test_definitions/application-profiles.feature index 5863acf..761f44f 100644 --- a/code/Test_definitions/application-profiles.feature +++ b/code/Test_definitions/application-profiles.feature @@ -5,7 +5,8 @@ Feature: CAMARA Application Profiles API, v0.5.0 - Operations for Application Pr # References to OAS spec schemas refer to schemas specified in application-profiles.yaml Background: Common Application Profiles setup - Given the resource "{apiroot}/application-profiles/v0.5" as base-url + Given an environment at "apiRoot" + And the resource "/application-profiles/v0.5" 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" From 7026ea5ceadce25b545b6f498d0019a52e0b6253 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 15 Sep 2025 15:05:47 +0530 Subject: [PATCH 5/6] Updated ErrorInfo schema in application-profiles.yaml --- code/API_definitions/application-profiles.yaml | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml index 00f5f8d..187fbdc 100644 --- a/code/API_definitions/application-profiles.yaml +++ b/code/API_definitions/application-profiles.yaml @@ -498,21 +498,20 @@ components: ErrorInfo: type: object - description: Error information required: + - message - status - code - - message properties: + message: + type: string + description: A human-readable description of what the event represents status: type: integer - description: HTTP status code returned along with this error response + description: HTTP response status code code: type: string - description: Code given to this error - message: - type: string - description: Detailed error description + description: A human-readable code to describe the error responses: Generic400: From 98618bf97f735886b891bdab6147aa518a7ee693 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 15 Sep 2025 21:33:08 +0530 Subject: [PATCH 6/6] Updated ErrorInfo in application-profiles.yaml --- code/API_definitions/application-profiles.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml index 187fbdc..bfd596b 100644 --- a/code/API_definitions/application-profiles.yaml +++ b/code/API_definitions/application-profiles.yaml @@ -499,19 +499,19 @@ components: ErrorInfo: type: object required: - - message - status - code + - message properties: - message: - type: string - description: A human-readable description of what the event represents status: type: integer description: HTTP response status code code: type: string description: A human-readable code to describe the error + message: + type: string + description: A human-readable description of what the event represents responses: Generic400: