buzz.bookhive.getBook
Schema Diff
+13 -4
1
1
{
2
2
"id": "buzz.bookhive.getBook",
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
"book",
11
11
"reviews",
12
12
"comments"
13
13
],
14
14
"properties": {
15
15
"book": {
16
16
"ref": "buzz.bookhive.hiveBook#record",
17
17
"type": "ref",
18
18
"description": "The hive book's info"
19
19
},
20
20
"cover": {
21
21
"type": "blob",
22
22
"accept": [
23
23
"image/png",
24
24
"image/jpeg"
25
25
],
26
26
"maxSize": 1000000,
27
27
"description": "Cover image of the book"
28
28
},
29
29
"stars": {
30
30
"type": "integer",
31
31
"maximum": 10,
32
32
"minimum": 1,
33
33
"description": "Number of stars given to the book (1-10) which will be mapped to 1-5 stars"
34
34
},
35
35
"review": {
36
36
"type": "string",
37
37
"description": "The book's review",
38
38
"maxGraphemes": 15000
39
39
},
40
40
"status": {
41
41
"type": "string",
42
42
"knownValues": [
43
43
"buzz.bookhive.defs#finished",
44
44
"buzz.bookhive.defs#reading",
45
45
"buzz.bookhive.defs#wantToRead",
46
46
"buzz.bookhive.defs#abandoned",
47
47
"buzz.bookhive.defs#owned"
48
48
]
49
49
},
50
50
"reviews": {
51
51
"type": "array",
52
52
"items": {
53
53
"ref": "buzz.bookhive.defs#review",
54
54
"type": "ref"
55
55
},
56
56
"description": "Reviews of the book"
57
57
},
58
58
"activity": {
59
59
"type": "array",
60
60
"items": {
61
61
"ref": "buzz.bookhive.defs#activity",
62
62
"type": "ref"
63
63
},
64
64
"description": "Other users' activity on the book"
65
65
},
66
66
"comments": {
67
67
"type": "array",
68
68
"items": {
69
69
"ref": "buzz.bookhive.defs#comment",
70
70
"type": "ref"
71
71
},
72
72
"description": "Comments on the book"
73
73
},
74
74
"createdAt": {
75
75
"type": "string",
76
76
"format": "datetime"
77
77
},
78
78
"startedAt": {
79
79
"type": "string",
80
80
"format": "datetime",
81
81
"description": "The date the user started reading the book"
82
82
},
83
83
"finishedAt": {
84
84
"type": "string",
85
85
"format": "datetime",
86
86
"description": "The date the user finished reading the book"
87
87
},
88
88
"bookProgress": {
89
89
"ref": "buzz.bookhive.defs#bookProgress",
90
90
"type": "ref",
91
91
"description": "Reading progress for the user"
92
92
}
93
93
}
94
94
},
95
95
"encoding": "application/json"
96
96
},
97
97
"parameters": {
98
98
"type": "params",
99
-
"required": [
100
-
"id"
101
-
],
102
99
"properties": {
103
100
"id": {
104
101
"type": "string",
105
102
"description": "The book's hive ID"
103
+
},
104
+
"isbn": {
105
+
"type": "string",
106
+
"description": "The book ISBN identifier"
107
+
},
108
+
"isbn13": {
109
+
"type": "string",
110
+
"description": "The book ISBN-13 identifier"
111
+
},
112
+
"goodreadsId": {
113
+
"type": "string",
114
+
"description": "The Goodreads identifier for the book"
106
115
}
107
116
}
108
117
},
109
-
"description": "Get a book's info. Requires authentication."
118
+
"description": "Get a book's info. Does not require authentication."
110
119
}
111
120
},
112
121
"$type": "com.atproto.lexicon.schema",
113
122
"lexicon": 1
114
123
}