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

New readiness checklist #43

Merged
merged 6 commits into from
Jul 19, 2024
Merged

New readiness checklist #43

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ba57655
New readiness checklist
FabrizioMoggio Jun 20, 2024
e6ca9e6
Update CFS-API-Readiness-Checklist.md
FabrizioMoggio Jul 18, 2024
8b85b8f
Update CFS-API-Readiness-Checklist.md
FabrizioMoggio Jul 18, 2024
1151586
Update documentation/API_documentation/CFS-API-Readiness-Checklist.md
FabrizioMoggio Jul 18, 2024
baac4f0
Update CFS-API-Readiness-Checklist.md
FabrizioMoggio Jul 18, 2024
2fca859
Update documentation/API_documentation/CFS-API-Readiness-Checklist.md
FabrizioMoggio Jul 18, 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
33 changes: 20 additions & 13 deletions documentation/API_documentation/CFS-API-Readiness-Checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# 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 CFS API wip
FabrizioMoggio marked this conversation as resolved.
Show resolved Hide resolved

| 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 | |
| 5 | API documentation | M | M | M | M | Y | inline in YAML |
| 6 | User stories | O | O | O | M | Y | |
| 7 | Basic API test cases & documentation | O | M | M | M | N | /documentation/API_documentation/CFS_UserStory_UseCase-1.md |
| 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 | |
| 11 | Change log updated | M | M | M | M | Y | /CHANGELOG.md |
| 12 | Previous public-release was certified | O | O | O | M | N | |