chore: adds initial drafts of API-Readiness-Checklist.md and CHANGELO…

…G.md

CHANGELOG.md

@@ -0,0 +1,49 @@
+# 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-alpha.1
+
+The API definition(s) are based on
+
+- Commonalities v0.4.0
+- Identity and Consent Management v0.1.0
+
+## Network Access Management v0.1.0-alpha.1
+
+**Network Access Management v0.1.0-alpha.1 is a pre-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 initial proposal from the Backlog Working Group.
+
+### Changed
+
+- Updated the initial proposal to follow the Commonalities and Identity and Consent
+  Management guidelines.
+
+### Fixed
+
+- Fixed linting errors in the initial proposal.
+
+### Removed

documentation/API_documentation/network-access-management-API-Readiness-Checklist.md

@@ -0,0 +1,28 @@
+# API Readiness Checklist
+
+Checklist for network-access-management v0.1.0-alpha.1 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   |      | [link](../../code/API_definitions/network_access_management.yaml) |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |      |      |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |      |      |
+|  4 | API versioning convention applied            |   Y   |         M         |    M    |    M   |      |      |
+|  5 | API documentation                            |   Y   |         M         |    M    |    M   |      | inline in YAML |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |      | link |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |      | link |
+|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |      | link |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |      | link |
+| 10 | API release numbering convention applied     |   Y   |         M         |    M    |    M   |      |      |
+| 11 | Change log updated                           |   Y   |         M         |    M    |    M   |      | [link](../../CHANGELOG.md) |
+| 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |      |      |
+
+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).