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: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Table of contents

- **[r1.2](#r12) (Fall25 public release)**
- **[r1.1 - rc](#r11---rc)**

**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,29 @@ 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-discovery 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)

## application-endpoint-discovery v0.1.0

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointDiscovery/r1.2/code/API_definitions/application-endpoint-discovery.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointDiscovery/r1.2/code/API_definitions/application-endpoint-discovery.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/r1.2/code/API_definitions/application-endpoint-discovery.yaml)

**NOTE: there is no significant changes compared to r1.1-rc version .**


# r1.1 - rc

## Release Notes
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
Expand Down Expand Up @@ -26,7 +27,12 @@ Sandbox API Repository to describe, develop, document, and test the ApplicationE

<!-- 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 -->
**NEW**: First pre-release [r1.1](https://github.com/camaraproject/ApplicationEndpointDiscovery/releases/tag/r1.1) with application-endpoint-discovery v0.1.0-rc.1 is available.
**NEW**: First public release [r1.2](https://github.com/camaraproject/ApplicationEndpointDiscovery/releases/tag/r1.2) with application-endpoint-discovery v0.1.0 is available.

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointDiscovery/r1.2/code/API_definitions/application-endpoint-discovery.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointDiscovery/r1.2/code/API_definitions/application-endpoint-discovery.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/r1.2/code/API_definitions/application-endpoint-discovery.yaml)

Pre-releases of this sub project are available in https://github.com/camaraproject/ApplicationEndpointDiscovery/releases
<!-- The latest public release is available here: https://github.com/camaraproject/ApplicationEndpointDiscovery/releases/latest -->
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/application-endpoint-discovery.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
openapi: 3.0.3
info:
title: Application Endpoint Discovery
version: wip
version: 0.1.0
description: |
The Application Endpoint Discovery API returns the optimal application
endpoint(s) that a given end-user's device can connect to.
Expand Down Expand Up @@ -224,7 +224,7 @@ externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/ApplicationEndpointDiscovery
servers:
- url: "{apiRoot}/application-endpoint-discovery/vwip"
- url: "{apiRoot}/application-endpoint-discovery/v0.1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@application_endpoint_discovery
Feature: CAMARA Application Endpoint Discovery API, vwip - Operation getOptimalAppEndpoints
Feature: CAMARA Application Endpoint Discovery API, v0.1.0 - Operation getOptimalAppEndpoints
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -12,7 +12,7 @@ Feature: CAMARA Application Endpoint Discovery API, vwip - Operation getOptimalA

Background:
Given an environment at "apiRoot"
And the resource "/application-endpoint-discovery/vwip/retrieve-optimal-app-endpoints" |
And the resource "/application-endpoint-discovery/v0.1/retrieve-optimal-app-endpoints" |
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 Endpoint Discovery API Readiness minimum criteria checklist

Checklist for Application-Endpoint-Discovery v0.1.0-rc.1 in r1.1
Checklist for Application-Endpoint-Discovery 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-discovery.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/SupportingDocuments/API_Documentation/User%20Stories/Application%20Endpoint%20Discovery%20User%20Story.md) |
Expand Down