app.standard-reader.defs

standard-reader.app

Documentation

cursorPageDocuments object

No description available.

Properties

cursor string Optional

No description available.

items array of refapp.standard-reader.defs#documentView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "app.standard-reader.defs#documentView",
        "type": "ref"
      }
    },
    "cursor": {
      "type": "string",
      "nullable": true
    }
  }
}

cursorPagePublications object

No description available.

Properties

cursor string Optional

No description available.

items array of refapp.standard-reader.defs#publicationView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "app.standard-reader.defs#publicationView",
        "type": "ref"
      }
    },
    "cursor": {
      "type": "string",
      "nullable": true
    }
  }
}

documentView object

An article as shown in feed rows and search results (metadata only).

Properties

canonicalUrl string uri Optional

A valid URI.

commentCount integer Required

No description available.

coverImageUrl string uri Optional

A valid URI.

description string Optional

No description available.

did string did Required

A decentralized identifier (DID).

featured boolean Optional

No description available.

hasRenderableBody boolean Required

No description available.

isRead boolean Required

No description available.

path string Optional

No description available.

publicationBannerUrl string uri Optional

A valid URI.

publicationIconUrl string uri Optional

A valid URI.

publicationName string Optional

No description available.

publicationOwnerAvatarUrl string uri Optional

A valid URI.

publicationOwnerHandle string Optional

No description available.

publicationTopic string Optional

No description available.

publicationUri string at-uri Optional

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

publishedAt string datetime Required

An RFC 3339 formatted timestamp.

recommendCount integer Required

No description available.

searchSnippetHtml string Optional

No description available.

searchTitleHtml string Optional

No description available.

tags array of string Optional

No description available.

title string Required

No description available.

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",
    "title",
    "publishedAt",
    "recommendCount",
    "commentCount",
    "hasRenderableBody",
    "isRead"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "path": {
      "type": "string",
      "nullable": true
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "title": {
      "type": "string"
    },
    "isRead": {
      "type": "boolean"
    },
    "featured": {
      "type": "boolean"
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "publishedAt": {
      "type": "string",
      "format": "datetime"
    },
    "canonicalUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "commentCount": {
      "type": "integer"
    },
    "coverImageUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationUri": {
      "type": "string",
      "format": "at-uri",
      "nullable": true
    },
    "recommendCount": {
      "type": "integer"
    },
    "publicationName": {
      "type": "string",
      "nullable": true
    },
    "searchTitleHtml": {
      "type": "string",
      "nullable": true
    },
    "publicationTopic": {
      "type": "string",
      "nullable": true
    },
    "hasRenderableBody": {
      "type": "boolean"
    },
    "searchSnippetHtml": {
      "type": "string",
      "nullable": true
    },
    "publicationIconUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationBannerUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationOwnerHandle": {
      "type": "string",
      "nullable": true
    },
    "publicationOwnerAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  },
  "description": "An article as shown in feed rows and search results (metadata only)."
}

profileView object

No description available.

Properties

avatarUrl string uri Optional

A valid URI.

bannerUrl string uri Optional

A valid URI.

description string Optional

No description available.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

handle string Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "handle": {
      "type": "string",
      "nullable": true
    },
    "avatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "bannerUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "nullable": true
    }
  }
}

publicationView object

A publication as shown in directory cards and profile headers.

Properties

description string Optional

No description available.

did string did Required

A decentralized identifier (DID).

documentCount integer Required

No description available.

iconUrl string uri Optional

A valid URI.

lastDocumentAt string datetime Optional

An RFC 3339 formatted timestamp.

name string Required

No description available.

ownerAvatarUrl string uri Optional

A valid URI.

ownerHandle string Optional

No description available.

searchNameHtml string Optional

No description available.

searchSnippetHtml string Optional

No description available.

subscriberCount integer Required

No description available.

topic string Optional

No description available.

uri string at-uri Required

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

url string uri Required

A valid URI.

