buzz.bookhive.getBook

{
  "description": "Get a book's info. Does not require authentication.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "activity": {
          "description": "Other users' activity on the book",
          "items": {
            "ref": "buzz.bookhive.defs#activity",
            "type": "ref"
          },
          "type": "array"
        },
        "book": {
          "description": "The hive book's info",
          "ref": "buzz.bookhive.hiveBook#main",
          "type": "ref"
        },
        "bookProgress": {
          "description": "Reading progress for the user",
          "ref": "buzz.bookhive.defs#bookProgress",
          "type": "ref"
        },
        "comments": {
          "description": "Comments on the book",
          "items": {
            "ref": "buzz.bookhive.defs#comment",
            "type": "ref"
          },
          "type": "array"
        },
        "cover": {
          "accept": [
            "image/png",
            "image/jpeg"
          ],
          "description": "Cover image of the book",
          "maxSize": 1000000,
          "type": "blob"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "finishedAt": {
          "description": "The date the user finished reading the book",
          "format": "datetime",
          "type": "string"
        },
        "owned": {
          "description": "Whether the user owns this book",
          "type": "boolean"
        },
        "review": {
          "description": "The book's review",
          "maxGraphemes": 15000,
          "type": "string"
        },
        "reviews": {
          "description": "Reviews of the book",
          "items": {
            "ref": "buzz.bookhive.defs#review",
            "type": "ref"
          },
          "type": "array"
        },
        "stars": {
          "description": "Number of stars given to the book (1-10) which will be mapped to 1-5 stars",
          "maximum": 10,
          "minimum": 1,
          "type": "integer"
        },
        "startedAt": {
          "description": "The date the user started reading the book",
          "format": "datetime",
          "type": "string"
        },
        "status": {
          "knownValues": [
            "buzz.bookhive.defs#finished",
            "buzz.bookhive.defs#reading",
            "buzz.bookhive.defs#wantToRead",
            "buzz.bookhive.defs#abandoned"
          ],
          "type": "string"
        }
      },
      "required": [
        "book",
        "reviews",
        "comments"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "goodreadsId": {
        "description": "The Goodreads identifier for the book",
        "type": "string"
      },
      "id": {
        "description": "The book's hive ID",
        "type": "string"
      },
      "isbn10": {
        "description": "The book ISBN-10 identifier",
        "type": "string"
      },
      "isbn13": {
        "description": "The book ISBN-13 identifier",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}