diff --git a/CHANGELOG.md b/CHANGELOG.md index 75fd0d5..0fecba0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,8 @@ ## Table of contents -- **[r1.1 - rc](#r11---rc)** +- **[r1.2](#r12)** +- **[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,27 @@ The below sections record the changes for each API version in each release as fo +# r1.2 + +## Release Notes + +This public release contains the definition and documentation of +* application-endpoint-registration v0.1.0 + +The API definition(s) are based on +* Commonalities v0.6.0 (r3.3) +* Identity and Consent Management v0.4.0 (r3.3) + +- API definition with inline documentation: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointRegistration/r1.2/code/API_definitions/application-endpoint-registration.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointRegistration/r1.2/code/API_definitions/application-endpoint-registration.yaml) + - [OpenAPI YAML spec file](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/r1.2/code/API_definitions/application-endpoint-registration.yaml) + +### Added +* Creation of the application-endpoint-registration API yaml file +### Changed +* n/a + # r1.1 ## Release Notes diff --git a/README.md b/README.md index 4eb93da..b4af29f 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,14 @@ Sandbox API Repository to describe, develop, document, and test the ApplicationE ## Release Information +* Note: 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest public release**. +* **NEW: Latest public release [r1.2](https://github.com/camaraproject/ApplicationEndpointRegistration/releases/tag/r1.2) is available, with the following API version:** + * **application-endpoint-registration v0.1.0** + [[YAML]](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/r1.2/code/API_definitions/application-endpoint-registration.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointRegistration/r1.2/code/API_definitions/application-endpoint-registration.yaml&nocors) + [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointRegistration/r1.2/code/API_definitions/application-endpoint-registration.yaml) + + diff --git a/code/API_definitions/application-endpoint-registration.yaml b/code/API_definitions/application-endpoint-registration.yaml index 33a4e04..d3f4231 100644 --- a/code/API_definitions/application-endpoint-registration.yaml +++ b/code/API_definitions/application-endpoint-registration.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Application Endpoints Registration - version: wip + version: 0.1.0 x-camara-commonalities: 0.6 description: | The Application Endpoints Registration API provides a programmable @@ -56,7 +56,7 @@ info: Endpoints. ## Errors - - If the API call contains a formatting or other any other syntatic error, + - If the API call contains a formatting or any other syntactic error, a `400 INVALID_ARGUMENT` error is returned. - If the API call cannot be authenticated due to missing, invalid, or expired credentials, a `401 UNAUTHENTICATED` error is returned. @@ -119,7 +119,7 @@ externalDocs: url: https://github.com/camaraproject/ApplicationEndpointRegistration servers: - - url: "{apiRoot}/application-endpoint-registration/vwip" + - url: "{apiRoot}/application-endpoint-registration/v0.1" variables: apiRoot: default: http://localhost:9091 diff --git a/code/Test_definitions/application-endpoint-registration.feature b/code/Test_definitions/application-endpoint-registration.feature index 33ab14c..12e7b58 100644 --- a/code/Test_definitions/application-endpoint-registration.feature +++ b/code/Test_definitions/application-endpoint-registration.feature @@ -1,5 +1,5 @@ @Application_Endpoint_Registration -Feature: CAMARA Application Endpoint Registration API, vwip - Operations for registering application endpoints +Feature: CAMARA Application Endpoint Registration API, v0.1.0 - Operations for registering application endpoints # Input to be provided by the implementation to the tests # * apiRoot: API root of the server URL @@ -7,7 +7,7 @@ Feature: CAMARA Application Endpoint Registration API, vwip - Operations for reg Background: Common Application Endpoint Registration setup Given an environment at "apiRoot" - And the resource "/application-endpoint-registration/vwip" + And the resource "/application-endpoint-registration/v0.1" 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-Endpoint-Registration-API-Readiness-Checklist.md b/documentation/API_documentation/Application-Endpoint-Registration-API-Readiness-Checklist.md index b134809..c00d953 100644 --- a/documentation/API_documentation/Application-Endpoint-Registration-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Application-Endpoint-Registration-API-Readiness-Checklist.md @@ -1,12 +1,12 @@ # Application Endpoints Registration API Readiness minimum criteria checklist -Checklist for Application-Endpoint-Registration v0.1.0-rc1 in r1.1 +Checklist for Application-Endpoint-Registration v0.1.0 | 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-endpoint-registration.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release r3.2 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | ICM release 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-endpoint-registration-User-Story.md) |