docs: deprecate some old filter parameters #9262
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dnephin
added
type/docs
dnephin
force-pushed
the
dnephin/docs-deprecate-old-filters
branch
from
62d87e5
to
ce3fe97
Compare
dnephin
changed the title
dnephin
force-pushed
the
dnephin/docs-deprecate-old-filters
branch
from
ce3fe97
to
597c848
Compare
The filtering can be done with the general purpose `filter` query parameter.
dnephin
force-pushed
the
dnephin/docs-deprecate-old-filters
branch
from
597c848
to
3415521
Compare
kyhavlov
approved these changes
Dec 15, 2020
|
🍒 If backport labels were added before merging, cherry-picking will start automatically. To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/299035. |
|
🍒✅ Cherry pick of commit c5b74fc onto |
hashicorp-ci
pushed a commit
that referenced
this pull request
Dec 15, 2020
…lters docs: deprecate some old filter parameters
|
🍒✅ Cherry pick of commit c5b74fc onto |
hashicorp-ci
pushed a commit
that referenced
this pull request
Dec 15, 2020
…lters docs: deprecate some old filter parameters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are a few HTTP API endpoints under Health and Catalog that have query parameters for filtering results on specific fields. This filtering can now be done with the
filterquery parameter, so we should deprecate the older parameters and remove them in a future version of Consul./health/state/:statehas anode-metaquery parameter, but that one can't be replaced byfilterbecause the response doesn't include the NodeMeta. The current implementation queries additional tables to get the metadata required for filtering.