community.lexicon.media.book.defs

Shared book definitions: identifiers, contributors, publishers, editions, edition references, and result pages. New edition metadata fields should follow the corresponding names, meaning, and shape in https://schema.org/Book, including inherited properties; document any adaptations or extensions.

Details · defs
Kinddefs
Authoritybook.media.lexicon.community
Commit rev3n2h5svktw32w
Indexed

#contributor

object

Someone who contributed to the work or edition in some capacity.

Properties

displayName

requiredstring

The contributor's name as it should be displayed, preserving the supplied name order. Used for display and human disambiguation; identifiers are the matching mechanism.

  • minLength: 1

Identifiers denoting this contributor in global or provider namespaces, compared exactly by issuer and value.

Optional name in filing or sorting order, when known, such as Le Guin, Ursula K. May be identical to displayName where the name is already in that order. Consumers should not infer this field by rearranging displayName.

  • minLength: 1

ref

string · at-uri

Optional enrichment reference. The target record type is deliberately unspecified; resolving it is never required for display.

role

string

Nature of the contribution, stored as an ONIX Codelist 17 code. The code-to-role mapping is at https://ns.editeur.org/onix/en/17. For example, A01 means author, B06 translator, and E03 narrator. Known values include all 124 codes from Issue 75. If omitted, A01 (author) is assumed. Additional values remain permitted.

  • default: "A01"
  • knownValues: A01 | A02 | A03 | A04 | A05 | A06 | A07 | A08 | A09 | A10 | A11 | A12 | A13 | A14 | A15 | A16 | A17 | A18 | A19 | A20 | A21 | A22 | A23 | A24 | A25 | A26 | A27 | A28 | A29 | A30 | A31 | A32 | A33 | A34 | A35 | A36 | A37 | A38 | A39 | A40 | A41 | A42 | A43 | A44 | A45 | A46 | A47 | A48 | A49 | A50 | A51 | A52 | A56 | A99 | B01 | B02 | B03 | B04 | B05 | B06 | B07 | B08 | B09 | B10 | B11 | B12 | B13 | B14 | B15 | B16 | B17 | B18 | B19 | B20 | B21 | B22 | B23 | B24 | B25 | B26 | B27 | B28 | B29 | B30 | B31 | B32 | B33 | B34 | B35 | B36 | B99 | C01 | C02 | C03 | C04 | C99 | D01 | D02 | D03 | D04 | D99 | E01 | E02 | E03 | E04 | E05 | E06 | E07 | E08 | E09 | E10 | E11 | E99 | F01 | F02 | F99 | Z01 | Z02 | Z03 | Z04 | Z05 | Z06 | Z98 | Z99

#edition

object

Full edition metadata for books, including comic books and graphic novels, for embedding and optional repository publication. Provider APIs use editionView, which carries covers as URLs only.

Properties

Edition statement, such as 2nd revised or Abridged.

chapters

integer

Total chapter count, when known. This is an extent, not the reader's progress or a table of contents.

  • minimum: 0

contributors

requiredarray

Contributors credited on the edition. May be empty for anonymous or unknown contributions.

cover

blob

