org.passingreads.book.registration

passingreads.org

Documentation

A book that has been registered on PassingReads

main record

A book that has been registered on PassingReads

Record Key any Any valid record key

Properties

authors array of string Required

Authors of this book, in order of credit. An empty array implies a book of anonymous or unknown authorship.

bookId string Required

The book's ID (as defined on its QR Code)

cover blob Optional

Cover image of the book

maxSize: 1.0 MB
occurredAt string datetime Required

An RFC 3339 formatted timestamp.

publicationId string Required

The book's Open Library Edition ID

title string Required

The title of the book

maxLength: 512 bytesminLength: 1 bytes
View raw schema
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "bookId",
      "title",
      "authors",
      "publicationId",
      "signatures",
      "occurredAt"
    ],
    "properties": {
      "cover": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg"
        ],
        "maxSize": 1000000,
        "description": "Cover image of the book"
      },
      "title": {
        "type": "string",
        "maxLength": 512,
        "minLength": 1,
        "description": "The title of the book"
      },
      "bookId": {
        "type": "string",
        "description": "The book's ID (as defined on its QR Code)"
      },
      "authors": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 512,
          "minLength": 1
        },
        "description": "Authors of this book, in order of credit. An empty array implies a book of anonymous or unknown authorship."
      },
      "occurredAt": {
        "type": "string",
        "format": "datetime"
      },
      "signatures": {
        "type": "array",
        "items": {
          "ref": "org.passingreads.signature.book#main",
          "type": "ref"
        },
        "minLength": 1,
        "description": "Inline attestations binding this record to the book's keypair."
      },
      "aspectRatio": {
        "ref": "org.passingreads.defs#aspectRatio",
        "type": "ref",
        "description": "Aspect ratio of the cover image"
      },
      "publicationId": {
        "type": "string",
        "description": "The book's Open Library Edition ID"
      }
    }
  },
  "description": "A book that has been registered on PassingReads"
}

Lexicon Garden

@