pub.byline.defs

bylinepub.bsky.social

Documentation

contributor object

A person credited on the work.

Properties

did string did Optional

AT Protocol identity of the contributor, if any.

name string Required

No description available.

maxLength: 256 bytes
role string Optional

e.g. author, co-author, translator, editor, illustrator, narrator.

maxLength: 128 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "AT Protocol identity of the contributor, if any."
    },
    "name": {
      "type": "string",
      "maxLength": 256
    },
    "role": {
      "type": "string",
      "maxLength": 128,
      "description": "e.g. author, co-author, translator, editor, illustrator, narrator."
    }
  },
  "description": "A person credited on the work."
}
draft token

In progress, not announced.

Referencepub.byline.defs#draft

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

View raw schema 
{
  "type": "token",
  "description": "In progress, not announced."
}
edition object

A single published edition or format of the work.

Properties

durationMinutes integer Optional

Runtime for audiobook editions.

minimum: 1
fileFormats array of string Optional

File formats for a digital edition, e.g. epub, pdf, mobi, m4b.

format string Required

No description available.

Known values: hardcover, paperback, ebook, audiobook
isbn10 string Optional

No description available.

isbn13 string Optional

No description available.

pageCount integer Optional

No description available.

minimum: 1
publisher string Optional

No description available.

maxLength: 256 bytes
releaseDate string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema 
{
  "type": "object",
  "required": [
    "format"
  ],
  "properties": {
    "links": {
      "type": "array",
      "items": {
        "ref": "lex:pub.byline.defs#link",
        "type": "ref"
      },
      "description": "Buy or sample links specific to this edition."
    },
    "format": {
      "type": "string",
      "knownValues": [
        "hardcover",
        "paperback",
        "ebook",
        "audiobook"
      ]
    },
    "isbn10": {
      "type": "string"
    },
    "isbn13": {
      "type": "string"
    },
    "pageCount": {
      "type": "integer",
      "minimum": 1
    },
    "publisher": {
      "type": "string",
      "maxLength": 256
    },
    "fileFormats": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 32
      },
      "description": "File formats for a digital edition, e.g. epub, pdf, mobi, m4b."
    },
    "releaseDate": {
      "type": "string",
      "format": "datetime"
    },
    "durationMinutes": {
      "type": "integer",
      "minimum": 1,
      "description": "Runtime for audiobook editions."
    }
  },
  "description": "A single published edition or format of the work."
}
forthcoming token

Announced with a release date, not yet available.

Referencepub.byline.defs#forthcoming

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

View raw schema 
{
  "type": "token",
  "description": "Announced with a release date, not yet available."
}
identifiers object

External identifiers used to correlate this work across catalogues.

Properties

asin string Optional

No description available.

goodreadsId string Optional

No description available.

hiveBookUri string at-uri Optional

AT-URI of the canonical buzz.bookhive.catalogBook record, if one exists.

hiveId string Optional

BookHive internal id, for reader-app correlation.

isbn10 string Optional

No description available.

isbn13 string Optional

No description available.

View raw schema 
{
  "type": "object",
  "properties": {
    "asin": {
      "type": "string"
    },
    "hiveId": {
      "type": "string",
      "description": "BookHive internal id, for reader-app correlation."
    },
    "isbn10": {
      "type": "string"
    },
    "isbn13": {
      "type": "string"
    },
    "goodreadsId": {
      "type": "string"
    },
    "hiveBookUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the canonical buzz.bookhive.catalogBook record, if one exists."
    }
  },
  "description": "External identifiers used to correlate this work across catalogues."
}
link object

No description available.

Properties

isAffiliate boolean Optional

True when this is an affiliate link, for disclosure.

kind string Optional

No description available.

Known values: retailer, direct, universal, support, sample, review, author, publisher, discussion, social
label string Optional

No description available.

maxLength: 128 bytes
primary boolean Optional

Marks the preferred call-to-action link. At most one per book should set this.

retailer string Optional

Retailer name when kind is retailer, e.g. Smashwords.

url string uri Required

A valid URI.

View raw schema 
{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri"
    },
    "kind": {
      "type": "string",
      "knownValues": [
        "retailer",
        "direct",
        "universal",
        "support",
        "sample",
        "review",
        "author",
        "publisher",
        "discussion",
        "social"
      ]
    },
    "label": {
      "type": "string",
      "maxLength": 128
    },
    "primary": {
      "type": "boolean",
      "description": "Marks the preferred call-to-action link. At most one per book should set this."
    },
    "retailer": {
      "type": "string",
      "description": "Retailer name when kind is retailer, e.g. Smashwords."
    },
    "isAffiliate": {
      "type": "boolean",
      "description": "True when this is an affiliate link, for disclosure."
    }
  }
}
outOfPrint token

Previously published, no longer in print.

Referencepub.byline.defs#outOfPrint

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

View raw schema 
{
  "type": "token",
  "description": "Previously published, no longer in print."
}
published token

The work is published and available.

Referencepub.byline.defs#published

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

View raw schema 
{
  "type": "token",
  "description": "The work is published and available."
}
seriesMembership object

Series membership, if any. Book points at the series; the series record never points back.

Properties

name string Optional

Series name, denormalized for display.

maxLength: 256 bytes
position integer Optional

Reading order within the series.

minimum: 1
View raw schema 
{
  "type": "object",
  "properties": {
    "ref": {
      "ref": "lex:com.atproto.repo.strongRef",
      "type": "ref",
      "description": "strongRef to a pub.byline.series record."
    },
    "name": {
      "type": "string",
      "maxLength": 256,
      "description": "Series name, denormalized for display."
    },
    "position": {
      "type": "integer",
      "minimum": 1,
      "description": "Reading order within the series."
    }
  },
  "description": "Series membership, if any. Book points at the series; the series record never points back."
}

Lexicon Garden

@