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

Jump to bottom

Add API-Readiness-Checklist.md to RM project #29

Merged
merged 10 commits into from
Jun 11, 2024
Merged

Add API-Readiness-Checklist.md to RM project #29

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
81a6e69
Add API-Readiness-Checklist.md to RM project
tanjadegroot May 15, 2024
9893b30
Update documentation/API-Readiness-Checklist.md
tanjadegroot May 15, 2024
bde68e5
Update API-Readiness-Checklist.md
tanjadegroot May 15, 2024
fe7efb0
Update API-Readiness-Checklist.md
tanjadegroot May 15, 2024
25400e8
Update API-Readiness-Checklist.md
tanjadegroot May 15, 2024
9e7529b
Update API-Readiness-Checklist.md
tanjadegroot May 16, 2024
96dde85
Update API-Readiness-Checklist.md
tanjadegroot Jun 5, 2024
104219d
Update API-Readiness-Checklist.md
tanjadegroot Jun 6, 2024
88267fa
Update API-Readiness-Checklist.md
tanjadegroot Jun 6, 2024
c8ac459
Update API-Readiness-Checklist.md
tanjadegroot Jun 6, 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
27 changes: 27 additions & 0 deletions documentation/API-Readiness-Checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# API Readiness Checklist
tanjadegroot marked this conversation as resolved.
Show resolved Hide resolved

Checklist for api-name api-version in rx.y.

| Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> stable | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
| 1 | API definition | M | M | M | M | | link |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | | |
| 3 | Guidelines from ICM applied | O | M | M | M | | |
| 4 | API versioning convention applied | M | M | M | M | | |
| 5 | API documentation | M | M | M | M | | link |
| 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 | M | M | M | M | | |
| 11 | Change log updated | M | M | M | M | | link |
| 12 | Previous public-release was certified | O | O | O | M | | |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If enhanced test plan is not required for the initial public release, and certification of the initial public release is required to have a stable public-release, this is assuming that the test plan used for the first certification is just the basic one, not the enhanced one, is this right? Or is that the initial public release has to be certified once the complete test plan is available.


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, or "N" (no) otherwise. You can add comments as needed. Example: an intermediate alpha or release-candidate release may not yet provide all mandatory release assets for the release type in an intermedaite release.
- in the Comments column, provide links whenever available to the assests, and any other relevant comments.

Note: It is normal that the checklists of the (final) release-candidate and its subsequent public-release are the same, while additional release assets are required for a subsequent stable public-release.

The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist)