us.polhem.skywrite.defs

Details · defs
Kinddefs
Authorityskywrite.polhem.us
Commit rev3n2vlwxkx5n2a
Indexed

Showing version bafyreighosydhwxohyrirp2njq4ft5htogudclskjp3i3ham3t6s2h6isa. Show the latest

cid bafyreighosydhwxohyrirp2njq4ft5htogudclskjp3i3ham3t6s2h6isa

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "customColumn": {
      "description": "A table column whose value is worked out for each record, like a preview field.",
      "properties": {
        "name": {
          "description": "The column's heading, and its name in tableColumnFields. Must differ from the collection's own fields.",
          "maxGraphemes": 64,
          "maxLength": 640,
          "minLength": 1,
          "type": "string"
        },
        "value": {
          "refs": [
            "#fieldPath",
            "#fieldTemplate",
            "#fieldParts"
          ],
          "type": "union"
        }
      },
      "required": [
        "name",
        "value"
      ],
      "type": "object"
    },
    "fieldParts": {
      "description": "A value computed by a chain of steps: each step receives the previous step's result, starting from the record.",
      "properties": {
        "parts": {
          "items": {
            "refs": [
              "#fieldPath",
              "#fieldTemplate"
            ],
            "type": "union"
          },
          "type": "array"
        }
      },
      "required": [
        "parts"
      ],
      "type": "object"
    },
    "fieldPath": {
      "description": "A value read from the input: a field path such as 'title' or 'subject.uri', or a lookup function: getRecord() (AT URI to record), describeRepo() (handle, DID, AT URI or record to its repo's DID and handle), getBskyProfile() (handle, DID, AT URI or record to that account's Bluesky profile record), getUri() (record to its AT URI) getRkey() (record to its record key) or getDef() (lexicon path such as 'community.lexicon.calendar.rsvp#going' to that definition's description). A blob read from a record becomes its URL.",
      "properties": {
        "path": {
          "description": "Field path or lookup function name.",
          "type": "string"
        }
      },
      "required": [
        "path"
      ],
      "type": "object"
    },
    "fieldTemplate": {
      "description": "A value rendered from a Mustache template. The template can use the record's fields, plus any variables defined in vars.",
      "properties": {
        "template": {
          "description": "Mustache template, such as '{{name}} ({{slug}})'.",
          "type": "string"
        },
        "vars": {
          "description": "Extra template variables, each computed from the record.",
          "items": {
            "ref": "#templateVar",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "template"
      ],
      "type": "object"
    },
    "previewFields": {
      "description": "Which parts of a record to show when previewing it in a list.",
      "properties": {
        "body": {
          "refs": [
            "#fieldPath",
            "#fieldTemplate",
            "#fieldParts"
          ],
          "type": "union"
        },
        "thumbnail": {
          "refs": [
            "#fieldPath",
            "#fieldTemplate",
            "#fieldParts"
          ],
          "type": "union"
        },
        "timestamp": {
          "refs": [
            "#fieldPath",
            "#fieldTemplate",
            "#fieldParts"
          ],
          "type": "union"
        },
        "title": {
          "refs": [
            "#fieldPath",
            "#fieldTemplate",
            "#fieldParts"
          ],
          "type": "union"
        }
      },
      "type": "object"
    },
    "quickCompose": {
      "description": "What a Quick Compose box asks for when writing a new record in a collection. Taken whole: with these settings saved, nothing is guessed from the lexicon. Required properties the box can't fill in itself are always asked for.",
      "properties": {
        "body": {
          "description": "Older settings: where the text is written. Absent: chosen from 'fields'.",
          "maxLength": 640,
          "type": "string"
        },
        "defaults": {
          "description": "Values the box starts with, by field name, for fields it asks for: any value the field can hold, such as a document's 'site' or a post's 'tags'.",
          "type": "unknown"
        },
        "fields": {
          "description": "The fields the box asks for, taken from the collection's editor fields. They're shown in the order the editor has them. The text goes in the first rich text field (or text field such as 'text') among them, and a field such as 'title' is the title.",
          "items": {
            "maxLength": 640,
            "type": "string"
          },
          "maxLength": 64,
          "type": "array"
        },
        "title": {
          "description": "Older settings: the text property typed on a line of its own above the text. Absent: chosen from 'fields'.",
          "maxLength": 640,
          "type": "string"
        }
      },
      "type": "object"
    },
    "relatedField": {
      "description": "Records of another collection that link to the record being edited, such as a list's items. They're found by the link, so nothing is stored in the record itself.",
      "properties": {
        "anyRepo": {
          "description": "Include linking records from any account's repo, not only the repo of the record being edited.",
          "type": "boolean"
        },
        "collection": {
          "description": "The collection the linking records are in, such as 'app.bsky.graph.listitem'.",
          "format": "nsid",
          "type": "string"
        },
        "limit": {
          "description": "The most records there should be; 1 for a single record, such as a list's starter pack. No limit when absent.",
          "minimum": 1,
          "type": "integer"
        },
        "name": {
          "description": "Names the field in the editor and its layout. Must differ from the collection's own fields.",
          "maxGraphemes": 64,
          "maxLength": 640,
          "minLength": 1,
          "type": "string"
        },
        "path": {
          "description": "Field path to the link in those records, such as 'list', or 'subject.uri' for a strong reference.",
          "maxLength": 640,
          "type": "string"
        },
        "previewFields": {
          "description": "How to preview these records in the editor, in place of the collection's own preview: parts left out are left out of the preview. The collection's preview applies when absent.",
          "ref": "#previewFields",
          "type": "ref"
        }
      },
      "required": [
        "name",
        "collection",
        "path"
      ],
      "type": "object"
    },
    "richTextFacets": {
      "description": "Plain text with facets, as in a Bluesky post: one property holds the text, another the app.bsky.richtext.facet annotations (mentions, links, hashtags) on it. Edited as one field, named by the text property.",
      "properties": {
        "facets": {
          "description": "The property that holds the facets, such as 'facets'.",
          "maxLength": 640,
          "type": "string"
        },
        "text": {
          "description": "The property that holds the text, such as 'text'.",
          "maxLength": 640,
          "type": "string"
        }
      },
      "required": [
        "text",
        "facets"
      ],
      "type": "object"
    },
    "richTextMarkdown": {
      "description": "Markdown, as in a standard.site document: one property holds the Markdown, and another, optionally, a plain text copy of it. Edited as one field, named by the Markdown property.",
      "properties": {
        "markdown": {
          "description": "The property that holds the Markdown, such as 'content'.",
          "maxLength": 640,
          "type": "string"
        },
        "markdownType": {
          "description": "How Markdown is stored: as text, as an at.markpub.markdown object, or as the blocks of a Leaflet (pub.leaflet.content), pckt (blog.pckt.content) or Offprint (app.offprint.content) document, converted to and from Markdown. Text already stored becomes an object when it's next edited, if an object is called for; an object stays one, of the same kind. Absent: text if the lexicon makes the property a string, otherwise at.markpub.markdown.",
          "knownValues": [
            "text",
            "at.markpub.markdown",
            "pub.leaflet.content",
            "blog.pckt.content",
            "app.offprint.content"
          ],
          "type": "string"
        },
        "plainText": {
          "description": "The property that gets a plain text copy of it, without formatting, such as 'textContent'.",
          "maxLength": 640,
          "type": "string"
        }
      },
      "required": [
        "markdown"
      ],
      "type": "object"
    },
    "templateVar": {
      "description": "A named template variable and how to compute its value.",
      "properties": {
        "name": {
          "description": "Variable name used in the template.",
          "type": "string"
        },
        "value": {
          "refs": [
            "#fieldPath",
            "#fieldParts"
          ],
          "type": "union"
        }
      },
      "required": [
        "name",
        "value"
      ],
      "type": "object"
    }
  },
  "id": "us.polhem.skywrite.defs",
  "lexicon": 1
}