org.passingreads.book.registration
Schema Diff
+12 -0
Compatibility Analysis
Backward Compatible
Backward compatible. 12 non-breaking changes.
Non-Breaking Changes (12)
- AddedVertex AddedVertex { vertex_id: "community.lexicon.location.hthree#main" }
- AddedVertex AddedVertex { vertex_id: "org.passingreads.book.event#osmLocation" }
- AddedVertex AddedVertex { vertex_id: "org.passingreads.book.registration:body.kept" }
- AddedVertex AddedVertex { vertex_id: "org.passingreads.book.registration:body.location" }
- AddedVertex AddedVertex { vertex_id: "org.passingreads.book.registration:body.location:variant0" }
- AddedVertex AddedVertex { vertex_id: "org.passingreads.book.registration:body.location:variant1" }
- AddedEdge AddedEdge { src: "org.passingreads.book.registration:body", tgt: "org.passingreads.book.registration:body.kept", kind: "prop", name: Some("kept") }
- AddedEdge AddedEdge { src: "org.passingreads.book.registration:body", tgt: "org.passingreads.book.registration:body.location", kind: "prop", name: Some("location") }
- AddedEdge AddedEdge { src: "org.passingreads.book.registration:body.location", tgt: "org.passingreads.book.registration:body.location:variant0", kind: "variant", name: Some("community.lexicon.location.hthree#main") }
- AddedEdge AddedEdge { src: "org.passingreads.book.registration:body.location", tgt: "org.passingreads.book.registration:body.location:variant1", kind: "variant", name: Some("org.passingreads.book.event#osmLocation") }
- AddedEdge AddedEdge { src: "org.passingreads.book.registration:body.location:variant0", tgt: "community.lexicon.location.hthree#main", kind: "ref", name: None }
- AddedEdge AddedEdge { src: "org.passingreads.book.registration:body.location:variant1", tgt: "org.passingreads.book.event#osmLocation", kind: "ref", name: None }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "community.lexicon.location.hthree#main" }AddedVertex { vertex_id: "org.passingreads.book.event#osmLocation" }AddedVertex { vertex_id: "org.passingreads.book.registration:body.kept" }AddedVertex { vertex_id: "org.passingreads.book.registration:body.location" }AddedVertex { vertex_id: "org.passingreads.book.registration:body.location:variant0" }AddedVertex { vertex_id: "org.passingreads.book.registration:body.location:variant1" }
Additional Notes
- Non-breaking: AddedEdge { src: "org.passingreads.book.registration:body", tgt: "org.passingreads.book.registration:body.kept", kind: "prop", name: Some("kept") }
- Non-breaking: AddedEdge { src: "org.passingreads.book.registration:body", tgt: "org.passingreads.book.registration:body.location", kind: "prop", name: Some("location") }
- Non-breaking: AddedEdge { src: "org.passingreads.book.registration:body.location", tgt: "org.passingreads.book.registration:body.location:variant0", kind: "variant", name: Some("community.lexicon.location.hthree#main") }
- Non-breaking: AddedEdge { src: "org.passingreads.book.registration:body.location", tgt: "org.passingreads.book.registration:body.location:variant1", kind: "variant", name: Some("org.passingreads.book.event#osmLocation") }
- Non-breaking: AddedEdge { src: "org.passingreads.book.registration:body.location:variant0", tgt: "community.lexicon.location.hthree#main", kind: "ref", name: None }
- Non-breaking: AddedEdge { src: "org.passingreads.book.registration:body.location:variant1", tgt: "org.passingreads.book.event#osmLocation", kind: "ref", name: None }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
5
"description": "A book that has been registered on PassingReads",
6
6
"key": "any",
7
7
"record": {
8
8
"properties": {
9
9
"aspectRatio": {
10
10
"description": "Aspect ratio of the cover image",
11
11
"ref": "org.passingreads.defs#aspectRatio",
12
12
"type": "ref"
13
13
},
14
14
"authors": {
15
15
"description": "Authors of this book, in order of credit. An empty array implies a book of anonymous or unknown authorship.",
16
16
"items": {
17
17
"maxLength": 512,
18
18
"minLength": 1,
19
19
"type": "string"
20
20
},
21
21
"type": "array"
22
22
},
23
23
"bookId": {
24
24
"description": "The book's ID (as defined on its QR Code)",
25
25
"type": "string"
26
26
},
27
27
"cover": {
28
28
"accept": [
29
29
"image/png",
30
30
"image/jpeg"
31
31
],
32
32
"description": "Cover image of the book",
33
33
"maxSize": 1000000,
34
34
"type": "blob"
35
35
},
36
+
"kept": {
37
+
"description": "Whether the registrant is keeping the book. Absent means true, so records written before this field existed still read as kept. When false the book starts its journey at `location` rather than in the registrant's library.",
38
+
"type": "boolean"
39
+
},
40
+
"location": {
41
+
"description": "Where the book is at the moment it is registered.",
42
+
"refs": [
43
+
"community.lexicon.location.hthree#main",
44
+
"org.passingreads.book.event#osmLocation"
45
+
],
46
+
"type": "union"
47
+
},
36
48
"occurredAt": {
37
49
"format": "datetime",
38
50
"type": "string"
39
51
},
40
52
"publicationId": {
41
53
"description": "The book's Open Library Edition ID",
42
54
"type": "string"
43
55
},
44
56
"signatures": {
45
57
"description": "Inline attestations binding this record to the book's keypair.",
46
58
"items": {
47
59
"ref": "org.passingreads.signature.book#main",
48
60
"type": "ref"
49
61
},
50
62
"minLength": 1,
51
63
"type": "array"
52
64
},
53
65
"title": {
54
66
"description": "The title of the book",
55
67
"maxLength": 512,
56
68
"minLength": 1,
57
69
"type": "string"
58
70
}
59
71
},
60
72
"required": [
61
73
"bookId",
62
74
"title",
63
75
"authors",
64
76
"publicationId",
65
77
"signatures",
66
78
"occurredAt"
67
79
],
68
80
"type": "object"
69
81
},
70
82
"type": "record"
71
83
}
72
84
},
73
85
"id": "org.passingreads.book.registration",
74
86
"lexicon": 1
75
87
}