Skip to content

feat(spec): Add querystring support compatible with OAS 3.2#443

Open
frankkilcommins wants to merge 2 commits intoOAI:v1.1-devfrom
frankkilcommins:querystring-feature
Open

feat(spec): Add querystring support compatible with OAS 3.2#443
frankkilcommins wants to merge 2 commits intoOAI:v1.1-devfrom
frankkilcommins:querystring-feature

Conversation

@frankkilcommins
Copy link
Collaborator

fixes #438

ndenny
ndenny previously approved these changes Mar 4, 2026
operationId: $sourceDescriptions.api.searchItems
parameters:
- name: q
in: querystring No newline at end of file
Copy link
Contributor

@DmitryAnansky DmitryAnansky Mar 5, 2026

Choose a reason for hiding this comment

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

It might be helpful to include another fail example that demonstrates the case where querystring and query parameters cannot coexist.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@DmitryAnansky I thought about that for quite a while before submitting the PR, and ultimately landed at the conclusion of that constraint check being an OpenAPI responsibility rather than Arazzo's.

If an OpenAPI operation described query and querystring parameters, then that would be an invalid OpenAPI Description (or Document) based on the following constraint described in OpenAPI 3.2's Parameter Object description of parameters with in: querystring:

MUST NOT appear in the same operation (or in the operation’s path-item) as any in: "query" parameters

kevinduffey
kevinduffey previously approved these changes Mar 18, 2026
Copy link
Collaborator

@kevinduffey kevinduffey left a comment

Choose a reason for hiding this comment

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

LGTM

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

Labels

None yet

5 participants