Show the unstable params and improve collection docs #4085
Merged
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.
Fixes
Fixes #4080 by @obulat
Fixes #4081 by @obulat
Description
This PR makes all
unstable__
search parameters visible in the documentation and adds the warning about them being unstable.It also updates the collection parameters docs: uses a variable for parameter name to ensure that currently we only use
unstable__collection
andunstable__tag
in the documentation.Testing Instructions
Run the API and read the search endpoint documentation. All unstable fields should be displayed and have a warning. The collection params should have
unstable__
prefix.Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin