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

Align API-Testing-Guidelines with new Enhancements and Alignments in Errors #343

Merged
merged 2 commits into from
Nov 29, 2024
Merged

Align API-Testing-Guidelines with new Enhancements and Alignments in Errors #343

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1b9bcb
Update API-Testing-Guidelines.md
jlurien Nov 22, 2024
fe8579e
Update documentation/API-Testing-Guidelines.md
jlurien Nov 25, 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
4 changes: 3 additions & 1 deletion documentation/API-Testing-Guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,9 @@ For the explicit subscriptions model:

### Error scenarios

* All errors explicitly documented in the API spec must be covered by one or more dedicated error scenarios.
* Test plan must be aligned with API specification regarding the coverage of HTTP statuses in the responses.
- All errors explicitly documented in the API spec must be covered by one or more dedicated error scenarios.
- On the contrary, HTTP Statuses which are not explicitly documented in the API specification should not be covered in the test plan. If any of the non-mandatory "status" in API Design Guidelines is relevant in the context of a given API and deserves to have a specific test, it needs to be documented in the API specification as well.
- In particular operations that expect a `device` object allowing one or more identifiers to be provided, must include scenarios to test the error cases defined, aligned with the device error management section of the API design guidelines.

* It must be validated that the HTTP status code and response property `code` are exactly those specified in the API spec.
Expand Down