Optional cover image, strongly recommended when storing in a repository. The blob must belong to the repository containing the record, including when embedded in a review. May coexist with coverUrl.

  • accept: image/*

coverUrl

string · uri

Optional cover image URL, useful for API responses and providers without repository storage. May coexist with cover; a URL alone does not preserve image bytes in the user's repository.

createdAt

requiredstring · datetime

Time this edition record or snapshot was created, not its publication date.

Description of the edition.

Total audio duration in whole seconds, when known.

  • minimum: 0

format

string

Medium of the edition. Additional values are permitted; clients should provide a fallback for unrecognized formats.

  • knownValues: physical | ebook | audio

identifiers

requiredarray

Known identifiers for this edition, including provider grouping identifiers. Include the writing provider's identifier where available.

  • minLength: 1

language

string · language

Language of the edition as a BCP 47 language tag.

pages

integer

Total page count for print or ebook editions, when known.

  • minimum: 0

Publication date in ISO 8601 format at its known precision: YYYY, YYYY-MM, or YYYY-MM-DD. Preserve available precision without inventing a month or day. Applications must validate the date; this is not a datetime.

  • minLength: 4
  • maxLength: 10

subtitle

string

Subtitle of the edition.

title

requiredstring

Title of the edition.

  • minLength: 1

#editionRef

object

A self-contained book reference for reviews and other records. Cover fields are optional.

Properties

contributors

requiredarray

Contributors credited on the edition. May be empty for anonymous or unknown contributions.

cover

blob

Optional cover image, strongly recommended when storing in a repository. The blob must belong to the repository containing the record, including when embedded in a review. May coexist with coverUrl.

  • accept: image/*

coverUrl

string · uri

Optional cover image URL, useful for API responses and providers without repository storage. May coexist with cover; a URL alone does not preserve image bytes in the user's repository.

identifiers

requiredarray

Known identifiers for this edition, including provider grouping identifiers. Include the writing provider's identifier where available.

  • minLength: 1

title

requiredstring

Title of the edition.

  • minLength: 1

#editionResults

object

Shared response envelope for search and single-book resolution.

Properties

hasMore

requiredboolean

Whether more matching editions remain after this page. Must be false for an empty page.

items

requiredarray

Full edition views in provider-defined relevance order, with URL-only covers. Preserve known identifiers, including the provider's identifiers; do not reduce them to only those supplied in the request.

total

integer

Optional total number of matching editions before pagination, not the size of this page. Omit if not known.

  • minimum: 0

#editionView

object

Full edition metadata for books, including comic books and graphic novels, in API responses. Covers are represented only by optional coverUrl; providers omit cover and coverDid. The URL may point to a blob download endpoint.

Properties

Edition statement, such as 2nd revised or Abridged.

chapters

integer

Total chapter count, when known. This is an extent, not the reader's progress or a table of contents.

  • minimum: 0

contributors

requiredarray

Contributors credited on the edition. May be empty for anonymous or unknown contributions.

coverUrl

string · uri

Optional directly retrievable cover image URL. May point to a CDN, image service, or a blob download endpoint including the repository and blob identifiers needed to fetch it. No separate cover or coverDid is supplied.

createdAt

requiredstring · datetime

Time this edition record or snapshot was created, not its publication date.

Description of the edition.

Total audio duration in whole seconds, when known.

  • minimum: 0

format

string

Medium of the edition. Additional values are permitted; clients should provide a fallback for unrecognized formats.

  • knownValues: physical | ebook | audio

identifiers

requiredarray

Known identifiers for this edition, including provider grouping identifiers. Include the writing provider's identifier where available.

  • minLength: 1

language

string · language

Language of the edition as a BCP 47 language tag.

pages

integer

Total page count for print or ebook editions, when known.

  • minimum: 0

Publication date in ISO 8601 format at its known precision: YYYY, YYYY-MM, or YYYY-MM-DD. Preserve available precision without inventing a month or day. Applications must validate the date; this is not a datetime.

  • minLength: 4
  • maxLength: 10

subtitle

string

Subtitle of the edition.

title

requiredstring

Title of the edition.

  • minLength: 1

#identifier

object

A global or provider-scoped identifier. Shared provider identifiers may express that provider's grouping of editions.

Properties

issuer

requiredstring

Identifier namespace: a well-known global scheme token or a provider domain. Providers may use subdomains to distinguish namespaces. Compare this string exactly. Writers use lowercase global tokens and lowercase ASCII provider domains (IDNA A-labels for internationalized domains), without a scheme, path, or trailing dot.

  • minLength: 1
  • knownValues: isbn13 | issn | doi | asin | oclc | lccn

url

string · uri

Optional canonical URL within the namespace, for display and reference only; never part of identifier comparison.

value

requiredstring

Opaque identifier in its namespace's canonical form, defined in the proposal's identifier writing table. For isbn13, write hyphenless ISBN-13, converting ISBN-10 on write. Matching compares issuer and value exactly without parsing or normalization.

  • minLength: 1

#publisher

object

The organization that published the edition.

Properties

Identifiers denoting this publisher in global or provider namespaces, compared exactly by issuer and value.

name

requiredstring

Publisher name.

  • minLength: 1

#series

object

Name of the series and the edition's placement within it.

Properties

display

string

Human-readable position label preserving forms such as Vol. VI.

  • minLength: 1

name

requiredstring

Name of the series.

  • minLength: 1

position

string

Numeric position within the series, stored as a decimal string such as 6, 1.5, or 0.5. Sort numerically, not lexicographically. Applications must validate the numeric representation.

  • minLength: 1

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • A specific published instance of a book, including comic books and graphic novels, such as one printing, translation, or audiobook production. Not a work: distinct editions of the same underlying text are distinct records. New metadata fields should follow the corresponding names, meaning, and shape in https://schema.org/Book, including inherited properties; document any adaptations or extensions.

  • social.dracome.work.defs

    not from the namespace authority

    A single external identifier for a work or edition, such as an ISBN or an Open Library key.

  • An author-authoritative record of a published or forthcoming work, signed by the author's own repository.

  • A person credited on the work.

  • A submission record carrying candidate catalog data for an edition of a previously-submitted work, published by a trusted submitter to their own PDS. Repeatable; a submitter may create, update, or delete edition-submission records over time.