community.lexicon.media.book.searchEditions
Search a provider's catalog using text and structured hints. Fuzzy matching, field interpretation, and ranking are provider-specific. This operation does not write user records.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | book.media.lexicon.community |
| Commit rev | 3n2h5sw223y2o |
| Indexed |
Checks
Validunlimited-stringdefs.main.input.schema.properties.authorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.input.schema.properties.qNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.input.schema.properties.titleNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Search a provider's catalog using text and structured hints. Fuzzy matching, field interpretation, and ranking are provider-specific. This operation does not write user records.",
"errors": [
{
"description": "No nonblank q, title, author, or nonempty identifiers array was supplied.",
"name": "InvalidQuery"
}
],
"input": {
"encoding": "application/json",
"schema": {
"description": "Supply at least one nonblank q, title, author, or a nonempty identifiers array. Providers enforce this cross-field requirement.",
"properties": {
"author": {
"description": "Author relevance hint, interpreted by the provider.",
"minLength": 1,
"type": "string"
},
"identifiers": {
"description": "Structured identifier relevance hints; search matching and ranking are provider-defined.",
"items": {
"ref": "community.lexicon.media.book.defs#identifier",
"type": "ref"
},
"minLength": 1,
"type": "array"
},
"limit": {
"default": 25,
"description": "Maximum number of editions to return in this page.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"default": 0,
"description": "Number of matching editions to skip in the provider's ordered result set.",
"minimum": 0,
"type": "integer"
},
"q": {
"description": "Broad search text, which may describe a title, contributor, description, or identifier. Matching and ranking are provider-defined.",
"minLength": 1,
"type": "string"
},
"title": {
"description": "Title relevance hint, interpreted by the provider.",
"minLength": 1,
"type": "string"
}
},
"required": [],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"ref": "community.lexicon.media.book.defs#editionResults",
"type": "ref"
}
},
"type": "procedure"
}
},
"description": "Search a provider's catalog using text and structured hints. Fuzzy matching, field interpretation, and ranking are provider-specific. This operation does not write user records.",
"id": "community.lexicon.media.book.searchEditions",
"lexicon": 1
}