weaver / lexicons / notebook / getEntryByTitle.json

{
  "lexicon": 1,
  "id": "sh.weaver.notebook.getEntryByTitle",
  "defs": {
    "main": {
      "type": "query",
      "description": "Get an entry view by notebook URI and title. Matches on either the entry's path or title field.",
      "parameters": {
        "type": "params",
        "required": ["notebook", "title"],
        "properties": {
          "notebook": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of the notebook containing the entry."
          },
          "title": {
            "type": "string",
            "maxLength": 300,
            "description": "Title or path of the entry to fetch."
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": ["entry", "record"],
          "properties": {
            "entry": {
              "type": "ref",
              "ref": "sh.weaver.notebook.defs#bookEntryView"
            },
            "record": {
              "type": "unknown",
              "description": "The raw entry record data."
            }
          }
        }
      },
      "errors": [
        { "name": "NotebookNotFound" },
        { "name": "EntryNotFound" }
      ]
    }
  }
}