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)

bookPub bytes Optional

The MultiFormat public key of the book.

bookSig bytes Required

The MultiFormat signature of this record, without this attribute, as created by the private key associated with the book.

cover blob Optional

Cover image of the book

maxSize: 1.0 MB
did string did Required

The DID of the person who registered the book. Included here, so it's verifiable with the bookSig.

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": [
      "did",
      "bookId",
      "title",
      "authors",
      "publicationId",
      "occurredAt",
      "bookSig"
    ],
    "properties": {
      "did": {
        "type": "string",
        "format": "did",
        "description": "The DID of the person who registered the book. Included here, so it's verifiable with the bookSig."
      },
      "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."
      },
      "bookPub": {
        "type": "bytes",
        "description": "The MultiFormat public key of the book."
      },
      "bookSig": {
        "type": "bytes",
        "description": "The MultiFormat signature of this record, without this attribute, as created by the private key associated with the book."
      },
      "occurredAt": {
        "type": "string",
        "format": "datetime"
      },
      "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

@