Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create release r1.1 with network-access-management v0.1.0-rc.1 #17

Closed
wants to merge 9 commits into from
45 changes: 45 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Changelog NetworkAccessManagement

## 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:

# r1.1

## Release Notes

This release contains the definition and documentation of

- Network Access Management v0.1.0

The API definition(s) are based on

- Commonalities v0.4.0
- Identity and Consent Management v0.1.0

## Network Access Management v0.1.0

**Network Access Management v0.1.0 is a release version.**

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r1.1/code/API_definitions/network_access_management.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r1.1/code/API_definitions/network_access_management.yaml)
- OpenAPI [YAML spec file](https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r1.1/code/API_definitions/network_access_management.yaml)

### Added

- Added Camara specific rules for yamllint and spectral.
- Added initial proposal from the backlog working group.

### Changed

### Fixed

### Removed
2 changes: 1 addition & 1 deletion code/API_definitions/network_access_management.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ info:
may be used. If an end-user replaces the equipment, all existing isolated networks SHOULD be synced to the new
device representing this mesh. Alternatively, a synthetic hardware address may also be used if the specification
for the address type allows.
version: wip
version: 0.1.0
caubut-charter marked this conversation as resolved.
Show resolved Hide resolved
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down
1 change: 0 additions & 1 deletion documentation/API_documentation/README.MD

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# API Readiness Checklist

Checklist for network-access-management v0.1.0 in r1.1.

| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
| 1 | API definition | M | M | Y | M | Y | [link](../../code/API_definitions/network_access_management.yaml) |
caubut-charter marked this conversation as resolved.
Show resolved Hide resolved
| 2 | Design guidelines from Commonalities applied | O | M | M | M | tbd | |
| 3 | Guidelines from ICM applied | O | M | M | M | Y | |
| 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 | N | link |
| 7 | Basic API test cases & documentation | O | M | M | M | N | link |
| 8 | Enhanced API test cases & documentation | O | O | O | M | N | link |
| 9 | Test result statement | O | O | O | M | N | link |
| 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 | |

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.
- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
- in the Comments column, provide the link to the asset once available, and any other relevant comments.

Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.

The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist).