space.highport.manage.getIndexStatus

{
  "id": "space.highport.manage.getIndexStatus",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "RecordNotFound",
          "description": "Bard has no record at that URI or domain."
        },
        {
          "name": "NotOwner",
          "description": "The record does not belong to the caller. For a tile URI, the caller must be the tile's repo."
        },
        {
          "name": "SpaceNotFound",
          "description": "The URI is in space form and names a space bard does not serve, or one the caller is not in. Both cases get the same error, so it cannot be used to probe membership."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "state",
            "failed",
            "errors"
          ],
          "properties": {
            "cid": {
              "type": "string",
              "format": "cid"
            },
            "rev": {
              "type": "string",
              "description": "The commit revision of the indexed record."
            },
            "edge": {
              "ref": "space.highport.defs#edgeReachability",
              "type": "ref",
              "description": "Whether the edge routes this site's hostname to bard. Present only for a domain-backed record. An active index state says nothing about routing: a fully indexed site can still have its requests answered by something else. Treat unknown as no opinion."
            },
            "state": {
              "ref": "space.highport.defs#indexState",
              "type": "ref"
            },
            "errors": {
              "type": "array",
              "items": {
                "ref": "space.highport.defs#validationError",
                "type": "ref"
              }
            },
            "failed": {
              "type": "array",
              "items": {
                "ref": "space.highport.defs#blobFailure",
                "type": "ref"
              },
              "description": "Blobs that could not be fetched. Each includes sourceDid and role, which makes it clear when re-uploading will not help, such as a BlobUnavailable on a tile blob."
            },
            "fetched": {
              "type": "integer",
              "description": "Blobs fetched and checked against their CIDs so far."
            },
            "pending": {
              "type": "integer",
              "description": "Blobs still to fetch."
            },
            "entryCount": {
              "type": "integer"
            },
            "activatedAt": {
              "type": "string",
              "format": "datetime"
            },
            "preparation": {
              "ref": "space.highport.defs#preparationStatus",
              "type": "ref",
              "description": "A validated record waiting to be committed, while the domain still serves an earlier revision."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "uri": {
            "type": "string",
            "format": "at-uri",
            "description": "The record's AT-URI, in public or space form. Mutually exclusive with domain."
          },
          "domain": {
            "type": "string",
            "maxLength": 253,
            "description": "The site's hostname. Mutually exclusive with uri."
          }
        }
      },
      "description": "Per-blob progress of a publish. Give exactly one of uri or domain. The top level describes the active revision, or the prepared record if nothing is active yet. A newer record prepared while another is active appears under preparation."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}