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
24 changes: 23 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

Expand All @@ -15,6 +16,27 @@ The below sections record the changes for each API version in each release as fo

<!--Repeat the below release section (header 1 and subsections) at the top of this file for each new (pre-)release-->

# 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
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


<!--The repository has no (pre)releases yet, work in progress is within the main branch.-->
<!-- Optional: an explicit listing of the latest (pre-)release with additional information, e.g. links to the API definitions -->
<!-- In addition use/uncomment one or multiple the following alternative options when becoming applicable -->
Expand Down
6 changes: 3 additions & 3 deletions code/API_definitions/application-endpoint-registration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
@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
# References to OAS spec schemas refer to schemas specified in application-endpoint-registration.yaml

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"
Expand Down
Original file line number Diff line number Diff line change
@@ -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<br>public | stable<br> 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) |
Expand Down