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

Deprecate API-Readiness-Checklist.md #220

Merged
merged 4 commits into from
Jun 17, 2024
Merged
Changes from 3 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
11 changes: 1 addition & 10 deletions documentation/API-Readiness-Checklist.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,2 @@
# API Readiness minimum criteria checklist
| No | Deliverables/Criteria | Mandatory | Reference template |
|----|-------------- |-----------|-------------------- |
| 1 |API Spec | Y | OAS3 (https://spec.openapis.org/oas/v3.0.3)|
| 2 |API Implementation | N | |
| 3 |API Documentation | Y |The API specification should include all the needed documentation. |
|4 |User Stories | Y | https://github.com/camaraproject/Commonalities/blob/main/documentation/Userstory-template.md |
| 5 |API test cases and documentation | Y | A Gherkin feature file will be added to the main subproject repo and this will fulfil the minimum criteria of readiness w.r.t API test cases and documentation. If subprojects also intend to add test implementations, an aligned single implementation that is agreed amongst all provider implementors could be added to the main subproject repo. If no alignment is possible, each provider implementor will add the test implementation to their own repos |
| 6 |Tested by at least 2 operators | Y | |
| 7 |Security review | Y | Spec contributions should include a security scheme section that complies with the AuthN&AuthZ techniques agreed in Commonalities. |

**PLEASE NOTE: This document is DEPRECATED as the updated [API Readiness Checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) was developed within Release Management Working Group.**
rartych marked this conversation as resolved.
Show resolved Hide resolved