at.happyproto.registry.searchPackages
Find packages. Deleted packages are never returned. With `q` the result is ranked by match and capped rather than paged, because the index's substring search takes no cursor; without it the result is paged.
Details · query
| Kind | query |
|---|---|
| Authority | registry.happyproto.at |
| Indexed |
Checks
Validunlimited-stringdefs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.pluginTypeNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.qNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Find packages. Deleted packages are never returned. With `q` the result is ranked by match and capped rather than paged, because the index's substring search takes no cursor; without it the result is paged.",
"errors": [
{
"description": "The registry instance has no identity configured (HAPPYPROTO_DID), so it cannot read its own state. An operator problem, not a caller's.",
"name": "NotConfigured"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cursor": {
"description": "Absent when `q` was given, or when the last page was reached.",
"type": "string"
},
"packages": {
"items": {
"ref": "at.happyproto.registry.defs#packageView",
"type": "ref"
},
"type": "array"
}
},
"required": [
"packages"
],
"type": "object"
}
},
"parameters": {
"properties": {
"cursor": {
"description": "Ignored when `q` is given.",
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"pluginType": {
"description": "Only packages whose latest active release is this type.",
"knownValues": [
"auth",
"library",
"interpreter"
],
"type": "string"
},
"q": {
"description": "Substring of the package name. Omit to list.",
"type": "string"
}
},
"type": "params"
},
"type": "query"
}
},
"id": "at.happyproto.registry.searchPackages",
"lexicon": 1
}