Lexicon Garden

buzz.bookhive.getList

Get a book list with its items and hydrated book metadata.

Repository @bookhive.buzz did:plc:enu2j5xjlqsjaylv3du4myh4 namespace authority
Details · query
Kindquery
Authoritybookhive.buzz
Indexed
Compare Edit in builder → Fork →
cid bafyreicb5zrtvemvdfqvozyoc6tmrwry4nhpjo77wwntmz3g6ilxjjvu7a

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "listItemView": {
      "properties": {
        "addedAt": {
          "format": "datetime",
          "type": "string"
        },
        "authors": {
          "type": "string"
        },
        "cover": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "hiveId": {
          "type": "string"
        },
        "position": {
          "type": "integer"
        },
        "rating": {
          "type": "integer"
        },
        "thumbnail": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "uri": {
          "type": "string"
        }
      },
      "required": [
        "uri",
        "addedAt"
      ],
      "type": "object"
    },
    "listView": {
      "properties": {
        "cid": {
          "type": "string"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "itemCount": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "ordered": {
          "type": "boolean"
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "uri": {
          "type": "string"
        },
        "userDid": {
          "type": "string"
        },
        "userHandle": {
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid",
        "userDid",
        "name",
        "createdAt"
      ],
      "type": "object"
    },
    "main": {
      "description": "Get a book list with its items and hydrated book metadata.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "items": {
              "items": {
                "ref": "#listItemView",
                "type": "ref"
              },
              "type": "array"
            },
            "list": {
              "ref": "#listView",
              "type": "ref"
            }
          },
          "required": [
            "list",
            "items"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "uri": {
            "description": "AT-URI of the list",
            "type": "string"
          }
        },
        "required": [
          "uri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "buzz.bookhive.getList",
  "lexicon": 1
}