Skip to content

v3.1: fix parameter object and style defaults test fixtures - #5589

Open
hardikkaurani wants to merge 4 commits into
OAI:v3.1-devfrom
hardikkaurani:fix/v3.1-parameter-and-style-test-fixtures
Open

hardikkaurani wants to merge 4 commits into
OAI:v3.1-devfrom
hardikkaurani:fix/v3.1-parameter-and-style-test-fixtures

Conversation

@hardikkaurani

@hardikkaurani hardikkaurani commented Nov 7, 2026 •

Copy link
Copy Markdown

Summary

This PR fixes two test fixture discrepancies in tests/schema/pass/:

  1. tests/schema/pass/parameter-object-examples.yaml:

    • In /user/{username}, the path parameter was named usernames with description usernames to fetch.
    • Per OpenAPI §4.8.12, the parameter name for in: path must correspond to the template expression occurring within the path field in the Paths Object (username), aligning with the examples in the specification text.
    • Updated name to username and description to username to fetch.
  2. tests/schema/pass/style-defaults.yaml:

    • The header parameter fixture in components.parameters had in: path and required: true (likely a duplicate from path_simple).
    • Corrected in to header, removed required: true (as required defaults to false for headers), and updated x-comment to reflect expected defaults for header parameters (required=false, deprecated=false, style=simple, explode=false).

Validation

  • yarn test passes (55/55 tests passed).

  • yarn validate-markdown passes cleanly with zero issues.

  • yarn build-src passes cleanly (HTML and schemas generated without errors).

  • no schema changes are needed for this pull request

…ct-examples

Signed-off-by: Hardik Kaurani <hardikkaurani1@gmail.com>
… to match spec

Signed-off-by: Hardik Kaurani <hardikkaurani1@gmail.com>
Signed-off-by: Hardik Kaurani <hardikkaurani1@gmail.com>
…-defaults

Signed-off-by: Hardik Kaurani <hardikkaurani1@gmail.com>
@hardikkaurani
hardikkaurani requested review from a team as code owners November 7, 2026 09:00
Copilot AI balanced review requested due to automatic review settings November 7, 2026 09:00

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@hardikkaurani

hardikkaurani commented Nov 7, 2026 •

Copy link
Copy Markdown
Author

Hi @baywet,

Following up on the recent schema test cleanups on v3.1-dev (including #5580, #5581, and #5586), I noticed two remaining discrepancies in the pass fixtures under tests/schema/pass/:

  1. parameter-object-examples.yaml: The path parameter for /user/{username} was defined with name: usernames and description: usernames to fetch. Updating the parameter name to username ensures it matches the path template expression, as required by OAS §4.8.12, and aligns with the Parameter Object example in src/oas.md.

  2. style-defaults.yaml: components.parameters.header was configured with in: path and required: true, seemingly as a copy-paste artifact from path_simple. Updating it to in: header, removing required: true, and correcting the comment to reflect the expected header defaults (required=false, deprecated=false, style=simple, explode=false) ensures the fixture correctly tests header parameter default permutations.

Verification:

  • yarn test — all 55 schema and md2html tests passed.
  • yarn validate-markdown — completed with zero errors.
  • yarn build-src — HTML specification and schemas built successfully.

Whenever you have a chance, I'd appreciate your review and feedback!

Thanks!

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants