buzz.bookhive.addToList
Add a book to a list.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | bookhive.buzz |
| Indexed |
Checks
Validunlimited-stringdefs.main.input.schema.properties.hiveIdNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.input.schema.properties.listUriNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.cidNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.uriNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Add a book to a list.",
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"description": {
"description": "Optional note about this book in the list",
"maxLength": 5000,
"type": "string"
},
"hiveId": {
"description": "Hive ID of the book to add",
"type": "string"
},
"listUri": {
"description": "AT-URI of the list",
"type": "string"
},
"position": {
"description": "Position in the list (for ordered lists)",
"type": "integer"
}
},
"required": [
"listUri",
"hiveId"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"uri",
"cid"
],
"type": "object"
}
},
"type": "procedure"
}
},
"id": "buzz.bookhive.addToList",
"lexicon": 1
}