org.shelfcheck.defs

nowell.strite.org

Documentation

abandoned token

The user started but did not finish, and has stopped.

Referenceorg.shelfcheck.defs#abandoned

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "type": "token",
  "description": "The user started but did not finish, and has stopped."
}
authorRef object

Structured reference to an author of a book.

Properties

name string Required

No description available.

maxLength: 256 bytes
olAuthorKey string Optional

Open Library author key, e.g. 'OL23919A'.

maxLength: 64 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 256
    },
    "olAuthorKey": {
      "type": "string",
      "maxLength": 64,
      "description": "Open Library author key, e.g. 'OL23919A'."
    }
  },
  "description": "Structured reference to an author of a book."
}
bookIds object

Identifiers correlating a book across catalogs. At least one identifier should be present, with olWorkId preferred.

Properties

goodreadsId string Optional

No description available.

maxLength: 64 bytes
hiveId string Optional

BookHive canonical book id, present when imported from a buzz.bookhive.book record.

maxLength: 64 bytes
isbn10 string Optional

No description available.

maxLength: 13 bytes
isbn13 string Optional

No description available.

maxLength: 17 bytes
olWorkId string Optional

Open Library Work ID, e.g. 'OL45883W'. Edition-independent. Primary correlation key.

maxLength: 64 bytes
View raw schema 
{
  "type": "object",
  "properties": {
    "hiveId": {
      "type": "string",
      "maxLength": 64,
      "description": "BookHive canonical book id, present when imported from a buzz.bookhive.book record."
    },
    "isbn10": {
      "type": "string",
      "maxLength": 13
    },
    "isbn13": {
      "type": "string",
      "maxLength": 17
    },
    "olWorkId": {
      "type": "string",
      "maxLength": 64,
      "description": "Open Library Work ID, e.g. 'OL45883W'. Edition-independent. Primary correlation key."
    },
    "goodreadsId": {
      "type": "string",
      "maxLength": 64
    }
  },
  "description": "Identifiers correlating a book across catalogs. At least one identifier should be present, with olWorkId preferred."
}
finished token

The user has finished reading this book.

Referenceorg.shelfcheck.defs#finished

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "type": "token",
  "description": "The user has finished reading this book."
}
reading token

The user is currently reading this book.

Referenceorg.shelfcheck.defs#reading

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "type": "token",
  "description": "The user is currently reading this book."
}
wantToRead token

The user wants to read this book.

Referenceorg.shelfcheck.defs#wantToRead

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "type": "token",
  "description": "The user wants to read this book."
}

Lexicon Garden

@