docs: document rest: true config.yaml prerequisite for automatic REST APIs#33
Merged
Merged
Conversation
Agents were failing to debug missing REST endpoints because the docs didn't mention that `rest: true` must be set in `config.yaml` for `@export`ed tables to respond to HTTP requests. Added the requirement as the first step in automatic-apis.md and as a callout wherever `@table @export` is introduced. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
dawsontoth
approved these changes
May 21, 2026
| 3. **Use Automatic WebSockets**: Connect to `wss://your-harper-instance/{TableName}` to receive events whenever updates are made to that table. This is the easiest way to add real-time capabilities. (Use `ws://` for local development without SSL). For more complex needs, see [Real-time Apps](real-time-apps.md). | ||
| 4. **Apply Filtering and Querying**: Use query parameters with `GET /{TableName}/` and `DELETE /{TableName}/`. See the [Querying REST APIs](querying-rest-apis.md) skill for advanced details. | ||
| 5. **Customize if Needed**: If the automatic APIs don't meet your requirements, [customize the resources](./custom-resources.md). | ||
| 1. **Enable REST in `config.yaml`**: REST endpoints are **not active by default**. You must explicitly enable them: |
Contributor
There was a problem hiding this comment.
Depends on what you mean by default, https://github.com/HarperFast/create-harper/blob/main/template-react/config.yaml -- all of the core templates have it set to true.
|
🎉 This PR is included in version 1.4.5 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
rest: trueinconfig.yamlas step 1 inautomatic-apis.md, with a clear warning that@exported tables won't respond to HTTP requests without itadding-tables-with-schemas.md(where agents first encounter@table @export)AGENTS.mdMotivation
An agent using these skills failed to debug missing REST endpoints because the docs implied that adding
@table @exportto a schema was sufficient to enable REST — butrest: trueinconfig.yamlis also required. This change makes that prerequisite explicit and hard to miss.Test plan
automatic-apis.mdlistsrest: trueconfig as the first step before schema setupadding-tables-with-schemas.mdandAGENTS.mdboth call out theconfig.yamlrequirement alongside@table @export🤖 Generated with Claude Code