Endpoint Config

endpoint maps schema operations to HTTP requests. Endpoint config can be a single string or an operation map.

Endpoint shapes

export const usersSchema = {
  resource: "users",
  endpoint: "/api/users"
} as const;

export const usersSchema = {
  resource: "users",
  endpoint: {
    list: { url: "/api/users", method: "GET" },
    detail: { url: "/api/users/:id", method: "GET" },
    create: { url: "/api/users", method: "POST" },
    update: { url: "/api/users/:id", method: "PATCH" },
    delete: { url: "/api/users/:id", method: "DELETE" },
    archive: { url: "/api/users/:id/archive", method: "POST" }
  }
} as const;

Endpoint object

Default methods

Identity placeholders

Endpoint placeholders are filled from identity.

export const usersSchema = {
  resource: "users",
  identity: {
    key: "uuid",
    param: "userId"
  },
  endpoint: {
    update: { url: "/api/users/:userId", method: "PATCH" }
  }
} as const;

For a row with { uuid: "u_123" }, the URL resolves to /api/users/u_123.

Query merge

Endpoint object query values are merged with runtime query values. Runtime values can override the same keys.

endpoint: {
  list: {
    url: "/api/users",
    method: "GET",
    query: {
      include: "role"
    }
  }
}

Request body

The built-in endpoint provider sends values as the request body for non-GET and non-DELETE methods. Objects are serialized as JSON unless a Content-Type header is already provided. FormData, Blob, and string bodies are handled separately.

Common mistakes

• Keep backend business logic on the backend. Endpoint schema should describe request wiring only.
• Unresolved placeholders are left as :param text in the URL.
• GET and DELETE requests do not receive a request body from the endpoint provider.