buzz.bookhive.searchBooks

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Find books matching the search criteria. Does not require authentication.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "books": {
              "items": {
                "ref": "buzz.bookhive.hiveBook#main",
                "type": "ref"
              },
              "type": "array"
            },
            "offset": {
              "description": "The next offset to use for pagination (result of limit + offset)",
              "type": "integer"
            },
            "userStatuses": {
              "description": "Map of hiveId to the current user's reading status for that book. Only present when authenticated.",
              "type": "unknown"
            }
          },
          "required": [
            "books"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "genre": {
            "description": "Filter by genre. Returns books in that genre. Can be used with or without q.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the book within the hive.",
            "type": "string"
          },
          "limit": {
            "default": 25,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "offset": {
            "description": "Offset for pagination into the result set",
            "type": "integer"
          },
          "q": {
            "description": "Search query string. Will be matched against title and authors fields.",
            "type": "string"
          }
        },
        "required": [],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "buzz.bookhive.searchBooks",
  "lexicon": 1
}