org.passingreads.book.defs
Schema Diff
+2 -2
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"id": "org.passingreads.book.defs",
3
3
"defs": {
4
4
"statefulBook": {
5
5
"type": "object",
6
6
"required": [
7
7
"uri",
8
8
"cid",
9
9
"registration",
10
10
"state",
11
11
"currentHolder"
12
12
],
13
13
"properties": {
14
14
"cid": {
15
15
"type": "string",
16
16
"description": "The CID of the book registration record"
17
17
},
18
18
"uri": {
19
19
"type": "string",
20
20
"format": "at-uri",
21
21
"description": "The AT URI of the book registration record"
22
22
},
23
23
"state": {
24
24
"type": "string",
25
25
"description": "The current state of the book, derived from the latest event",
26
26
"knownValues": [
27
27
"org.passingreads.book.checkin",
28
28
"org.passingreads.book.drop",
29
29
"org.passingreads.book.find",
30
30
"org.passingreads.book.registration"
31
31
]
32
32
},
33
33
"events": {
34
34
"type": "array",
35
35
"items": {
36
36
"ref": "#confirmedEvent",
37
37
"type": "ref"
38
38
},
39
39
"description": "List of confirmed events for this book, in chronological order"
40
40
},
41
41
"coverUrl": {
42
42
"type": "string",
43
43
"format": "uri",
44
44
"description": "Resolved URL to the cover image (from the registration blob)"
45
45
},
46
46
"aspectRatio": {
47
47
"ref": "org.passingreads.defs#aspectRatio",
48
48
"type": "ref",
49
49
"description": "Aspect ratio of the cover image"
50
50
},
51
51
"registration": {
52
52
"ref": "#registrationView",
53
53
"type": "ref",
54
54
"description": "The book registration data (without cryptographic fields)"
55
55
},
56
56
"currentHolder": {
57
57
"type": "string",
58
58
"format": "did",
59
59
"description": "The DID of the current holder of the book"
60
60
},
61
61
"currentLocation": {
62
62
"ref": "community.lexicon.location.hthree#main",
63
63
"type": "ref",
64
64
"description": "The current location of the book (only present if state is 'org.passingreads.book.drop')"
65
65
}
66
66
},
67
67
"description": "A book with its current state, combining registration data with computed state information."
68
68
},
69
69
"confirmedEvent": {
70
70
"type": "object",
71
71
"required": [
72
72
"uri",
73
73
"actor",
74
74
"event",
75
75
"location",
76
76
"occurredAt"
77
77
],
78
78
"properties": {
79
79
"uri": {
80
80
"type": "string",
81
81
"format": "at-uri",
82
82
"description": "The AT URI of this event record"
83
83
},
84
84
"actor": {
85
85
"ref": "org.passingreads.defs#actor",
86
86
"type": "ref",
87
87
"description": "The person who performed this event"
88
88
},
89
89
"event": {
90
90
"type": "string",
91
91
"description": "What event occurred",
92
92
"knownValues": [
93
93
"org.passingreads.book.checkin",
94
94
"org.passingreads.book.drop",
95
95
"org.passingreads.book.find"
96
96
]
97
97
},
98
98
"location": {
99
99
"ref": "community.lexicon.location.hthree#main",
100
100
"type": "ref",
101
101
"description": "Where this event occurred"
102
102
},
103
103
"occurredAt": {
104
104
"type": "string",
105
105
"format": "datetime",
106
106
"description": "When this event occurred"
107
107
}
108
108
},
109
-
"description": "A confirmed book event for display purposes. Omits cryptographic fields (bookPub, bookSig) and book reference since it's shown in context of a book."
109
+
"description": "A confirmed book event for display purposes. Omits the `signatures` array and book reference since it's shown in context of a book."
110
110
},
111
111
"registrationView": {
112
112
"type": "object",
113
113
"required": [
114
114
"registeredBy",
115
115
"bookId",
116
116
"title",
117
117
"authors",
118
118
"occurredAt"
119
119
],
120
120
"properties": {
121
121
"title": {
122
122
"type": "string",
123
123
"description": "The title of the book"
124
124
},
125
125
"bookId": {
126
126
"type": "string",
127
127
"description": "The book's ID (as defined on its QR Code)"
128
128
},
129
129
"authors": {
130
130
"type": "array",
131
131
"items": {
132
132
"type": "string"
133
133
},
134
134
"description": "Authors of this book, in order of credit"
135
135
},
136
136
"pageCount": {
137
137
"type": "integer",
138
138
"minimum": 1,
139
139
"description": "Number of pages in the book"
140
140
},
141
141
"occurredAt": {
142
142
"type": "string",
143
143
"format": "datetime",
144
144
"description": "When the book was registered"
145
145
},
146
146
"registeredBy": {
147
147
"ref": "org.passingreads.defs#actor",
148
148
"type": "ref",
149
149
"description": "The person who registered the book"
150
150
},
151
151
"publicationId": {
152
152
"type": "string",
153
153
"description": "The book's Open Library Edition ID"
154
154
}
155
155
},
156
-
"description": "A view of a book registration for API responses. Omits cryptographic fields (bookPub, bookSig) and the cover blob."
156
+
"description": "A view of a book registration for API responses. Omits the `signatures` array and the cover blob."
157
157
}
158
158
},
159
159
"$type": "com.atproto.lexicon.schema",
160
160
"lexicon": 1
161
161
}