Skip to content

docs: add query conditions reference to programmatic-table-requests skill#34

Merged
Ethan-Arrowood merged 2 commits into
mainfrom
worktree-docs+query-conditions
May 21, 2026
Merged

docs: add query conditions reference to programmatic-table-requests skill#34
Ethan-Arrowood merged 2 commits into
mainfrom
worktree-docs+query-conditions

Conversation

@Ethan-Arrowood
Copy link
Copy Markdown
Member

@Ethan-Arrowood Ethan-Arrowood commented May 14, 2026

Summary

  • Adds a Query Conditions section to programmatic-table-requests.md — the right home since conditions are only relevant when using the JS table API (search(), get(), subscribe()) inside custom resources
  • Documents the conditions array shape (attribute, value, comparator, operator, nested conditions)
  • Provides a reference table of all valid comparator strings (equals, not_equal, greater_than, greater_than_equal, less_than, less_than_equal, starts_with, contains, ends_with, between) — these differ from URL/FIQL syntax and must be exact
  • Documents top-level query object params (limit, offset, select, sort)
  • Includes annotated examples for simple filters, AND+OR nesting, relationship traversal, and sort+paginate
  • querying-rest-apis.md is unchanged (URL/FIQL syntax only)

Motivation

An agent failed to build working queries inside a custom resource because there was no reference for the programmatic conditions API. The comparator names (equals, greater_than, etc.) differ from URL/FIQL equivalents (eq, gt) and incorrect names silently fail.

Test plan

🤖 Generated with Claude Code

Ethan-Arrowood and others added 2 commits May 14, 2026 13:47
The skill only documented URL/FIQL query string syntax. Agents writing
custom resources had no reference for the programmatic conditions API,
including the exact comparator strings (equals, greater_than, etc.)
which differ from the FIQL equivalents and are critical for queries to
work at all.

Adds a full reference for the conditions object shape, all comparator
values, query object parameters, and annotated examples covering common
patterns (simple filter, AND+OR, relationship traversal, sort+paginate).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Conditions/comparators are only relevant when using the JS table API
(search, get, subscribe) — not URL queries. Moved the full conditions
reference (shape, comparator table, query params, examples) to
programmatic-table-requests.md and restored querying-rest-apis.md to
URL/FIQL-only content.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Ethan-Arrowood Ethan-Arrowood changed the title docs: add programmatic conditions API reference to querying skill docs: add query conditions reference to programmatic-table-requests skill May 14, 2026
| `less_than` | `<` |
| `less_than_equal` | `<=` |
| `starts_with` | String starts with value |
| `contains` | String contains value |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@kriszyp which ones do we want to flag as dangerous from a performance perspective?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

contains and ends_with are the ones that defeat any indexing.

Copy link
Copy Markdown
Member

@kriszyp kriszyp left a comment

Choose a reason for hiding this comment

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

You can merge, but this still falls into the category of things that I think the skills should really be pulling from documentation. I think @dawsontoth has been looking into a strategy for doing this in way that would allow us to really have the documentation be the canonical source of, well... documentation.

| `less_than` | `<` |
| `less_than_equal` | `<=` |
| `starts_with` | String starts with value |
| `contains` | String contains value |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

contains and ends_with are the ones that defeat any indexing.

@Ethan-Arrowood Ethan-Arrowood merged commit 1fc18ee into main May 21, 2026
3 checks passed
@Ethan-Arrowood Ethan-Arrowood deleted the worktree-docs+query-conditions branch May 21, 2026 18:18
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 1.4.7 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants