Skip to content

Commit

Permalink
Merge pull request #234 from maxl2287/feature/add-api-readiness-check…
Browse files Browse the repository at this point in the history 
…list-geofencing

Add Readiness checklist for Geofencing-Subscriptions
  • Loading branch information
@jlurien
jlurien authored Jul 26, 2024
2 parents 3f38c23 + fcad20c commit 38a001a
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions ...mentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# API Readiness Checklist

Checklist for geofencing-subscriptions api-version in v0.3

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](/code/API_definitions/geofencing-subscriptions.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](/code/API_definitions/geofencing-subscriptions.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 further public-release are the same, while additional release assets are required for the following 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)

0 comments on commit 38a001a

Please sign in to comment.