Update Documentation for Join Condition Query Strings #67
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.
Issue Description
The documentation for join conditions in query strings was unclear, leading to potential confusion for users.
Changes
Example
Before:
join=facilities||id,status||on[0]=facilities.status||$eq||Archived
After:
join[]=facilities||id,status||on[0]=facilities.status||$eq||Archived
Reasoning
The updated documentation now explicitly shows the recommended way to construct join condition query strings to ensure correct parsing.
Related Issue
Closes #53