buzz.bookhive.searchBooks

{
  "id": "buzz.bookhive.searchBooks",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "books"
          ],
          "properties": {
            "books": {
              "type": "array",
              "items": {
                "ref": "buzz.bookhive.hiveBook#record",
                "type": "ref"
              }
            },
            "offset": {
              "type": "integer",
              "description": "The next offset to use for pagination (result of limit + offset)"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "q"
        ],
        "properties": {
          "q": {
            "type": "string",
            "description": "Search query string. Will be matched against title and authors fields."
          },
          "id": {
            "type": "string",
            "description": "The ID of the book within the hive."
          },
          "limit": {
            "type": "integer",
            "default": 25,
            "maximum": 100,
            "minimum": 1
          },
          "offset": {
            "type": "integer",
            "description": "Offset for pagination into the result set"
          }
        }
      },
      "description": "Find books matching the search criteria. Requires authentication."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}