Skip to content

Assert that REST params are consumed iff supported #114040

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.

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

Conversation

DaveCTurner
Copy link
Contributor

REST APIs which declare their supported parameters must consume exactly
those parameters: consuming an unsupported parameter means that requests
including that parameter will be rejected, whereas failing to consume a
supported parameter means that this parameter has no effect and should
be removed.

This commit adds an assertion to verify that we are consuming the
correct parameters.

Closes #113854

REST APIs which declare their supported parameters must consume exactly
those parameters: consuming an unsupported parameter means that requests
including that parameter will be rejected, whereas failing to consume a
supported parameter means that this parameter has no effect and should
be removed.

This commit adds an assertion to verify that we are consuming the
correct parameters.

Closes elastic#113854
@DaveCTurner DaveCTurner added >test Issues or PRs that are addressing/adding tests :Core/Infra/REST API REST infrastructure and utilities auto-backport-and-merge v8.16.0 v9.0.0 labels Oct 3, 2024
@elasticsearchmachine elasticsearchmachine added the Team:Core/Infra Meta label for core/infra team label Oct 3, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

@DaveCTurner
Copy link
Contributor Author

This is a repeat of #113933 which I reverted because it had a bug that only arose during release testing.

@DaveCTurner DaveCTurner added the test-release Trigger CI checks against release build label Oct 3, 2024
@DaveCTurner DaveCTurner requested a review from rjernst October 3, 2024 17:37
Copy link
Member

@rjernst rjernst left a comment

Choose a reason for hiding this comment

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

LGTM

@DaveCTurner DaveCTurner merged commit f27411e into elastic:main Oct 4, 2024
17 checks passed
@DaveCTurner DaveCTurner deleted the 2024/10/03/ensure-consumed-params-supported-retry branch October 4, 2024 04:56
DaveCTurner added a commit to DaveCTurner/elasticsearch that referenced this pull request Oct 4, 2024
REST APIs which declare their supported parameters must consume exactly
those parameters: consuming an unsupported parameter means that requests
including that parameter will be rejected, whereas failing to consume a
supported parameter means that this parameter has no effect and should
be removed.

This commit adds an assertion to verify that we are consuming the
correct parameters.

Closes elastic#113854
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.x

elasticsearchmachine pushed a commit that referenced this pull request Oct 4, 2024
…114087)

* Assert that REST params are consumed iff supported (#114040)

REST APIs which declare their supported parameters must consume exactly
those parameters: consuming an unsupported parameter means that requests
including that parameter will be rejected, whereas failing to consume a
supported parameter means that this parameter has no effect and should
be removed.

This commit adds an assertion to verify that we are consuming the
correct parameters.

Closes #113854

* CI poke
matthewabbott pushed a commit to matthewabbott/elasticsearch that referenced this pull request Oct 10, 2024
REST APIs which declare their supported parameters must consume exactly
those parameters: consuming an unsupported parameter means that requests
including that parameter will be rejected, whereas failing to consume a
supported parameter means that this parameter has no effect and should
be removed.

This commit adds an assertion to verify that we are consuming the
correct parameters.

Closes elastic#113854
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Core/Infra/REST API REST infrastructure and utilities Team:Core/Infra Meta label for core/infra team >test Issues or PRs that are addressing/adding tests test-release Trigger CI checks against release build v8.16.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Forbid consumption of unsupported query params
3 participants