atproto/lexicons/app/bsky/unspecced/searchActorsSkeleton.json
bnewbold a2d5658f28
lexicons: add more search parameters (#2396)
* lex: add account to actor search, for following boost

* lex: addition post search query params

* lex: add tag to post search; set default for sort

* lex: fix formats and skeleton consistency

* lex: searchPosts 'until' should be exclusive

* lex: relax post time range syntax

* lex: allow multiple tags ('AND') as search params

* make fmt

* lex: use 'viewer' for account DID making profile search

* lex: no viewer param in searchActor (only skeleton); do include in post skeleton

* codegen search param additions
2024-04-11 16:45:13 -07:00

62 lines
2.0 KiB
JSON

{
"lexicon": 1,
"id": "app.bsky.unspecced.searchActorsSkeleton",
"defs": {
"main": {
"type": "query",
"description": "Backend Actors (profile) search, returns only skeleton.",
"parameters": {
"type": "params",
"required": ["q"],
"properties": {
"q": {
"type": "string",
"description": "Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax."
},
"viewer": {
"type": "string",
"format": "did",
"description": "DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking."
},
"typeahead": {
"type": "boolean",
"description": "If true, acts as fast/simple 'typeahead' query."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25
},
"cursor": {
"type": "string",
"description": "Optional pagination mechanism; may not necessarily allow scrolling through entire result set."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["actors"],
"properties": {
"cursor": { "type": "string" },
"hitsTotal": {
"type": "integer",
"description": "Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits."
},
"actors": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.unspecced.defs#skeletonSearchActor"
}
}
}
}
},
"errors": [{ "name": "BadQueryString" }]
}
}
}