Skip to content

[LFXV2-1443] docs: document filters, filters_all, and filters_or query params in README#42

Open
andrest50 wants to merge 2 commits into
mainfrom
andrest50/LFXV2-1443-readme-docs
Open

[LFXV2-1443] docs: document filters, filters_all, and filters_or query params in README#42
andrest50 wants to merge 2 commits into
mainfrom
andrest50/LFXV2-1443-readme-docs

Conversation

@andrest50

@andrest50 andrest50 commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the filters, filters_all, and filters_or query parameters in the Resource Search API section of the README, which were missing from the parameters list.

  • filters — AND logic exact field filters (field:value format, auto-prefixed with data.)
  • filters_all — explicit preferred alias for filters, same AND logic
  • filters_or — OR logic, at least one filter must match

Ticket

LFXV2-1443

…EADME

Generated with [Claude Code](https://claude.ai/claude-code)

Signed-off-by: Andres Tobon <andrest2455@gmail.com>
@andrest50 andrest50 requested a review from a team as a code owner April 9, 2026 18:36
Copilot AI review requested due to automatic review settings April 9, 2026 18:36
@coderabbitai

coderabbitai Bot commented Apr 9, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0f0d8e5a-23b5-4999-98da-57156eef6099

📥 Commits

Reviewing files that changed from the base of the PR and between c15e1ee and 3b0b297.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

Walkthrough

The GET /query/resources README was extended with three query parameters: filters (legacy AND), filters_all (preferred AND), and filters_or (OR). All accept field:value exact-match filters with fields auto-prefixed by data.; when filters and filters_all coexist, both sets apply with AND semantics.

Changes

Cohort / File(s) Summary
Query Parameters Documentation
README.md
Added docs for filters (legacy AND), filters_all (preferred AND equivalent), and filters_or (OR). All accept field:value exact-match format; fields are auto-prefixed with data.. If both filters and filters_all are provided, both are applied using AND; filters_or requires at least one match.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: documenting three query parameters in the README.
Description check ✅ Passed The description is directly related to the changeset, providing context about the three query parameters being documented and their semantics.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch andrest50/LFXV2-1443-readme-docs

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Resource Search API documentation to include the previously undocumented filters, filters_all, and filters_or query parameters so API consumers can discover and correctly use field-level filtering.

Changes:

  • Documented filters (AND), filters_all (preferred name for AND), and filters_or (OR) in the Resource Search API parameters list.
  • Clarified filter format (field:value) and that fields are auto-prefixed with data..

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Generated with [Claude Code](https://claude.ai/claude-code)

Signed-off-by: Andres Tobon <andrest2455@gmail.com>
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