dev.pcvera.temp.badge.def

pcvera.dev

Documentation

main record

No description available.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

When this definition was first created.

description string Required

Human-readable description of what the badge represents.

maxLength: 5000 bytesmaxGraphemes: 2000 graphemes
png blob Required

PNG artwork hosted on the issuer PDS.

maxSize: 1.0 MB
title string Required

Short label for the badge.

maxLength: 200 bytesminLength: 1 bytes
updatedAt string datetime Required

When this definition was last updated.

View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "description",
      "png",
      "createdAt",
      "updatedAt"
    ],
    "properties": {
      "png": {
        "type": "blob",
        "accept": [
          "image/png"
        ],
        "maxSize": 1048576,
        "description": "PNG artwork hosted on the issuer PDS."
      },
      "title": {
        "type": "string",
        "maxLength": 200,
        "minLength": 1,
        "description": "Short label for the badge."
      },
      "issuer": {
        "ref": "#issuerMetadata",
        "type": "ref"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When this definition was first created."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "When this definition was last updated."
      },
      "description": {
        "type": "string",
        "maxLength": 5000,
        "description": "Human-readable description of what the badge represents.",
        "maxGraphemes": 2000
      }
    }
  }
}
issuerMetadata object

Optional issuer-facing metadata for display in clients.

Properties

displayName string Optional

Name shown next to the badge in UIs.

maxLength: 200 bytesmaxGraphemes: 64 graphemes
siteUrl string uri Optional

Optional issuer or campaign page.

View raw schema
{
  "type": "object",
  "properties": {
    "siteUrl": {
      "type": "string",
      "format": "uri",
      "description": "Optional issuer or campaign page."
    },
    "displayName": {
      "type": "string",
      "maxLength": 200,
      "description": "Name shown next to the badge in UIs.",
      "maxGraphemes": 64
    }
  },
  "description": "Optional issuer-facing metadata for display in clients."
}

Lexicon Garden

@