Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
docs(api): describe the inbox-target route and the inbox fallback
Elian Doran79f4e4e11f77
diff --git a/apps/server/internal.openapi.yaml b/apps/server/internal.openapi.yamlindex 845b7aed45..cf06b36c08 100644--- a/apps/server/internal.openapi.yaml+++ b/apps/server/internal.openapi.yaml@@ -3137,6 +3137,36 @@ paths:schema:$ref: '#/components/schemas/Note'+ /api/special-notes/inbox-target:+ get:+ tags: [Special Notes]+ summary: Resolve where an inbox capture would go+ description: >+ Reports the destination `/api/special-notes/inbox/{date}` would use, without creating+ anything. Honours the hoisted note, read from the `trilium-hoisted-note-id` header.+ operationId: getInboxTarget+ responses:+ '200':+ description: The resolved destination+ content:+ application/json:+ schema:+ type: object+ required: [kind]+ properties:+ kind:+ type: string+ enum: [inbox, workspaceInbox, workspaceRoot, dayNote, root]+ description: >+ Which rule decided the destination. `dayNote` names no note, because the+ day note is created when the capture happens.+ noteId:+ type: string+ description: Absent for `dayNote`.+ title:+ type: string+ description: Absent for `dayNote`.+/api/special-notes/days/{date}:get:tags: [Special Notes]diff --git a/apps/server/src/assets/etapi.openapi.yaml b/apps/server/src/assets/etapi.openapi.yamlindex 7bb5bc2056..a0234c0f0a 100644--- a/apps/server/src/assets/etapi.openapi.yaml+++ b/apps/server/src/assets/etapi.openapi.yaml@@ -795,7 +795,8 @@ paths:get:description: >returns an "inbox" note, into which note can be created. Date will be used depending on whether the inbox- is a fixed note (identified with #inbox label) or a day note in a journal.+ is a fixed note (identified with #inbox label) or a day note in a journal. A database with neither+ returns the root note, and ignores the date, rather than creating a journal to hold a day note.operationId: getInboxNoteparameters:- name: date