Improve changes feed API documentation #4950
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
* Remove redundant mention of `_changes resource` since it's already
describing that resource.
* Explicitly enumerate all `filter` parameter options with references to doc
section below for each.
* Explain the unexpected interaction between ``include_docs``, ``all_docs``
style and filtering, how the winning document body is returned even if it
doesn't pass the filtering criteria.
* Update `POST _changes` doc to say that besides `doc_ids` it is used for
selector filtering. Also, add an example of using a selector.
jiahuili430
approved these changes
Jan 5, 2024
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.
Remove redundant mention of
_changes resourcesince it's already describing that resource.Explicitly enumerate all
filterparameter options with references to doc section below for each.Explain the unexpected interaction between
include_docs,all_docsstyle and filtering, how the winning document body is returned even if it doesn't pass the filtering criteria.Update
POST _changesdoc to say that besidesdoc_idsit is used for selector filtering. Also, add an example of using a selector.