Skip to content

Commit

Permalink
Merge pull request #220 from rartych/api-readiness-deprecation
Browse files Browse the repository at this point in the history
Deprecate API-Readiness-Checklist.md
  • Loading branch information
rartych authored Jun 17, 2024
2 parents b723687 + d0fa71b commit 99ae98d
Showing 1 changed file with 1 addition and 10 deletions.
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) is now maintained within the Release Management Working Group.**

0 comments on commit 99ae98d

Please sign in to comment.