generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #43 from FabrizioMoggio/Checklist
New readiness checklist
- Loading branch information
Showing
1 changed file
with
21 additions
and
13 deletions.
There are no files selected for viewing
34 changes: 21 additions & 13 deletions
34
documentation/API_documentation/CFS-API-Readiness-Checklist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,21 @@ | ||
| # CFS API Readiness minimum criteria checklist | ||
|
|
||
| <br> | ||
|
|
||
| | No | Deliverables/Criteria | Mandatory | Status (Contributed/Approved/Pending/Validated/Partly-Validated)| | ||
| |----|----------------------------------|-----------|---------------------------- | ||
| | 1 |API Spec | Y | Contributed | | ||
| | 2 |API Implementation | N | -- | | ||
| | 3 |API Documentation | Y | Contributed | | ||
| | 4 |User Stories | Y | Approved | | ||
| | 5 |API test cases | Y | Pending | | ||
| | 6 |Validated by atleast 2 operators | Y | Pending | | ||
| | 7 |Security review | Y | Pending | | ||
|
|
||
| # API Readiness Checklist | ||
|
|
||
| Checklist for API call-forwarding-signal v0.2.0-rc.1 in r1.1 | ||
|
|
||
|
|
||
| | 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 | /code/API_definitions/Call_Forwarding_Signal.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 | v0.2.0-rc.1 | | ||
| | 5 | API documentation | M | M | M | M | Y | inline in YAML | | ||
| | 6 | User stories | O | O | O | M | Y | /documentation/API_documentation/CFS_UserStory_UseCase-1.md | | ||
| | 7 | Basic API test cases & documentation | O | M | M | M | N | /code/Test_definitions/call-forwarding-signal-every-forwarding.feature, /code/Test_definitions/call-forwarding-signal-unconditional.feature | | ||
| | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | ||
| | 9 | Test result statement | O | O | O | M | N | | | ||
| | 10 | API release numbering convention applied | M | M | M | M | Y | r1.1 | | ||
| | 11 | Change log updated | M | M | M | M | Y | /CHANGELOG.md | | ||
| | 12 | Previous public-release was certified | O | O | O | M | N | | | ||
|
|