Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
38 changes: 38 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Table of Contents

- [r2.2](#r22)
- [r2.1](#r21)
- [r1.3](#r13)
- [r1.2](#r12)
Expand All @@ -16,6 +17,43 @@ 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

# r2.2

## Release Notes

This pre-release contains the definition and documentation of
* number-recycling v0.2.0

The API definition(s) are based on
* Commonalities v0.6.0
* Identity and Consent Management v0.4.0

## number-recycling v0.2.0

**number-recycling v0.2.0 is the second release version of the Number-Recycling API.**

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

### Added
* Add a missing summary for operation POST /check to YAML file in https://github.com/camaraproject/NumberRecycling/pull/64

### Changed
* Update versions in API and test definitions back to wip in https://github.com/camaraproject/NumberRecycling/pull/63

### Fixed
* N/A

### Removed
* N/A

## New Contributors
* N/A

**Full Changelog**: https://github.com/camaraproject/NumberRecycling/compare/r1.3...r2.2

# r2.1

## Release Notes
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Sandbox API Repository to describe, develop, document, and test the NumberRecycl
<br>This is a public release. Generated as a patch release of [r1.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r1.2)
- Contains the following API definitions **with inline documentation**:
- [YAML spec file](https://github.com/camaraproject/NumberRecycling/blob/r1.3/code/API_definitions/number-recycling.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r1.3/code/API_definitions/number-recycling.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r1.3/code/API_definitions/number-recycling.yaml&nocors)
* **NEW**: Pre-release [r2.1](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.1) with number-recycling v0.2.0-rc.1 is available.
* **NEW**: Pre-release [r2.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.2) with number-recycling v0.2.0 is available.

## Contributing
* Meetings of KnowYourCustomer Sub Project are held virtually
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/number-recycling.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ info:
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.

version: 0.2.0-rc.1
version: 0.2.0
x-camara-commonalities: 0.6

license:
Expand All @@ -78,7 +78,7 @@ externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/NumberRecycling
servers:
- url: '{apiRoot}/number-recycling/v0.2rc1'
- url: '{apiRoot}/number-recycling/v0.2'
variables:
apiRoot:
default: http://localhost:9091
Expand Down
4 changes: 2 additions & 2 deletions code/Test_definitions/number-recycling.feature
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Number Recycling API, v0.2.0-rc.1 - Operation checkNumberRecycling
Feature: CAMARA Number Recycling API, v0.2.0 - Operation checkNumberRecycling
# Environment variables:
# * api_root: API root of the server URL
#
Expand All @@ -10,7 +10,7 @@ Feature: CAMARA Number Recycling API, v0.2.0-rc.1 - Operation checkNumberRecycli

Background: Common checkNumberRecycling setup
Given an environment at "apiRoot"
And the resource "/number-recycling/v0.2rc1/check"
And the resource "/number-recycling/v0.2/check"
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,6 +1,6 @@
# API Readiness Checklist

Checklist for number-recycling v0.2.0-rc.1 in r2.1
Checklist for number-recycling v0.2.0 in r2.2

| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Reference information |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
Expand Down