Skip to content

Document the table → automatic REST endpoint mapping (and rest: true requirement) #538

Description

@Ethan-Arrowood

Gap

The schema reference documents @table, @export, and the field/type directives well, but there is no canonical, atomic section that maps a defined-and-exported table to the automatic REST endpoints it produces (GET /{Table}, GET /{Table}/{id}, POST /{Table}, PUT /{Table}/{id}, PATCH, DELETE, etc.), nor one that states the rest: true config requirement to enable them. This information is currently scattered across the schema and REST docs.

Impact

The @harperfast/skills rule adding-tables-with-schemas cannot be migrated from hand-authored to docs-generated because its distinctive content (the table → endpoint surface + rest: true gotcha) has no atomic doc home to source from.

Suggested fix

Add a "Tables and their automatic endpoints" section (in reference/v5/rest/overview.md or reference/v5/database/schema.md) enumerating the generated endpoints for an exported table and the rest: true requirement.

Filed while auditing rule/doc coverage for @harperfast/skills. sent with Claude Opus 4.8

Metadata

Metadata

Assignees

No one assigned

    Labels

    content📝 Content specific issues and requests - text, examples, missing info, or clarity

    Type

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions