Skip to content

Editorial corrections and alignments in Spring26 testing Artifacts#642

Open
PedroDiez wants to merge 1 commit into
camaraproject:mainfrom
PedroDiez:testing_artifacts_editorial_updates_and_alignments
Open

Editorial corrections and alignments in Spring26 testing Artifacts#642
PedroDiez wants to merge 1 commit into
camaraproject:mainfrom
PedroDiez:testing_artifacts_editorial_updates_and_alignments

Conversation

@PedroDiez

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • correction
  • tests

What this PR does / why we need it:

This PR deals with with some editorial corrections and wording alignment for Spring26 testing artifacts, as detailed in Issue #641

Which issue(s) this PR fixes:

Fixes #641

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

N/A

Changelog input

 Editorial corrections and alignments in Spring26 testing Artifacts

Additional documentation

This section can be blank.

docs

Comment on lines +86 to +107
# createResource MUST be replaced by applicable operationId for the tested operation
# schema names MUST be replaced by applicable values for the tested operation
# Applicable for APIs that does not own device nor phoneNumber concept
@{feature_identifier}_{createResource}_01_generic_success_scenario
Scenario Outline: Common validations for any success scenario
Given the request body property "$.{requestProperty}" is set to a valid {placeholder_suitable_text}
# Several clauses for request body property may apply depending on the operation
And the request body property "$.{requestProperty}" is set to a valid {placeholder_suitable_text}
And the request body is compliant with the schema at "#/components/schemas/<createResource>"
When the request "<createResource>" is sent
Then the response status code is 201
And the response header "Content-Type" is "application/json"
And the response header "x-correlator" has the same value as the request header "x-correlator"
# The response has to comply with the generic response schema which is part of the spec
And the response body complies with the OAS schema at "#/components/schemas/<Resource>"
# Additionally, in case any success response has to comply with some constraints beyond the schema compliance
And the response property "<property>" matches the rule: <condition>

Examples:
| property | condition |
| $.xxx | yyy |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was it intended to duplicate this test description? It's not clear why the template for a create resource test is needed twice.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intention is to have the exact test wording for device, phoneNumber and none of those concepts variants, for the API inititative to pick-up the applicable one:

  • Line 66 defines the test scenario for an API that owns the phoneNumberConcept
  • Line89 defines the test scenario for an API that does not own device nor phoneNumber concept

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

correction correction in documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Editorial corrections and alignments in Spring26 testing Artifacts

2 participants