verified boolean Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "did",
    "name",
    "url",
    "subscriberCount",
    "documentCount"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "topic": {
      "type": "string",
      "nullable": true
    },
    "iconUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "verified": {
      "type": "boolean"
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "ownerHandle": {
      "type": "string",
      "nullable": true
    },
    "documentCount": {
      "type": "integer"
    },
    "lastDocumentAt": {
      "type": "string",
      "format": "datetime",
      "nullable": true
    },
    "ownerAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "searchNameHtml": {
      "type": "string",
      "nullable": true
    },
    "subscriberCount": {
      "type": "integer"
    },
    "searchSnippetHtml": {
      "type": "string",
      "nullable": true
    }
  },
  "description": "A publication as shown in directory cards and profile headers."
}

resolveViewArticle object

No description available.

Properties

authorAvatarUrl string uri Optional

A valid URI.

authorHandle string Optional

No description available.

authorName string Optional

No description available.

canonicalUrl string uri Optional

A valid URI.

commentCount integer Required

No description available.

documentUri string at-uri Required

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

isBookmarked boolean Optional

No description available.

isFollowing boolean Optional

No description available.

isRead boolean Optional

No description available.

kind string Required

No description available.

publicationHandle string Optional

No description available.

publicationIconUrl string uri Optional

A valid URI.

publicationName string Optional

No description available.

publicationOwnerAvatarUrl string uri Optional

A valid URI.

publicationReaderUrl string uri Optional

A valid URI.

publicationSubscriberCount integer Optional

No description available.

publicationUri string at-uri Optional

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

publishedAt string datetime Optional

An RFC 3339 formatted timestamp.

readerUrl string uri Required

A valid URI.

readingMinutes integer Optional

No description available.

recommendCount integer Required

No description available.

title string Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "kind",
    "documentUri",
    "title",
    "readerUrl",
    "recommendCount",
    "commentCount"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "article"
    },
    "title": {
      "type": "string"
    },
    "isRead": {
      "type": "boolean"
    },
    "readerUrl": {
      "type": "string",
      "format": "uri"
    },
    "authorName": {
      "type": "string",
      "nullable": true
    },
    "documentUri": {
      "type": "string",
      "format": "at-uri"
    },
    "isFollowing": {
      "type": "boolean"
    },
    "publishedAt": {
      "type": "string",
      "format": "datetime",
      "nullable": true
    },
    "authorHandle": {
      "type": "string",
      "nullable": true
    },
    "canonicalUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "commentCount": {
      "type": "integer"
    },
    "isBookmarked": {
      "type": "boolean"
    },
    "publicationUri": {
      "type": "string",
      "format": "at-uri",
      "nullable": true
    },
    "readingMinutes": {
      "type": "integer",
      "nullable": true
    },
    "recommendCount": {
      "type": "integer"
    },
    "authorAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationName": {
      "type": "string",
      "nullable": true
    },
    "publicationHandle": {
      "type": "string",
      "nullable": true
    },
    "publicationIconUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationReaderUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationOwnerAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationSubscriberCount": {
      "type": "integer",
      "nullable": true
    }
  }
}

resolveViewPublication object

No description available.

Properties

description string Optional

No description available.

handle string Optional

No description available.

iconUrl string uri Optional

A valid URI.

isFollowing boolean Optional

No description available.

kind string Required

No description available.

name string Required

No description available.

ownerAvatarUrl string uri Optional

A valid URI.

publicationUri string at-uri Required

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

readerUrl string uri Required

A valid URI.

siteUrl string uri Optional

A valid URI.

subscriberCount integer Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "kind",
    "publicationUri",
    "name",
    "readerUrl"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "publication"
    },
    "name": {
      "type": "string"
    },
    "handle": {
      "type": "string",
      "nullable": true
    },
    "iconUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "siteUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "readerUrl": {
      "type": "string",
      "format": "uri"
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "isFollowing": {
      "type": "boolean"
    },
    "ownerAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationUri": {
      "type": "string",
      "format": "at-uri"
    },
    "subscriberCount": {
      "type": "integer",
      "nullable": true
    }
  }
}

resolveViewReaderLink object

No description available.

Properties

kind string Required

No description available.

readerUrl string Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "kind",
    "readerUrl"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "reader-link"
    },
    "readerUrl": {
      "type": "string"
    }
  }
}

resolveViewUnknown object

No description available.

Properties

kind string Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "kind"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "unknown"
    }
  }
}