Skip to content

Documents update #85

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

Merged
merged 4 commits into from
Aug 5, 2024
Merged

Documents update #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d63bbf2
README update
FabrizioMoggio Jul 29, 2024
5d136f7
Update CFS-API-Readiness-Checklist.md
FabrizioMoggio Jul 29, 2024
755f8cd
Readiness-Checklist rename
FabrizioMoggio Jul 29, 2024
50127b2
Update README.md
FabrizioMoggio Aug 2, 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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Repository to describe, develop, document and test the Call Forwarding Signal AP
## Status and released versions

* Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
* **The latest available release and version of CAMARA CallForwardingSignal API is v0.2.0-rc.2. This is the first (pre) relese candidate version of the API.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
* **The latest available version of CAMARA CallForwardingSignal API is v0.2.0-rc.2. This is a release-candidate API version.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
* The Release Tag is [r1.2](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r1.2).
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml)
Expand Down
2 changes: 1 addition & 1 deletion ...umentation/CFS-API-Readiness-Checklist.md → ...rding-signal-API-Readiness-Checklistst.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Checklist for API call-forwarding-signal v0.2.0-rc.2 in r1.2
| 4 | API versioning convention applied | M | M | M | M | Y | v0.2.0-rc.2 |
| 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 |
| 7 | Basic API test cases & documentation | O | M | M | M | Y | /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.2 |
Expand Down