net.wireservice.draft

wireservice.net

Documentation

An unpublished or in-progress article, stored in the publication's private staff space and written by the publication's DID. On publish, the CMS writes a public site.standard.document; when space is set, it writes the full document into that space and a public net.wireservice.gatedContent stub instead.

main record

An unpublished or in-progress article, stored in the publication's private staff space and written by the publication's DID. On publish, the CMS writes a public site.standard.document; when space is set, it writes the full document into that space and a public net.wireservice.gatedContent stub instead.

Record Key tid Timestamp-based ID

Properties

assignees array of string did Optional

Staff DIDs currently responsible for the draft.

coverImage blob Optional

No description available.

maxSize: 1.0 MB
createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 30000 bytesmaxGraphemes: 3000 graphemes
document string at-uri Optional

AT URI of the published site.standard.document, once published. Edits to a published article are made on the draft and republished.

path string Optional

The slug that starts the article's URL, which ends with the document's record key (/<slug>-<rkey>). Defaults to one made from the title.

maxLength: 200 bytes
scheduledAt string datetime Optional

When the CMS should publish the draft. Required when status is 'scheduled'.

space string space-ref Optional

When set, the article is gated: its content is published into this space and the public document becomes a net.wireservice.gatedContent stub.

status string Required

No description available.

maxLength: 64 bytes
Known values: draft, inReview, approved, scheduled, published
tags array of string Optional

No description available.

title string Optional

No description available.

maxLength: 5000 bytesmaxGraphemes: 500 graphemes
updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema 
{
  "description": "An unpublished or in-progress article, stored in the publication's private staff space and written by the publication's DID. On publish, the CMS writes a public site.standard.document; when space is set, it writes the full document into that space and a public net.wireservice.gatedContent stub instead.",
  "key": "tid",
  "record": {
    "properties": {
      "assignees": {
        "description": "Staff DIDs currently responsible for the draft.",
        "items": {
          "format": "did",
          "type": "string"
        },
        "type": "array"
      },
      "content": {
        "description": "Article content as it will be published.",
        "ref": "net.wireservice.content",
        "type": "ref"
      },
      "contributors": {
        "items": {
          "ref": "site.standard.document#contributor",
          "type": "ref"
        },
        "type": "array"
      },
      "coverImage": {
        "accept": [
          "image/*"
        ],
        "maxSize": 1000000,
        "type": "blob"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "maxGraphemes": 3000,
        "maxLength": 30000,
        "type": "string"
      },
      "document": {
        "description": "AT URI of the published site.standard.document, once published. Edits to a published article are made on the draft and republished.",
        "format": "at-uri",
        "type": "string"
      },
      "path": {
        "description": "The slug that starts the article's URL, which ends with the document's record key (/<slug>-<rkey>). Defaults to one made from the title.",
        "maxLength": 200,
        "type": "string"
      },
      "scheduledAt": {
        "description": "When the CMS should publish the draft. Required when status is 'scheduled'.",
        "format": "datetime",
        "type": "string"
      },
      "space": {
        "description": "When set, the article is gated: its content is published into this space and the public document becomes a net.wireservice.gatedContent stub.",
        "format": "space-ref",
        "type": "string"
      },
      "status": {
        "knownValues": [
          "draft",
          "inReview",
          "approved",
          "scheduled",
          "published"
        ],
        "maxLength": 64,
        "type": "string"
      },
      "tags": {
        "items": {
          "maxGraphemes": 128,
          "maxLength": 1280,
          "type": "string"
        },
        "type": "array"
      },
      "title": {
        "maxGraphemes": 500,
        "maxLength": 5000,
        "type": "string"
      },
      "updatedAt": {
        "format": "datetime",
        "type": "string"
      }
    },
    "required": [
      "status",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@