net.olamaelcu.livtet.biblio.listBooksOnShelf
List the books on a given shelf: its bookStatus rows and its shelfItem memberships, newest first.
Details · query
| Kind | query |
|---|---|
| Authority | biblio.livtet.olamaelcu.net |
| Commit rev | 3n2ctwqtcqlgi |
| Indexed |
Checks
Validmissing-primary-descriptiondefs.mainThe query has no description.unlimited-stringdefs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"errors": [
{
"description": "No shelf record exists at the given AT-URI.",
"name": "NotFound"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"bookShelves": {
"items": {
"refs": [
"net.olamaelcu.livtet.biblio.defs#bookShelfView",
"net.olamaelcu.livtet.biblio.defs#shelfItemView"
],
"type": "union"
},
"type": "array"
},
"cursor": {
"type": "string"
}
},
"required": [
"bookShelves"
],
"type": "object"
}
},
"parameters": {
"properties": {
"cursor": {
"description": "Opaque pagination cursor.",
"type": "string"
},
"limit": {
"default": 50,
"description": "Maximum number of shelf entries to return.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"shelf": {
"description": "AT-URI of the shelf to list books for.",
"format": "at-uri",
"type": "string"
}
},
"required": [
"shelf"
],
"type": "params"
},
"type": "query"
}
},
"description": "List the books on a given shelf: its bookStatus rows and its shelfItem memberships, newest first.",
"id": "net.olamaelcu.livtet.biblio.listBooksOnShelf",
"lexicon": 1
}