Public: anyone can read this; 1 person and the crew can change it.

API

What the app describes at /openapi.json, read live.

9 operations in 3 areas

api 7

  • GET /api/audit The audit trail, newest first; `before` pages back by id.

    Parameters

    limitqueryinteger
    beforequeryinteger

    200 The audit trail, newest first; `before` pages back by id.

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring
  • GET /api/audit/{id} One row of the audit trail.

    Parameters

    idpathintegerrequired

    200 One row of the audit trail.

    Fields

    idintegerrequired
    atstringrequired
    who_idstring | null
    who_namestring | null
    roleenum(anon, user, admin)required
    resourcestringrequired
    verbstringrequired
    targetstring | null
    allowedenum(0, 1)required
    outcomestringrequired

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring
  • GET /api/notes The notes, newest first.

    Parameters

    limitqueryinteger

    200 The notes, newest first.

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring
  • POST /api/notes Add a note as the person asking.

    Body

    bodystringrequired

    201 Add a note as the person asking.

    Fields

    idintegerrequired
    bodystringrequired
    author_idstringrequired
    author_namestringrequired
    created_atstringrequired
    updated_atstringrequired

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring
  • GET /api/notes/{id} One note.

    Parameters

    idpathintegerrequired

    200 One note.

    Fields

    idintegerrequired
    bodystringrequired
    author_idstringrequired
    author_namestringrequired
    created_atstringrequired
    updated_atstringrequired

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring
  • DELETE /api/notes/{id} Remove a note.

    Parameters

    idpathintegerrequired

    200 Remove a note.

    Fields

    idintegerrequired

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring
  • PATCH /api/notes/{id} Change a note's words.

    Parameters

    idpathintegerrequired

    Body

    bodystringrequired

    200 Change a note's words.

    Fields

    idintegerrequired
    bodystringrequired
    author_idstringrequired
    author_namestringrequired
    created_atstringrequired
    updated_atstringrequired

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring

healthz 1

  • GET /healthz Whether the app is up: its version, commit, environment and seconds since it started.

    200 Whether the app is up: its version, commit, environment and seconds since it started.

    Fields

    okbooleanrequired
    versionstringrequired
    commitstring
    envstring
    uptimeintegerrequired

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring

mcp 1

  • POST /mcp One JSON-RPC 2.0 message to the MCP server; its tools are the actions.

    Body

    jsonrpcanyrequired
    idany
    methodstringrequired
    paramsobject

    200 One JSON-RPC 2.0 message to the MCP server; its tools are the actions.

    default { error, message }: why not

    Fields

    errorstringrequired
    messagestring
↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs