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