club.userstyles.alpha.defs

userstyles.club

Documentation

commentThreadView object

No description available.

Properties

author string did Optional

A decentralized identifier (DID).

cid string cid Optional

A content identifier (CID) referencing immutable data.

comment string Optional

No description available.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

createdAt string datetime Required

An RFC 3339 formatted timestamp.

deleted boolean Required

No description available.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

parentUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

rating integer Optional

No description available.

minimum: 1maximum: 5

subjectUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "deleted",
    "createdAt",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1
    },
    "comment": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    },
    "deleted": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "parentUri": {
      "type": "string",
      "format": "at-uri"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "subjectUri": {
      "type": "string",
      "format": "at-uri"
    }
  }
}

commentView object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

A content identifier (CID) referencing immutable data.

comment string Required

No description available.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

createdAt string datetime Required

An RFC 3339 formatted timestamp.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

parentUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

subjectUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "subjectUri",
    "comment",
    "createdAt",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "comment": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "parentUri": {
      "type": "string",
      "format": "at-uri"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "subjectUri": {
      "type": "string",
      "format": "at-uri"
    }
  }
}

feedFollowView object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

did string did Required

A decentralized identifier (DID).

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

subjectDid string did Required

A decentralized identifier (DID).

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "did",
    "subjectDid",
    "createdAt",
    "indexedAt"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "subjectDid": {
      "type": "string",
      "format": "did"
    }
  }
}

feedViewItem object

No description available.

Properties

comment ref club.userstyles.alpha.defs#commentView Optional

No description available.

follow ref club.userstyles.alpha.defs#feedFollowView Optional

No description available.

rating ref club.userstyles.alpha.defs#ratingView Optional

No description available.

type string Required

No description available.

userstyle ref club.userstyles.alpha.defs#userstyleView Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "userstyle",
        "comment",
        "rating",
        "follow"
      ],
      "type": "string"
    },
    "follow": {
      "ref": "club.userstyles.alpha.defs#feedFollowView",
      "type": "ref"
    },
    "rating": {
      "ref": "club.userstyles.alpha.defs#ratingView",
      "type": "ref"
    },
    "comment": {
      "ref": "club.userstyles.alpha.defs#commentView",
      "type": "ref"
    },
    "userstyle": {
      "ref": "club.userstyles.alpha.defs#userstyleView",
      "type": "ref"
    }
  }
}

followView object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

did string did Required

A decentralized identifier (DID).

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "createdAt"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}

mozDocumentFunction object

No description available.

Properties

name string Required

No description available.

value string Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "value"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}

notificationView object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

createdAt string datetime Required

An RFC 3339 formatted timestamp.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

reason string Required

No description available.

recordUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

userstyle ref club.userstyles.alpha.defs#userstyleView Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "reason",
    "recordUri",
    "author",
    "createdAt",
    "indexedAt"
  ],
  "properties": {
    "author": {
      "type": "string",
      "format": "did"
    },
    "reason": {
      "enum": [
        "comment",
        "reply",
        "thread",
        "rating",
        "follow"
      ],
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "recordUri": {
      "type": "string",
      "format": "at-uri"
    },
    "userstyle": {
      "ref": "club.userstyles.alpha.defs#userstyleView",
      "type": "ref"
    }
  }
}

profileView object

No description available.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

did string did Required

A decentralized identifier (DID).

handle string handle Optional

An AT Protocol handle (e.g., alice.bsky.social).

indexedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "description": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    }
  }
}

ratingView object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

rating integer Required

No description available.

minimum: 1maximum: 5

subjectUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "subjectUri",
    "rating",
    "createdAt",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "subjectUri": {
      "type": "string",
      "format": "at-uri"
    }
  }
}

relationshipView object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

followedBy string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

following string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "following": {
      "type": "string",
      "format": "at-uri"
    },
    "followedBy": {
      "type": "string",
      "format": "at-uri"
    }
  }
}

userstyleView object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

A content identifier (CID) referencing immutable data.

commentCount integer Required

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxGraphemes: 300 graphemes

homepageUrl string uri Optional

A valid URI.

ignoreUpdateUrl boolean Optional

No description available.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

license string Optional

No description available.

maxLength: 100 bytes

mozDocumentFunctions array of refclub.userstyles.alpha.defs#mozDocumentFunction Optional

No description available.

previewImageCid string cid Optional

A content identifier (CID) referencing immutable data.

ratingAverage string Optional

No description available.

ratingCount integer Required

No description available.

sourceCodeCid string cid Required

A content identifier (CID) referencing immutable data.

title string Required

No description available.

maxGraphemes: 140 graphemesminGraphemes: 1 graphemes

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

upstreamUrl string uri Optional

A valid URI.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

userCssVars integer Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "title",
    "sourceCodeCid",
    "createdAt",
    "indexedAt",
    "commentCount",
    "ratingCount"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "title": {
      "type": "string",
      "maxGraphemes": 140,
      "minGraphemes": 1
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "license": {
      "type": "string",
      "maxLength": 100
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "description": {
      "type": "string",
      "maxGraphemes": 300
    },
    "homepageUrl": {
      "type": "string",
      "format": "uri"
    },
    "ratingCount": {
      "type": "integer"
    },
    "upstreamUrl": {
      "type": "string",
      "format": "uri"
    },
    "userCssVars": {
      "type": "integer"
    },
    "commentCount": {
      "type": "integer"
    },
    "ratingAverage": {
      "type": "string"
    },
    "sourceCodeCid": {
      "type": "string",
      "format": "cid"
    },
    "ignoreUpdateUrl": {
      "type": "boolean"
    },
    "previewImageCid": {
      "type": "string",
      "format": "cid"
    },
    "mozDocumentFunctions": {
      "type": "array",
      "items": {
        "ref": "club.userstyles.alpha.defs#mozDocumentFunction",
        "type": "ref"
      }
    }
  }
}