org.swappulse.binder Documentation (EN)

main record

A digital binder.

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.

coverImageUri string uri Optional

A valid URI.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 500 bytes

likeCount integer Optional

No description available.

pages array of object Optional

No description available.

maxLength: 10 itemsminLength: 1 items

theme string Optional

No description available.

Known values: classic_purple, holo_foil, vintage_leather, midnight, rainbow, custom

title string Required

No description available.

maxLength: 100 bytes

viewCount integer Optional

No description available.

visibility string Required

No description available.

Known values: public, followers, private

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "visibility",
      "createdAt"
    ],
    "properties": {
      "pages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "slots": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "slotIndex": {
                    "type": "integer",
                    "maximum": 6,
                    "minimum": 1
                  },
                  "customCaption": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "collectionEntryUri": {
                    "type": "string",
                    "format": "at-uri"
                  }
                }
              },
              "maxLength": 6,
              "minLength": 6
            },
            "pageNumber": {
              "type": "integer",
              "maximum": 10,
              "minimum": 1
            }
          }
        },
        "maxLength": 10,
        "minLength": 1
      },
      "theme": {
        "type": "string",
        "knownValues": [
          "classic_purple",
          "holo_foil",
          "vintage_leather",
          "midnight",
          "rainbow",
          "custom"
        ]
      },
      "title": {
        "type": "string",
        "maxLength": 100
      },
      "authorDid": {
        "type": "string",
        "format": "did"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "likeCount": {
        "type": "integer"
      },
      "viewCount": {
        "type": "integer"
      },
      "authorName": {
        "type": "string"
      },
      "visibility": {
        "type": "string",
        "knownValues": [
          "public",
          "followers",
          "private"
        ]
      },
      "description": {
        "type": "string",
        "maxLength": 500
      },
      "authorAvatar": {
        "type": "string",
        "format": "uri"
      },
      "authorHandle": {
        "type": "string"
      },
      "coverImageUri": {
        "type": "string",
        "format": "uri"
      }
    }
  },
  "description": "A digital binder."
}