Expand docs for relational selects and conditions in search_by_conditions
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- databases, documentation
Research direction
Start with the operations-api search-by-conditions page and the reference/resources #select material named in the issue. Add a relational selects section with at least three end-to-end examples covering the requested relationship patterns, including input JSON and expected response shapes. Link the two pages so the relationship between the operation and select primitives is clear.
Written by the indexing model from the issue text.
Description
Expand documentation around how relational selects and conditions work for search_by_conditions. The current treatment is buried and not comprehensive.
Where docs live today
/docs/reference/resources#select— has the underlying primitives but is hard to find from operations-api context/docs/developers/operations-api/nosql-operations#search-by-conditions— lacks examples that show relational selects / cross-table conditions
Ask
- Add a "Relational selects with
search_by_conditions" section to the operations-api docs, with multiple worked examples (one-to-many, many-to-many, nested selects, conditions referencing related-table attributes). - Link the reference/resources
#selectmaterial from the operations-api page so the relationship between the two is obvious.
Acceptance criteria
- Operations-api
search-by-conditionspage contains a relational examples section with at least 3 worked end-to-end examples (input JSON, expected response shape). - Cross-links between the operations-api and reference/resources pages exist.
Tracked in Jira: CORE-3033
🤖 Filed by Claude on behalf of Kris.
- Dominant language
- MDX
- Stars
- 9
- Forks
- 9
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 30
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from HarperFast/documentation
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
HarperFast/documentation#677 ·
-
Difficulty 2/5 Half a day Newbie friendliness 88/100
HarperFast/documentation#675 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
HarperFast/documentation#665 ·
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
HarperFast/documentation#478 ·
-
content
Difficulty 1/5 Under an hour Newbie friendliness 76/100
HarperFast/documentation#399 · 2 comments ·
All issues in HarperFast/documentation
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
AstrBotDevs/AstrBot#10205 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OHDSI/Data2Evidence#3394 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100