org.swappulse.podcastEpisode Documentation (EN)

main record

A podcast episode.

Record Key tid Timestamp-based ID

Properties

audioUrl string uri Required

A valid URI.

chapterMarks array of object Optional

No description available.

coverImageUrl string uri Optional

A valid URI.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 2000 bytes

durationSeconds integer Required

No description available.

minimum: 1

episodeNumber integer Optional

No description available.

minimum: 1

hostAvatar string uri Optional

A valid URI.

hostDid string did Optional

A decentralized identifier (DID).

hostHandle string Optional

No description available.

hostName string Optional

No description available.

playCount integer Optional

No description available.

publishedAt string datetime Required

An RFC 3339 formatted timestamp.

seasonNumber integer Optional

No description available.

minimum: 1

showNotes string Optional

No description available.

maxLength: 5000 bytes

sourceSpaceId string Optional

No description available.

tags array of string Optional

No description available.

maxLength: 10 items

title string Required

No description available.

maxLength: 200 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "audioUrl",
      "durationSeconds",
      "publishedAt",
      "createdAt"
    ],
    "properties": {
      "tags": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 30
        },
        "maxLength": 10
      },
      "title": {
        "type": "string",
        "maxLength": 200
      },
      "hostDid": {
        "type": "string",
        "format": "did"
      },
      "audioUrl": {
        "type": "string",
        "format": "uri"
      },
      "hostName": {
        "type": "string"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "playCount": {
        "type": "integer"
      },
      "showNotes": {
        "type": "string",
        "maxLength": 5000
      },
      "hostAvatar": {
        "type": "string",
        "format": "uri"
      },
      "hostHandle": {
        "type": "string"
      },
      "description": {
        "type": "string",
        "maxLength": 2000
      },
      "publishedAt": {
        "type": "string",
        "format": "datetime"
      },
      "chapterMarks": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string",
              "maxLength": 100
            },
            "cardUri": {
              "type": "string"
            },
            "timestampSeconds": {
              "type": "integer"
            }
          }
        }
      },
      "seasonNumber": {
        "type": "integer",
        "minimum": 1
      },
      "coverImageUrl": {
        "type": "string",
        "format": "uri"
      },
      "episodeNumber": {
        "type": "integer",
        "minimum": 1
      },
      "sourceSpaceId": {
        "type": "string"
      },
      "durationSeconds": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "description": "A podcast episode."
}