atproto/lexicons/app/bsky/graph/getStarterPacksWithMembership.json
rafael c370d933b7
Lists API improvements (#4081)
* Add purposes filter to app.bsky.graph.getLists

* Add getListsWithMembership

* Add getStarterPacksWithMembership

* Refactor list membership hydration

* changeset

* update getStarterPacksWithMembership lexicon output

* bsky: address feedback on list api improvements

* tidy

* tidy

---------

Co-authored-by: Devin Ivy <devinivy@gmail.com>
2025-08-05 01:06:05 -04:00

58 lines
1.7 KiB
JSON

{
"lexicon": 1,
"id": "app.bsky.graph.getStarterPacksWithMembership",
"defs": {
"main": {
"type": "query",
"description": "Enumerates the starter packs created by the session user, and includes membership information about `actor` in those starter packs. Requires auth.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier",
"description": "The account (actor) to check for membership."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": { "type": "string" }
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["starterPacksWithMembership"],
"properties": {
"cursor": { "type": "string" },
"starterPacksWithMembership": {
"type": "array",
"items": { "type": "ref", "ref": "#starterPackWithMembership" }
}
}
}
}
},
"starterPackWithMembership": {
"description": "A starter pack and an optional list item indicating membership of a target user to that starter pack.",
"type": "object",
"required": ["starterPack"],
"properties": {
"starterPack": {
"type": "ref",
"ref": "app.bsky.graph.defs#starterPackView"
},
"listItem": {
"type": "ref",
"ref": "app.bsky.graph.defs#listItemView"
}
}
}
}
}