docs: clarify query and embed examples#1756
Open
Omar-Tnt04 wants to merge 1 commit intotypicode:mainfrom
Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This Pull Request adds a few clarifications and examples to the README around query parameters and embedded relations.
Motivation
While working with the repo and checking the tests, I noticed that some query behaviors were not very obvious from the README, especially around reserved parameters and
_embed.I added a few examples and clarifications that would have helped me when I first used it.
Changes
_query parameters vs normal filters_page,_per_page)_embedexamples for both child and parent relationsTesting