Lexicon Garden

pub.chive.admin.triggerBackfill

Trigger a backfill operation by type

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

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "backfillOperation": {
      "description": "A backfill operation record",
      "properties": {
        "id": {
          "description": "Operation ID",
          "type": "string"
        },
        "recordsProcessed": {
          "description": "Number of records processed so far",
          "type": "integer"
        },
        "startedAt": {
          "description": "Operation start time",
          "format": "datetime",
          "type": "string"
        },
        "status": {
          "description": "Operation status",
          "knownValues": [
            "running",
            "completed",
            "failed",
            "cancelled"
          ],
          "type": "string"
        },
        "type": {
          "description": "Backfill operation type",
          "type": "string"
        }
      },
      "required": [
        "id",
        "type",
        "status",
        "startedAt",
        "recordsProcessed"
      ],
      "type": "object"
    },
    "main": {
      "description": "Trigger a backfill operation by type",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "AdminRequired"
        },
        {
          "name": "InvalidBackfillType"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "batchSize": {
              "description": "Batch size for fullReindex type",
              "type": "integer"
            },
            "did": {
              "description": "DID for didSync type",
              "format": "did",
              "type": "string"
            },
            "pdsUrl": {
              "description": "PDS URL for pdsScan type",
              "type": "string"
            },
            "type": {
              "description": "Backfill operation type to trigger",
              "knownValues": [
                "pdsScan",
                "freshnessScan",
                "citationExtraction",
                "fullReindex",
                "governanceSync",
                "didSync"
              ],
              "type": "string"
            },
            "uri": {
              "description": "Eprint URI for citationExtraction type",
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "operation": {
              "description": "The started backfill operation",
              "ref": "#backfillOperation",
              "type": "ref"
            }
          },
          "required": [
            "operation"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "pub.chive.admin.triggerBackfill",
  "lexicon": 1,
  "revision": 1
}