Lexicon Garden

pub.chive.collection.get

Get a single collection by its AT-URI

Repository @lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh not from the namespace authority
Details · query
Kindquery
Authoritycollection.chive.pub
Indexed
Compare Edit in builder → Fork →
cid bafyreifrtxxz44cfwmt3d7knku44emimx6rq5pggsx6kfezpta2g7u5mum

Checks

Valid
  • unlimited-string defs.main.parameters.properties.uriNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get a single collection by its AT-URI",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "collection": {
              "description": "The requested collection",
              "ref": "pub.chive.collection.defs#collectionView",
              "type": "ref"
            },
            "interItemEdges": {
              "description": "Edges between items within this collection",
              "items": {
                "ref": "pub.chive.collection.defs#interItemEdgeView",
                "type": "ref"
              },
              "type": "array"
            },
            "items": {
              "description": "Items contained in the collection",
              "items": {
                "ref": "pub.chive.collection.defs#collectionItemView",
                "type": "ref"
              },
              "type": "array"
            },
            "subcollections": {
              "description": "Child subcollections",
              "items": {
                "ref": "pub.chive.collection.defs#collectionView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "collection",
            "items",
            "subcollections",
            "interItemEdges"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "excludeSubcollectionItems": {
            "description": "When true, exclude items that also appear in subcollections",
            "type": "boolean"
          },
          "uri": {
            "description": "AT-URI of the collection",
            "type": "string"
          }
        },
        "required": [
          "uri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "pub.chive.collection.get",
  "lexicon": 1,
  "revision": 1
}