From affb16ac2c14556b1dfc41d6789d6d07e5c30e35 Mon Sep 17 00:00:00 2001 From: maheshc01 Date: Thu, 3 Jul 2025 05:42:42 +0530 Subject: [PATCH 01/12] preparing release candidate --- code/API_definitions/application-profiles.yaml | 4 ++-- code/Test_definitions/application-profiles.feature | 4 ++-- .../application-profiles-API-Readiness-Checklist.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml index c1728a1..419bd67 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-rc.1 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -47,7 +47,7 @@ info: email: sp-edc@lists.camaraproject.org servers: - - url: "{apiRoot}/application-profiles/vwip" + - url: "{apiRoot}/application-profiles/v0.5rc1" variables: apiRoot: default: https://localhost:9091 diff --git a/code/Test_definitions/application-profiles.feature b/code/Test_definitions/application-profiles.feature index c6c6d03..45b079a 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, v0.4.0 - Operations for Application Profiles +Feature: CAMARA Application Profiles API, v0.5.0-rc.1 - 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/v0.4" as base-url + Given the resource "{apiroot}/application-profiles/v0.5rc1" 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/schema/XCorrelator" diff --git a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md index 0bac510..0c6a35d 100644 --- a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md +++ b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for application-profiles v0.5.0-alpha.1 in Fall 25 alpha milestone +Checklist for application-profiles v0.5.0-rc.1 in r3.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| From b2a2e745982328a4fb87dc820fa2acdc4adbf96f Mon Sep 17 00:00:00 2001 From: maheshc01 Date: Tue, 15 Jul 2025 20:27:14 +0530 Subject: [PATCH 02/12] created new change log based on final list of changes --- CHANGELOG.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..789f2f7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,52 @@ +# Changelog Application Profiles + +NOTE: + +## 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.** + +The below sections record the changes for each API version in each release as follows: + +* for an alpha release, the delta with respect to the previous release +* for the first release-candidate, all changes since the last public release +* 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 + +# r1.1 +## Release Notes + +This release contains the definition and documentation of +* application-profiles v0.5.0-rc.1 + +The API definition(s) are based on +* Commonalities v0.6.0-rc.1 (r3.2) +* Identity and Consent Management v0.4.0-rc.1 (r3.2) + +* **r1.1 release of ConnectivityInsights has the following API definitions:** + + * **application-profiles v0.5.0-rc.1** + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.1/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.1/code/API_definitions/application-profiles.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.1/code/API_definitions/application-profiles.yaml) + + +### Added + +* New `DeviceResponse` object in responses limited to one identifier. +* Clarifications on non-documented error responses. +* Support for compute resource requirements related to the applicaton. + +### Changed + +* Updated string pattern for `x-correlator`headers. + +### Removed + +* `verificationResult: UNKNOWN` for 200 responses. +* Error `422 IDENTIFIER_MISMATCH`. +* Error `401 AUTHENTICATION_REQUIRED`. + +**Full Changelog**: https://github.com/camaraproject/ApplicationProfiles/commits/r1.1 From f87de49ff6011a431c89d15543a6c054222a8e5f Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 21 Jul 2025 20:37:28 +0530 Subject: [PATCH 03/12] Update application-profiles.yaml --- .../API_definitions/application-profiles.yaml | 35 +++++++++++-------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml index 419bd67..fea830d 100644 --- a/code/API_definitions/application-profiles.yaml +++ b/code/API_definitions/application-profiles.yaml @@ -23,17 +23,20 @@ info: Any more general service failures will result in an error in the `5xx`range with an explanation. - + ### Additional CAMARA error responses - The list of error codes in this API specification is not exhaustive. Therefore - the API specification may not document some non-mandatory error statuses as - indicated in `CAMARA API Design Guidelines`. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated - to this API version for a complete list of error responses. + The list of error codes in this API specification is not exhaustive. + Therefore the API specification may not document some non-mandatory error + statuses as indicated in `CAMARA API Design Guide`. + + Please refer to the `CAMARA_common.yaml` of the Commonalities Release + associated to this API version for a complete list of error responses. + The applicable Commonalities Release can be identified in the `API + Readiness Checklist` document associated to this API version. - As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error - response if it is explicitly documented in the API. + As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible + error response if it is explicitly documented in the API. # Authorization and authentication @@ -45,7 +48,9 @@ info: contact: email: sp-edc@lists.camaraproject.org - +externalDocs: + description: Project documentation at Camara + url: https://github.com/camaraproject/ApplicationProfiles servers: - url: "{apiRoot}/application-profiles/v0.5rc1" variables: @@ -235,19 +240,19 @@ components: x-correlator: description: Correlation id for the different services schema: - type: string - pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$ + $ref: "#/components/schemas/XCorrelator" parameters: x-correlator: name: x-correlator in: header description: Correlation id for the different services schema: - type: string - pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$ - example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" - + $ref: "#/components/schemas/XCorrelator" schemas: + XCorrelator: + type: string + pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$ + example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" Duration: type: object properties: From ee642d25d8984133ed573a2d43e0e76d1175511b Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 21 Jul 2025 20:54:59 +0530 Subject: [PATCH 04/12] Update application-profiles.yaml --- code/API_definitions/application-profiles.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml index 849002c..ff20702 100644 --- a/code/API_definitions/application-profiles.yaml +++ b/code/API_definitions/application-profiles.yaml @@ -24,7 +24,6 @@ info: Any more general service failures will result in an error in the `5xx`range with an explanation. - ### Additional CAMARA error responses The list of error codes in this API specification is not exhaustive. @@ -265,7 +264,7 @@ components: XCorrelator: type: string pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$ - example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" + example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" Duration: type: object properties: From 8f48e4b511098fb6ff3abaf9e7516e818ca39246 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 21 Jul 2025 22:06:38 +0530 Subject: [PATCH 05/12] Update application-profiles-API-Readiness-Checklist.md --- .../application-profiles-API-Readiness-Checklist.md | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md index 0c6a35d..3b776dc 100644 --- a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md +++ b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md @@ -16,6 +16,7 @@ Checklist for application-profiles v0.5.0-rc.1 in r3.1 | 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 | | +| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/iQFmBQ) | To fill the checklist: - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. From 6ab22fb94d41b4368f675563c7ab170b32304c89 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Tue, 22 Jul 2025 15:16:45 +0530 Subject: [PATCH 06/12] Update CHANGELOG.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 789f2f7..041128c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,7 +37,7 @@ The API definition(s) are based on * New `DeviceResponse` object in responses limited to one identifier. * Clarifications on non-documented error responses. -* Support for compute resource requirements related to the applicaton. +* Support for compute resource requirements related to the application. ### Changed From e55e6c7ba8d04f711a494fba46a35892f32cb74c Mon Sep 17 00:00:00 2001 From: urvika-v Date: Tue, 22 Jul 2025 23:09:36 +0530 Subject: [PATCH 07/12] Update documentation/API_documentation/application-profiles-API-Readiness-Checklist.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- .../application-profiles-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md index 3b776dc..f649dbe 100644 --- a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md +++ b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for application-profiles v0.5.0-rc.1 in r3.1 +Checklist for application-profiles v0.5.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| From 44f945a604e5b33d56984f62717c7b986b99f63e Mon Sep 17 00:00:00 2001 From: urvika-v Date: Tue, 22 Jul 2025 23:09:58 +0530 Subject: [PATCH 08/12] Update code/Test_definitions/application-profiles.feature Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- code/Test_definitions/application-profiles.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/application-profiles.feature b/code/Test_definitions/application-profiles.feature index 45b079a..394aaa0 100644 --- a/code/Test_definitions/application-profiles.feature +++ b/code/Test_definitions/application-profiles.feature @@ -8,7 +8,7 @@ Feature: CAMARA Application Profiles API, v0.5.0-rc.1 - Operations for Applicati Given the resource "{apiroot}/application-profiles/v0.5rc1" 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/schema/XCorrelator" + And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" ######### Happy Path Scenarios ################################# From e1a391c64932329fe6effdb5558adc64e32dc142 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Tue, 22 Jul 2025 23:15:29 +0530 Subject: [PATCH 09/12] Update CHANGELOG.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 041128c..049860c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,7 @@ The below sections record the changes for each API version in each release as fo * for the first release-candidate, all changes since the last public release * 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.1 ## Release Notes From 328e18e094515f03bae215359287c20a16c27886 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Wed, 23 Jul 2025 18:09:23 +0530 Subject: [PATCH 10/12] Update application-profiles-API-Readiness-Checklist.md --- .../application-profiles-API-Readiness-Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md index f649dbe..27dab06 100644 --- a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md +++ b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md @@ -5,8 +5,8 @@ Checklist for application-profiles v0.5.0-rc.1 in r1.1 | 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 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.2 | +| 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) | | 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 8dc7631daf4785dff1728f45c283934dc079fd80 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Fri, 25 Jul 2025 07:30:17 +0530 Subject: [PATCH 11/12] Update CHANGELOG.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 049860c..dae3aea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,7 +25,7 @@ The API definition(s) are based on * Commonalities v0.6.0-rc.1 (r3.2) * Identity and Consent Management v0.4.0-rc.1 (r3.2) -* **r1.1 release of ConnectivityInsights has the following API definitions:** +* **r1.1 release of ApplicationProfiles has the following API definitions:** * **application-profiles v0.5.0-rc.1** [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.1/code/API_definitions/application-profiles.yaml&nocors) From fda7e01795966d9ea6f4a61e21fdc68cc9e4de3f Mon Sep 17 00:00:00 2001 From: maheshc01 Date: Mon, 28 Jul 2025 13:00:35 -0500 Subject: [PATCH 12/12] update based on review comments --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ae91d95..4d0b858 100644 --- a/README.md +++ b/README.md @@ -15,24 +15,24 @@ Sandbox API Repository to describe, develop, document, and test the ApplicationP ## Scope -* Service API(s) “ApplicationProfiles” (see APIBacklog.md) -* The API(s) provide(s) the API consumer with the ability to: +* Service API(s) “ApplicationProfiles” (see APIBacklog.md) +* The API(s) provide(s) the API consumer with the ability to: * Application profiles allows application developers to share all the information about their application which would be relevant for network CAMARA APIs related decision making. * Describe, develop, document, and test the API(s) * Started: October 2024 (within ConnectivityInsights, own repository since March 2025) - + ## Release Information -The repository has no (pre)releases yet, work in progress is within the main branch. +**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. -Previous releases of the Application Profiles API up to version 0.4.0 as part of the Fall25 meta-release are available within [ConnectivityInsights](https://github.com/camaraproject/ConnectivityInsights/releases). +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) ## Contributing * Meetings are held virtually together with ConnectivityInsights