Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation for Join Condition Query Strings #67

Merged
merged 15 commits into from
Dec 6, 2024

Conversation

ZaidMaslouhi
Copy link

Issue Description

The documentation for join conditions in query strings was unclear, leading to potential confusion for users.

Changes

  • Updated documentation to clarify the correct query string format for join conditions
  • Added example showing the recommended syntax with square brackets
  • Highlighted the preferred method of using join[] in query strings

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

@zaro
Copy link
Member

zaro commented Dec 6, 2024

@ZaidMaslouhi thanks for the clarification

@zaro zaro merged commit 98d6532 into gid-oss:master Dec 6, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants