comAtprotoServerDescribeServer top-level constant

Map<String, dynamic> const comAtprotoServerDescribeServer

com.atproto.server.describeServer

Implementation

const comAtprotoServerDescribeServer = <String, dynamic>{
  "lexicon": 1,
  "id": "com.atproto.server.describeServer",
  "defs": {
    "main": {
      "type": "query",
      "description":
          "Describes the server's account creation requirements and capabilities. Implemented by PDS.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": ["did", "availableUserDomains"],
          "properties": {
            "inviteCodeRequired": {
              "type": "boolean",
              "description":
                  "If true, an invite code must be supplied to create an account on this instance."
            },
            "phoneVerificationRequired": {
              "type": "boolean",
              "description":
                  "If true, a phone verification token must be supplied to create an account on this instance."
            },
            "availableUserDomains": {
              "type": "array",
              "description":
                  "List of domain suffixes that can be used in account handles.",
              "items": {"type": "string"}
            },
            "links": {
              "type": "ref",
              "description": "URLs of service policy documents.",
              "ref": "#links"
            },
            "contact": {
              "type": "ref",
              "description": "Contact information",
              "ref": "#contact"
            },
            "did": {"type": "string", "format": "did"}
          }
        }
      }
    },
    "links": {
      "type": "object",
      "properties": {
        "privacyPolicy": {"type": "string", "format": "uri"},
        "termsOfService": {"type": "string", "format": "uri"}
      }
    },
    "contact": {
      "type": "object",
      "properties": {
        "email": {"type": "string"}
      }
    }
  }
};