cards.sunshine.draft

sunshine.cards

Documentation

A proposed set of Sunshine Cards, kept in its creator's deck for chosen reviewers to see before any card is made. The deck's owner always sees all of it.

main record

A proposed set of Sunshine Cards, kept in its creator's deck for chosen reviewers to see before any card is made. The deck's owner always sees all of it.

Record Key tid Timestamp-based ID

Properties

cards array of unknown Required

The proposed cards, in order, each a complete cards.sunshine.card record with every detail the real card will have. A card is known by its position. Each one's uid is 00000000000000, which can't name a real card because every NXP tag's UID starts with its manufacturer code, 0x04, and its counter is 0. A card's art lives only in the creator's deck until a real card is made from it.

maxLength: 500 items
createdAt string datetime Required

An RFC 3339 formatted timestamp.

explainer string Optional

A note to reviewers, in Markdown (CommonMark).

maxLength: 100000 bytesmaxGraphemes: 10000 graphemes
reviewers array of union Optional

Who else may see the draft, and which of its cards. Entries add together. Absent, only the deck's owner sees it.

maxLength: 500 items
Known types:
set unknown Required

The proposed set: a complete cards.sunshine.set record whose cards is empty.

View raw schema 
{
  "description": "A proposed set of Sunshine Cards, kept in its creator's deck for chosen reviewers to see before any card is made. The deck's owner always sees all of it.",
  "key": "tid",
  "record": {
    "properties": {
      "cards": {
        "description": "The proposed cards, in order, each a complete cards.sunshine.card record with every detail the real card will have. A card is known by its position. Each one's uid is 00000000000000, which can't name a real card because every NXP tag's UID starts with its manufacturer code, 0x04, and its counter is 0. A card's art lives only in the creator's deck until a real card is made from it.",
        "items": {
          "type": "unknown"
        },
        "maxLength": 500,
        "type": "array"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "explainer": {
        "description": "A note to reviewers, in Markdown (CommonMark).",
        "maxGraphemes": 10000,
        "maxLength": 100000,
        "type": "string"
      },
      "reviewers": {
        "description": "Who else may see the draft, and which of its cards. Entries add together. Absent, only the deck's owner sees it.",
        "items": {
          "refs": [
            "#didReviewer",
            "#recordPathReviewer"
          ],
          "type": "union"
        },
        "maxLength": 500,
        "type": "array"
      },
      "set": {
        "description": "The proposed set: a complete cards.sunshine.set record whose cards is empty.",
        "type": "unknown"
      }
    },
    "required": [
      "cards",
      "set",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}
didReviewer object

An account that may see every card.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema 
{
  "description": "An account that may see every card.",
  "properties": {
    "did": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "did"
  ],
  "type": "object"
}
recordPathReviewer object

Lets the accounts a card's own associated record names see that card. It applies to each card whose record's $type is type. Every value path yields from that record that is a DID may see the card; other values are ignored.

Properties

path string Required

A RecordPath (https://tangled.org/microcosm.blue/RecordPath) into the card's associated record, like productAccountDid or details.creators[]. A path that doesn't parse grants nothing.

maxLength: 1000 bytes
type string nsid Required

The $type of the cards' associated records.

View raw schema 
{
  "description": "Lets the accounts a card's own associated record names see that card. It applies to each card whose record's $type is type. Every value path yields from that record that is a DID may see the card; other values are ignored.",
  "properties": {
    "path": {
      "description": "A RecordPath (https://tangled.org/microcosm.blue/RecordPath) into the card's associated record, like productAccountDid or details.creators[]. A path that doesn't parse grants nothing.",
      "maxLength": 1000,
      "type": "string"
    },
    "type": {
      "description": "The $type of the cards' associated records.",
      "format": "nsid",
      "type": "string"
    }
  },
  "required": [
    "type",
    "path"
  ],
  "type": "object"
}

Lexicon Garden

@