buzz.bookhive.listPersonalShelves

List the authenticated user's personal shelves with per-shelf book counts, plus library-wide totals and storage usage. This is the root call for a catalog client: it carries everything the OPDS root navigation feed renders, in one request. Unpaginated — `personal_shelf` is unique on (userDid, name) and these lists are small.

Repository @bookhive.buzz did:plc:enu2j5xjlqsjaylv3du4myh4 namespace authority
Details · query
Kindquery
Authoritybookhive.buzz
Commit rev3n2mntox7rs2e
Indexed
cid bafyreie6nsxrghoso4qk3hytgjihqsw375zly3ve7flnl5yghquv3zqg4m

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "List the authenticated user's personal shelves with per-shelf book counts, plus library-wide totals and storage usage. This is the root call for a catalog client: it carries everything the OPDS root navigation feed renders, in one request. Unpaginated — `personal_shelf` is unique on (userDid, name) and these lists are small.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "shelves": {
              "items": {
                "ref": "buzz.bookhive.createPersonalShelf#personalShelfView",
                "type": "ref"
              },
              "type": "array"
            },
            "storage": {
              "description": "This user's storage usage against their quota",
              "ref": "buzz.bookhive.getPersonalLibrary#storageView",
              "type": "ref"
            },
            "totalBooks": {
              "description": "Books in the library across all shelves and unshelved",
              "minimum": 0,
              "type": "integer"
            }
          },
          "required": [
            "shelves",
            "totalBooks"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "buzz.bookhive.listPersonalShelves",
  "lexicon": 1
}