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.

Sign up for GitHub

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 qod-provisioning-API-Readiness-Checklist.md #330

Merged
merged 2 commits into from
Aug 5, 2024
Merged

Create qod-provisioning-API-Readiness-Checklist.md #330

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cddc8ca
Create qod-provisioning-API-Readiness-Checklist.md
jlurien Jul 26, 2024
6d006ae
Update qod-provisioning-API-Readiness-Checklist.md
jlurien Aug 5, 2024
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
18 changes: 18 additions & 0 deletions documentation/API_documentation/qod-provisioning-API-Readiness-Checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# API Readiness Checklist

Checklist for qod-provisioning v0.1.0-rc.1 in r1.1

| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
| 1 | API definition | M | M | M | M | Y | PR: /code/API_definitions/qod-provisioning.yaml |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | |
| 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/A | |
| 7 | Basic API test cases & documentation | O | M | M | M | tbd | |
| 8 | Enhanced API test cases & documentation | O | O | O | M | N/A | link |
| 9 | Test result statement | O | O | O | M | N/A | |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
| 11 | Change log updated | M | M | M | M | tbd | /CHANGELOG.md |
| 12 | Previous public release was certified | O | O | O | M | N/A | |