appBskyGraphGetRelationships top-level constant

Map<String, dynamic> const appBskyGraphGetRelationships

app.bsky.graph.getRelationships

Implementation

const appBskyGraphGetRelationships = <String, dynamic>{
  "lexicon": 1,
  "id": "app.bsky.graph.getRelationships",
  "defs": {
    "main": {
      "type": "query",
      "description":
          "Enumerates public relationships between one account, and a list of other accounts. Does not require auth.",
      "parameters": {
        "type": "params",
        "required": ["actor"],
        "properties": {
          "actor": {
            "type": "string",
            "format": "at-identifier",
            "description": "Primary account requesting relationships for."
          },
          "others": {
            "type": "array",
            "description":
                "List of 'other' accounts to be related back to the primary.",
            "items": {"type": "string", "format": "at-identifier"},
            "maxLength": 30
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": ["relationships"],
          "properties": {
            "actor": {"type": "string", "format": "did"},
            "relationships": {
              "type": "array",
              "items": {
                "type": "union",
                "refs": [
                  "app.bsky.graph.defs#relationship",
                  "app.bsky.graph.defs#notFoundActor"
                ]
              }
            }
          }
        }
      },
      "errors": [
        {
          "name": "ActorNotFound",
          "description": "the primary actor at-identifier could not be resolved"
        }
      ]
    }
  }
};