org.hypercerts.claim.activity

hypercerts.org

Documentation

A hypercert record tracking impact work.

main record

A hypercert record tracking impact work.

Record Key any Any valid record key

Properties

contributors array of ref #contributor Optional

An array of contributor objects, each containing contributor information, weight, and contribution details.

createdAt string datetime Required

Client-declared timestamp when this record was originally created

description string Optional

Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.

maxLength: 30000 bytesmaxGraphemes: 3000 graphemes
descriptionFacets array of ref app.bsky.richtext.facet Optional

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

endDate string datetime Optional

When the work ended

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

An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location.

rights ref com.atproto.repo.strongRef Optional

A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights.

shortDescription string Required

Short summary of this activity claim, 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).

startDate string datetime Optional

When the work began

title string Required

Title of the hypercert.

maxLength: 256 bytes
workScope union Optional

Work scope definition. Either a strongRef to a work-scope logic record (structured, nested logic), or a free-form string for simple or legacy scopes. The work scope record should conform to the org.hypercerts.helper.workScopeTag lexicon.

Known types:
View raw schema 
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "shortDescription",
      "createdAt"
    ],
    "properties": {
      "image": {
        "refs": [
          "org.hypercerts.defs#uri",
          "org.hypercerts.defs#smallImage"
        ],
        "type": "union",
        "description": "The hypercert visual representation as a URI or image blob."
      },
      "title": {
        "type": "string",
        "maxLength": 256,
        "description": "Title of the hypercert."
      },
      "rights": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights."
      },
      "endDate": {
        "type": "string",
        "format": "datetime",
        "description": "When the work ended"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when this record was originally created"
      },
      "locations": {
        "type": "array",
        "items": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        },
        "description": "An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location."
      },
      "startDate": {
        "type": "string",
        "format": "datetime",
        "description": "When the work began"
      },
      "workScope": {
        "refs": [
          "com.atproto.repo.strongRef",
          "#workScopeString"
        ],
        "type": "union",
        "description": "Work scope definition. Either a strongRef to a work-scope logic record (structured, nested logic), or a free-form string for simple or legacy scopes. The work scope record should conform to the org.hypercerts.helper.workScopeTag lexicon."
      },
      "description": {
        "type": "string",
        "maxLength": 30000,
        "description": "Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.",
        "maxGraphemes": 3000
      },
      "contributors": {
        "type": "array",
        "items": {
          "ref": "#contributor",
          "type": "ref"
        },
        "description": "An array of contributor objects, each containing contributor information, weight, and contribution details."
      },
      "shortDescription": {
        "type": "string",
        "maxLength": 3000,
        "description": "Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.",
        "maxGraphemes": 300
      },
      "descriptionFacets": {
        "type": "array",
        "items": {
          "ref": "app.bsky.richtext.facet",
          "type": "ref"
        },
        "description": "Rich text annotations for `description` (mentions, URLs, hashtags, etc)."
      },
      "shortDescriptionFacets": {
        "type": "array",
        "items": {
          "ref": "app.bsky.richtext.facet",
          "type": "ref"
        },
        "description": "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc)."
      }
    }
  },
  "description": "A hypercert record tracking impact work."
}
contributor object

No description available.

Properties

contributionDetails union Optional

Contribution details as a string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record.

Known types:
contributionWeight string Optional

The relative weight/importance of this contribution (stored as a string to avoid float precision issues). Must be a positive numeric value. Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed.

contributorIdentity union Required

Contributor identity as a string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record.

Known types:
View raw schema 
{
  "type": "object",
  "required": [
    "contributorIdentity"
  ],
  "properties": {
    "contributionWeight": {
      "type": "string",
      "description": "The relative weight/importance of this contribution (stored as a string to avoid float precision issues). Must be a positive numeric value. Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
    },
    "contributionDetails": {
      "refs": [
        "#contributorRole",
        "com.atproto.repo.strongRef"
      ],
      "type": "union",
      "description": "Contribution details as a string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record."
    },
    "contributorIdentity": {
      "refs": [
        "#contributorIdentity",
        "com.atproto.repo.strongRef"
      ],
      "type": "union",
      "description": "Contributor identity as a string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record."
    }
  }
}
contributorIdentity string

Contributor information as a string (DID or identifier).

View raw schema 
{
  "type": "string",
  "description": "Contributor information as a string (DID or identifier)."
}
contributorRole string

Contribution details as a string.

ConstraintsmaxLength: 10000 bytes, maxGraphemes: 1000 graphemes
View raw schema 
{
  "type": "string",
  "maxLength": 10000,
  "description": "Contribution details as a string.",
  "maxGraphemes": 1000
}
workScopeString string

A free-form string describing the work scope for simple or legacy scopes.

ConstraintsmaxLength: 10000 bytes, maxGraphemes: 1000 graphemes
View raw schema 
{
  "type": "string",
  "maxLength": 10000,
  "description": "A free-form string describing the work scope for simple or legacy scopes.",
  "maxGraphemes": 1000
}

Lexicon Garden

@