work.sequential.series

sequential.work

Documentation

A comic series.

main record

A comic series.

Record Key tid Timestamp-based ID

Properties

banner blob Required

The banner image of the series. 3:1 aspect ratio. (e.g. 3000x1000 pixels)

maxSize: 4.2 MB
categories array of ref work.sequential.defs#category Required

Categories for this series, most relevant first.

maxLength: 3 itemsminLength: 1 items
chapters array of string at-uri Optional

Ordered list of chapters in this series. Not used by the 'strip' format. Use the DID form (at://did:...), not a handle.

maxLength: 5000 items
createdAt string datetime Required

The date and time the series was created.

description array of ref #localizedDescription Required

Localized short description of the series.

maxLength: 100 itemsminLength: 1 items
format string Required

The reading format of the series. 'vertical' chapters are made of slices; 'page' chapters are made of pages. 'strip' series have no chapters; their strips point to the series directly. AppViews may define their own formats.

Known values: vertical, page, strip
labels union Optional

Self-labels and content warnings for this series. Use the standard AT Protocol values ('porn', 'sexual', 'nudity', 'graphic-media') where they apply. AppViews may define additional values (e.g. 'profanity', 'violence'); AppViews that don't recognize a value ignore it.

Known types:
nativeLanguage string language Optional

BCP-47 language tag of the language the series was created in. AppViews should fall back to it when a reader's language isn't available.

poster blob Required

The open graph share image of the series. 1.91:1 aspect ratio. (e.g. 1200x630 pixels) JPEG or PNG only, because many link preview crawlers don't support newer formats.

maxSize: 4.2 MB
readingDirection string Optional

Horizontal reading direction of panels and pages. 'rtl' for right-to-left comics such as manga.

Known values: ltr, rtl
Default: ltr
status string Optional

Publication status of the series. AppViews may define their own statuses.

Known values: ongoing, completed, hiatus, cancelled
Default: ongoing
View raw schema 
{
  "description": "A comic series.",
  "key": "tid",
  "record": {
    "properties": {
      "banner": {
        "accept": [
          "image/jpeg",
          "image/png",
          "image/webp",
          "image/avif"
        ],
        "description": "The banner image of the series. 3:1 aspect ratio. (e.g. 3000x1000 pixels)",
        "maxSize": 4194304,
        "type": "blob"
      },
      "categories": {
        "description": "Categories for this series, most relevant first.",
        "items": {
          "ref": "work.sequential.defs#category",
          "type": "ref"
        },
        "maxLength": 3,
        "minLength": 1,
        "type": "array"
      },
      "chapters": {
        "description": "Ordered list of chapters in this series. Not used by the 'strip' format. Use the DID form (at://did:...), not a handle.",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 5000,
        "type": "array"
      },
      "createdAt": {
        "description": "The date and time the series was created.",
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "description": "Localized short description of the series.",
        "items": {
          "ref": "#localizedDescription",
          "type": "ref"
        },
        "maxLength": 100,
        "minLength": 1,
        "type": "array"
      },
      "format": {
        "description": "The reading format of the series. 'vertical' chapters are made of slices; 'page' chapters are made of pages. 'strip' series have no chapters; their strips point to the series directly. AppViews may define their own formats.",
        "knownValues": [
          "vertical",
          "page",
          "strip"
        ],
        "type": "string"
      },
      "labels": {
        "description": "Self-labels and content warnings for this series. Use the standard AT Protocol values ('porn', 'sexual', 'nudity', 'graphic-media') where they apply. AppViews may define additional values (e.g. 'profanity', 'violence'); AppViews that don't recognize a value ignore it.",
        "refs": [
          "com.atproto.label.defs#selfLabels"
        ],
        "type": "union"
      },
      "nativeLanguage": {
        "description": "BCP-47 language tag of the language the series was created in. AppViews should fall back to it when a reader's language isn't available.",
        "format": "language",
        "type": "string"
      },
      "poster": {
        "accept": [
          "image/jpeg",
          "image/png"
        ],
        "description": "The open graph share image of the series. 1.91:1 aspect ratio. (e.g. 1200x630 pixels) JPEG or PNG only, because many link preview crawlers don't support newer formats.",
        "maxSize": 4194304,
        "type": "blob"
      },
      "readingDirection": {
        "default": "ltr",
        "description": "Horizontal reading direction of panels and pages. 'rtl' for right-to-left comics such as manga.",
        "knownValues": [
          "ltr",
          "rtl"
        ],
        "type": "string"
      },
      "status": {
        "default": "ongoing",
        "description": "Publication status of the series. AppViews may define their own statuses.",
        "knownValues": [
          "ongoing",
          "completed",
          "hiatus",
          "cancelled"
        ],
        "type": "string"
      },
      "title": {
        "description": "Localized title of the series.",
        "items": {
          "ref": "work.sequential.defs#localizedTitle",
          "type": "ref"
        },
        "maxLength": 100,
        "minLength": 1,
        "type": "array"
      }
    },
    "required": [
      "title",
      "banner",
      "poster",
      "description",
      "createdAt",
      "categories",
      "format"
    ],
    "type": "object"
  },
  "type": "record"
}
localizedDescription object

Same as work.sequential.defs#localizedDescription, but limited to a short blurb.

Properties

lang string language Required

BCP-47 language tag for this description.

text string Required

No description available.

maxLength: 2550 bytesmaxGraphemes: 255 graphemes
View raw schema 
{
  "description": "Same as work.sequential.defs#localizedDescription, but limited to a short blurb.",
  "properties": {
    "lang": {
      "description": "BCP-47 language tag for this description.",
      "format": "language",
      "type": "string"
    },
    "text": {
      "maxGraphemes": 255,
      "maxLength": 2550,
      "type": "string"
    }
  },
  "required": [
    "lang",
    "text"
  ],
  "type": "object"
}

Lexicon Garden

@