Skip to content

API Reference

All endpoints, server actions, or API surface for this project.

Endpoints / Actions

{{Resource Name}}

Method / Action Path / Signature Description Auth
{{GET / action}} {{/items or getItems()}} {{List items}} {{Yes/No}}
{{POST / action}} {{/items or createItem()}} {{Create item}} {{Yes/No}}
{{GET / action}} {{/items/:id or getItem(id)}} {{Get single item}} {{Yes/No}}

{{Resource Name}}

Method / Action Path / Signature Description Auth
{{Method}} {{Path}} {{Description}} {{Yes/No}}

Error Handling

{{Describe error return pattern: thrown exceptions, error objects, HTTP codes, etc.}}

// Example error pattern
{{code example}}
  • {{@docs/data-model.md — data model backing these endpoints}}
  • {{@docs/auth.md — authentication and authorization rules}}
  • {{@docs/architecture.md — system overview}}