org.hypercerts.context.attachment

lexicon.store View official

Documentation

An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).

main record

An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).

Record Key tid Timestamp-based ID

Properties

contentType string Optional

The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc.

maxLength: 64 bytes
createdAt string datetime Required

Client-declared timestamp when this record was originally created.

location ref com.atproto.repo.strongRef Optional

A strong reference to the location where this attachment's subject matter occurred. The record referenced must conform with the lexicon app.certified.location.

shortDescription string Optional

Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
shortDescriptionFacets array of ref app.bsky.richtext.facet Optional

Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).

subjects array of ref com.atproto.repo.strongRef Optional

References to the subject(s) the attachment is connected to—this may be an activity claim, outcome claim, measurement, evaluation, or even another attachment. This is optional as the attachment can exist before the claim is recorded.

maxLength: 100 items
title string Required

Display title for this attachment (e.g. 'Impact Assessment Report', 'Audit Findings')

maxLength: 256 bytes
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "createdAt"
    ],
    "properties": {
      "title": {
        "type": "string",
        "maxLength": 256,
        "description": "Display title for this attachment (e.g. 'Impact Assessment Report', 'Audit Findings')"
      },
      "content": {
        "type": "array",
        "items": {
          "refs": [
            "org.hypercerts.defs#uri",
            "org.hypercerts.defs#smallBlob"
          ],
          "type": "union"
        },
        "maxLength": 100,
        "description": "The files, documents, or external references included in this attachment record."
      },
      "location": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "A strong reference to the location where this attachment's subject matter occurred. The record referenced must conform with the lexicon app.certified.location."
      },
      "subjects": {
        "type": "array",
        "items": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        },
        "maxLength": 100,
        "description": "References to the subject(s) the attachment is connected to—this may be an activity claim, outcome claim, measurement, evaluation, or even another attachment. This is optional as the attachment can exist before the claim is recorded."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when this record was originally created."
      },
      "contentType": {
        "type": "string",
        "maxLength": 64,
        "description": "The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc."
      },
      "description": {
        "ref": "pub.leaflet.pages.linearDocument#main",
        "type": "ref",
        "description": "Rich-text description, represented as a Leaflet linear document."
      },
      "shortDescription": {
        "type": "string",
        "maxLength": 3000,
        "description": "Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.",
        "maxGraphemes": 300
      },
      "shortDescriptionFacets": {
        "type": "array",
        "items": {
          "ref": "app.bsky.richtext.facet",
          "type": "ref"
        },
        "description": "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc)."
      }
    }
  },
  "description": "An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation)."
}

Lexicon Garden

@