buzz.bookhive.searchBooks
Schema Diff
+4 -0
Compatibility Analysis
Backward Compatible
Backward compatible. 2 non-breaking changes.
Non-Breaking Changes (2)
- AddedVertex AddedVertex { vertex_id: "buzz.bookhive.searchBooks:output.userStatuses" }
- AddedEdge AddedEdge { src: "buzz.bookhive.searchBooks:output", tgt: "buzz.bookhive.searchBooks:output.userStatuses", kind: "prop", name: Some("userStatuses") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "buzz.bookhive.searchBooks:output.userStatuses" }
Additional Notes
- Non-breaking: AddedEdge { src: "buzz.bookhive.searchBooks:output", tgt: "buzz.bookhive.searchBooks:output.userStatuses", kind: "prop", name: Some("userStatuses") }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
5
"description": "Find books matching the search criteria. Does not require authentication.",
6
6
"output": {
7
7
"encoding": "application/json",
8
8
"schema": {
9
9
"properties": {
10
10
"books": {
11
11
"items": {
12
12
"ref": "buzz.bookhive.hiveBook#main",
13
13
"type": "ref"
14
14
},
15
15
"type": "array"
16
16
},
17
17
"offset": {
18
18
"description": "The next offset to use for pagination (result of limit + offset)",
19
19
"type": "integer"
20
+
},
21
+
"userStatuses": {
22
+
"description": "Map of hiveId to the current user's reading status for that book. Only present when authenticated.",
23
+
"type": "unknown"
20
24
}
21
25
},
22
26
"required": [
23
27
"books"
24
28
],
25
29
"type": "object"
26
30
}
27
31
},
28
32
"parameters": {
29
33
"properties": {
30
34
"genre": {
31
35
"description": "Filter by genre. Returns books in that genre. Can be used with or without q.",
32
36
"type": "string"
33
37
},
34
38
"id": {
35
39
"description": "The ID of the book within the hive.",
36
40
"type": "string"
37
41
},
38
42
"limit": {
39
43
"default": 25,
40
44
"maximum": 100,
41
45
"minimum": 1,
42
46
"type": "integer"
43
47
},
44
48
"offset": {
45
49
"description": "Offset for pagination into the result set",
46
50
"type": "integer"
47
51
},
48
52
"q": {
49
53
"description": "Search query string. Will be matched against title and authors fields.",
50
54
"type": "string"
51
55
}
52
56
},
53
57
"required": [],
54
58
"type": "params"
55
59
},
56
60
"type": "query"
57
61
}
58
62
},
59
63
"id": "buzz.bookhive.searchBooks",
60
64
"lexicon": 1
61
65
}