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

Add Readiness checklist for Location-Retrieval #230

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Add Readiness checklist for Location-Retrieval #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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_documentation/location-retrieval-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

Checklist for location-retrieval api-version in v0.2

As we target an **initial** maturity level release the column **Status** is filled accordingly: NA: Not Applicable, TBD: To Be Done

| Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> stable | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
| 1 | API definition | M | M | M | M | Y | [link](https://github.com/camaraproject/DeviceLocation/blob/main/code/API_definitions/location-retrieval.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 | Embed documentation into API spec - [link](https://github.com/camaraproject/DeviceLocation/blob/main/code/API_definitions/location-retrieval.yaml) |
| 6 | User stories | O | O | O | M | NA | link |
| 7 | Basic API test cases & documentation | O | M | M | M | TBD | link |
| 8 | Enhanced API test cases & documentation | O | O | O | M | NA | link |
| 9 | Test result statement | O | O | O | M | NA | link |
| 10 | API release numbering convention applied | M | M | M | M | TBD | |
| 11 | Change log updated | M | M | M | M | TBD | link |
| 12 | Previous public-release was certified | O | O | O | M | NA | |




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)