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
kept boolean Optional

Whether the registrant is keeping the book. Absent means true, so records written before this field existed still read as kept. When false the book starts its journey at `location` rather than in the registrant's library.

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 
{
  "description": "A book that has been registered on PassingReads",
  "key": "any",
  "record": {
    "properties": {
      "aspectRatio": {
        "description": "Aspect ratio of the cover image",
        "ref": "org.passingreads.defs#aspectRatio",
        "type": "ref"
      },
      "authors": {
        "description": "Authors of this book, in order of credit. An empty array implies a book of anonymous or unknown authorship.",
        "items": {
          "maxLength": 512,
          "minLength": 1,
          "type": "string"
        },
        "type": "array"
      },
      "bookId": {
        "description": "The book's ID (as defined on its QR Code)",
        "type": "string"
      },
      "cover": {
        "accept": [
          "image/png",
          "image/jpeg"
        ],
        "description": "Cover image of the book",
        "maxSize": 1000000,
        "type": "blob"
      },
      "kept": {
        "description": "Whether the registrant is keeping the book. Absent means true, so records written before this field existed still read as kept. When false the book starts its journey at `location` rather than in the registrant's library.",
        "type": "boolean"
      },
      "location": {
        "description": "Where the book is at the moment it is registered.",
        "refs": [
          "community.lexicon.location.hthree#main",
          "org.passingreads.book.event#osmLocation"
        ],
        "type": "union"
      },
      "occurredAt": {
        "format": "datetime",
        "type": "string"
      },
      "publicationId": {
        "description": "The book's Open Library Edition ID",
        "type": "string"
      },
      "signatures": {
        "description": "Inline attestations binding this record to the book's keypair.",
        "items": {
          "ref": "org.passingreads.signature.book#main",
          "type": "ref"
        },
        "minLength": 1,
        "type": "array"
      },
      "title": {
        "description": "The title of the book",
        "maxLength": 512,
        "minLength": 1,
        "type": "string"
      }
    },
    "required": [
      "bookId",
      "title",
      "authors",
      "publicationId",
      "signatures",
      "occurredAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@