pub.chive.sync.registerPDS

{
  "id": "pub.chive.sync.registerPDS",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "pdsUrl"
          ],
          "properties": {
            "pdsUrl": {
              "type": "string",
              "format": "uri",
              "description": "PDS endpoint URL to register"
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "InvalidRequest"
        },
        {
          "name": "ServiceUnavailable"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "pdsUrl",
            "registered",
            "status"
          ],
          "properties": {
            "pdsUrl": {
              "type": "string",
              "format": "uri",
              "description": "The registered PDS URL"
            },
            "status": {
              "type": "string",
              "description": "Registration status",
              "knownValues": [
                "pending",
                "already_exists",
                "scanned"
              ]
            },
            "message": {
              "type": "string",
              "description": "Human-readable status message"
            },
            "registered": {
              "type": "boolean",
              "description": "Whether the PDS was registered"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Register a PDS for scanning to ensure records from non-relay PDSes can be discovered and indexed"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}