generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 3
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 v0.1.0 alpha.1 #16
Closed
Closed
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0f2fbd0
chore: adds initial drafts of API-Readiness-Checklist.md and CHANGELO…
caubut-charter ede259c
fix: makes corrections to filled out API-Readiness-Checklist.md
caubut-charter c46a2a1
chore: filled out status blanks in API-Readiness-Checklist.md
caubut-charter ae0ab69
docs: cleanup changelog
caubut-charter 246fb3c
chore: drops alpha designation
caubut-charter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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-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 an alpha 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 |
This file was deleted.
Oops, something went wrong.
28 changes: 28 additions & 0 deletions
28
...entation/API_documentation/network-access-management-API-Readiness-Checklist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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-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 | Y | [link](../../code/API_definitions/network_access_management.yaml) | | ||
| 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). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't have changed from the template.