Lexicon Garden

place.stream.beta.getStatus

Report an account's access status for a named beta feature: whether it has been granted (via a trusted place.stream.beta.invite, or because this node isn't beta-gating the feature), has an outstanding place.stream.beta.request, or neither. Defaults to the authenticated caller when `did` is omitted.

Repository @stream.place did:plc:rbvrr34edl5ddpuwcubjiost not from the namespace authority
Details · query
Kindquery
Authoritybeta.stream.place
Indexed
Compare Edit in builder → Fork →
cid bafyreidrixae6al373fycj34eorvnafig77hjki64oricyjzu6bhbta5iu

Checks

Valid
  • unlimited-string defs.main.parameters.properties.featureNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.featureNo 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": "Report an account's access status for a named beta feature: whether it has been granted (via a trusted place.stream.beta.invite, or because this node isn't beta-gating the feature), has an outstanding place.stream.beta.request, or neither. Defaults to the authenticated caller when `did` is omitted.",
      "errors": [
        {
          "description": "No did supplied and the request was not authenticated, so there is no account to check.",
          "name": "DidRequired"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "did": {
              "description": "The account this status applies to.",
              "format": "did",
              "type": "string"
            },
            "feature": {
              "description": "The feature this status applies to (echoes the request).",
              "type": "string"
            },
            "status": {
              "description": "granted: the account may use the feature. requested: no grant yet, but an access request is on file. none: no grant and no request.",
              "knownValues": [
                "granted",
                "requested",
                "none"
              ],
              "type": "string"
            }
          },
          "required": [
            "feature",
            "did",
            "status"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "did": {
            "description": "Account to check. Defaults to the authenticated caller's DID when omitted.",
            "format": "did",
            "type": "string"
          },
          "feature": {
            "description": "Identifier of the beta feature to check (e.g. \"vod\").",
            "type": "string"
          }
        },
        "required": [
          "feature"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "place.stream.beta.getStatus",
  "lexicon": 1
}