Lexicon Garden

pub.chive.sync.registerPDS

Register a PDS for scanning to ensure records from non-relay PDSes can be discovered and indexed

Repository @lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh not from the namespace authority
Details · procedure
Kindprocedure
Authoritysync.chive.pub
Indexed

Showing version bafyreieiceeyhaxbrhj7o3pxfiephbesmg722w2ozcy2hmtxsyxj4ulj3u. Show the latest

Compare Edit in builder → Fork →
cid bafyreieiceeyhaxbrhj7o3pxfiephbesmg722w2ozcy2hmtxsyxj4ulj3u

Checks

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