social.coves.feed.getFeedSkeleton

Get an ordered page of post URIs from a feed generator. Served by the generator's service and called by the AppView, which hydrates the posts.

Repository @coves.social did:web:coves.social namespace authority
Details · query
Kindquery
Authorityfeed.coves.social
Commit rev3n2v225z25226
Indexed
cid bafyreif6wjntwpty7ls2iiawxsqumzq4zaq3ezl46aun447wkrats36fbe

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get an ordered page of post URIs from a feed generator. Served by the generator's service and called by the AppView, which hydrates the posts.",
      "errors": [
        {
          "description": "The generator does not serve the requested feed.",
          "name": "UnknownFeed"
        },
        {
          "description": "The generator does not support the requested scope.",
          "name": "UnsupportedFeedScope"
        },
        {
          "description": "The cursor is malformed or expired.",
          "name": "InvalidCursor"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "ref": "#output",
          "type": "ref"
        }
      },
      "parameters": {
        "properties": {
          "community": {
            "description": "DID of the community for scope=community",
            "format": "did",
            "type": "string"
          },
          "cursor": {
            "maxLength": 500,
            "type": "string"
          },
          "feed": {
            "description": "AT-URI of the social.coves.feed.generator record being requested",
            "format": "at-uri",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "scope": {
            "description": "Which feed surface the request is for: all communities, the viewer's home feed, or one community",
            "knownValues": [
              "all",
              "home",
              "community"
            ],
            "maxLength": 64,
            "type": "string"
          },
          "timeframe": {
            "default": "day",
            "description": "Timeframe for feeds ranked by top score",
            "knownValues": [
              "hour",
              "day",
              "week",
              "month",
              "year",
              "all"
            ],
            "maxLength": 64,
            "type": "string"
          }
        },
        "required": [
          "feed",
          "scope"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "output": {
      "description": "A page of post URIs in the generator's order",
      "properties": {
        "cursor": {
          "maxLength": 500,
          "type": "string"
        },
        "feed": {
          "items": {
            "ref": "social.coves.feed.defs#skeletonFeedPost",
            "type": "ref"
          },
          "type": "array"
        },
        "reqId": {
          "description": "Request ID assigned by the generator. The AppView returns it on the hydrated response, and clients send it back with interactions.",
          "maxLength": 100,
          "type": "string"
        }
      },
      "required": [
        "feed"
      ],
      "type": "object"
    }
  },
  "id": "social.coves.feed.getFeedSkeleton",
  "lexicon": 1
}