Skip to content

CDA-72: OpenAPI Documentation: Added verification of requirement status for query parameters to tests#1587

Open
zack-rma wants to merge 4 commits intoUSACE:developfrom
zack-rma:bugfix/openapi-required-annotations
Open

CDA-72: OpenAPI Documentation: Added verification of requirement status for query parameters to tests#1587
zack-rma wants to merge 4 commits intoUSACE:developfrom
zack-rma:bugfix/openapi-required-annotations

Conversation

@zack-rma
Copy link
Collaborator

Resolves #1494

Adds verification of required status for query parameters. Also checks parameter type.

@zack-rma zack-rma marked this pull request as draft February 18, 2026 17:03
@zack-rma zack-rma marked this pull request as ready for review February 19, 2026 23:08
@zack-rma zack-rma requested a review from rma-rripken February 19, 2026 23:08
rma-rripken
rma-rripken previously approved these changes Feb 20, 2026
Copy link
Collaborator

@rma-rripken rma-rripken left a comment

Choose a reason for hiding this comment

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

These all look good but there are still some failing static analysis tests related to required parameters for timezone and effective-date. I assume you'll look into those in a follow-up?

Copy link
Collaborator

@rma-rripken rma-rripken left a comment

Choose a reason for hiding this comment

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

The annotation isn't my favorite solution but its very effective from a cost/value standpoint

@MikeNeilson
Copy link
Contributor

The annotation isn't my favorite solution but its very effective from a cost/value standpoint

Agreed, certainly can't think of anything better and it is clear to the reader (developer) what might be happening.

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.

Expand static code analysis testing to verify implementations respect OpenApi annotations with "required = true"

3 participants