org.swappulse.journal Documentation (EN)

main record

A published collector journal entry.

Record Key tid Timestamp-based ID

Properties

authorAvatar string uri Optional

A valid URI.

authorDid string did Optional

A decentralized identifier (DID).

authorHandle string Optional

No description available.

authorName string Optional

No description available.

body string Required

No description available.

maxLength: 50000 bytes

coverImageUri string uri Optional

A valid URI.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

embeddedCardUris array of string at-uri Optional

No description available.

maxLength: 20 items

embeddedStats object Optional

No description available.

likeCount integer Optional

No description available.

publishedAt string datetime Optional

An RFC 3339 formatted timestamp.

subtitle string Optional

No description available.

maxLength: 300 bytes

tags array of string Optional

No description available.

maxLength: 10 items

title string Required

No description available.

maxLength: 200 bytes

visibility string Required

No description available.

Known values: public, followers, private

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "body",
      "visibility",
      "createdAt"
    ],
    "properties": {
      "body": {
        "type": "string",
        "maxLength": 50000
      },
      "tags": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 30
        },
        "maxLength": 10
      },
      "title": {
        "type": "string",
        "maxLength": 200
      },
      "subtitle": {
        "type": "string",
        "maxLength": 300
      },
      "authorDid": {
        "type": "string",
        "format": "did"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "likeCount": {
        "type": "integer"
      },
      "authorName": {
        "type": "string"
      },
      "visibility": {
        "type": "string",
        "knownValues": [
          "public",
          "followers",
          "private"
        ]
      },
      "publishedAt": {
        "type": "string",
        "format": "datetime"
      },
      "authorAvatar": {
        "type": "string",
        "format": "uri"
      },
      "authorHandle": {
        "type": "string"
      },
      "coverImageUri": {
        "type": "string",
        "format": "uri"
      },
      "embeddedStats": {
        "type": "object",
        "properties": {
          "totalCards": {
            "type": "integer"
          },
          "rarestCardUri": {
            "type": "string"
          },
          "setCompletionPercent": {
            "type": "number"
          },
          "totalCollectionValue": {
            "type": "number"
          }
        }
      },
      "embeddedCardUris": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "maxLength": 20
      }
    }
  },
  "description": "A published collector journal entry."
}