Skip to content

docs: clarify query execution and permission boundaries - #33

Merged
nichenqin merged 4 commits into
mainfrom
docs/query-execution-guidance
Oct 24, 2026
Merged

nichenqin merged 4 commits into
mainfrom
docs/query-execution-guidance

Conversation

@nichenqin

Copy link
Copy Markdown
Contributor

What changes

  • Add a focused data-query decision guide for external Teable CLI users, linked from the main skill and CLI reference.
  • Keep released record/SQL entry points distinct from optional structured execution. Require evidence from both the installed CLI and the selected host before using a new capability.
  • Explain when inline definitions are preferable to saved references, explicit revision policies, performance tradeoffs, public versus trusted parameters, and query-resource versus data permissions.
  • Clarify that App login alone does not establish per-visitor data authorization.
  • Bump the skill documentation patch version to 1.10.1; retain the existing CLI minimum.

Availability boundary

The committed manifest and current npm release are both CLI 0.6.45 and do not expose a structured query command group. This PR deliberately adds no unreleased command invocation, invented endpoint, or replacement manifest. Existing released commands stay usable. Concrete new command help/schema should arrive through the existing publish → manifest → reviewed skill-sync workflow when that CLI capability is released; backend route activation is a separate prerequisite.

This is the public consumer skill, not a repository-local coding skill or managed-sandbox instruction.

Verification

  • node scripts/validate-cli-docs.mjs: 90 invocations across 38 Markdown files match the CLI 0.6.45 manifest.
  • Checked 53 relative links in the changed guidance/entry files; all resolve.
  • Ran the actual published CLI 0.6.45 help through npx; confirmed the supported discovery surface and absence of the new command group.

No credential changes, backend deployment, CLI publication, or generated API-reference mirror edits.

@nichenqin

Copy link
Copy Markdown
Contributor Author

Added in commit ac792f8: documented teable query inline for ephemeral development reads, clarified the canonical definition/parameter contract, separated named-query App runtime from legacy sql-query, and updated the CLI manifest snapshot so docs validation passes (node scripts/validate-cli-docs.mjs).

@nichenqin
nichenqin merged commit df55d57 into main Oct 24, 2026
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.

1 participant