Lexicon Garden

pub.chive.sync.indexRecord

Index a record from PDS (owner or admin only)

Repository @lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh not from the namespace authority
Details · procedure
Kindprocedure
Authoritysync.chive.pub
Indexed
Compare Edit in builder → Fork →
cid bafyreierlrtu4poke54dqnfalm55jdbwqoxvetgtbg6xfycirzojzr3o64

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.errorNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Index a record from PDS (owner or admin only)",
      "errors": [
        {
          "name": "InvalidRequest"
        },
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "NotFound"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "uri": {
              "description": "AT-URI of the record to index",
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "uri"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cid": {
              "description": "CID of the indexed record (if successful)",
              "format": "cid",
              "type": "string"
            },
            "error": {
              "description": "Error message (if failed)",
              "type": "string"
            },
            "indexed": {
              "description": "Whether indexing succeeded",
              "type": "boolean"
            },
            "uri": {
              "description": "AT-URI of the indexed record",
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "uri",
            "indexed"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "pub.chive.sync.indexRecord",
  "lexicon": 1,
  "revision": 1
}