atproto/lexicons/app/bsky/graph/getRelationships.json
bnewbold 9579bec720
update descriptions in Lexicons (#2110)
* lexicons: update descriptions in com.atproto.*

* lexicons: update descriptions in app.bsky.*

* Apply suggestions from code review

Thanks Emily!

Co-authored-by: Emily Liu <emilyliu7321@gmail.com>

* codegen description-only Lexicon updates

---------

Co-authored-by: Emily Liu <emilyliu7321@gmail.com>
2024-02-11 16:06:58 -08:00

57 lines
1.5 KiB
JSON

{
"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.",
"maxLength": 30,
"items": {
"type": "string",
"format": "at-identifier"
}
}
}
},
"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"
}
]
}
}
}