fm.leadsheet.sheet
Schema Diff
+58 -3
Compatibility Analysis
Breaking Changes Detected
4 breaking changes, 16 non-breaking changes.
Breaking Changes (4)
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "fm.leadsheet.sheet#voicing", src: "fm.leadsheet.sheet#voicing", tgt: "fm.leadsheet.sheet#voicing.chord", kind: "prop", name: Some("chord") }
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "fm.leadsheet.sheet#voicing", src: "fm.leadsheet.sheet#voicing", tgt: "fm.leadsheet.sheet#voicing.frets", kind: "prop", name: Some("frets") }
- ConstraintTightened ConstraintTightened { vertex_id: "fm.leadsheet.sheet:body.tuning", sort: "knownValues", old_value: "[\"standard\",\"eb-standard\",\"d-standard\",\"drop-d\",\"drop-c\",\"dadgad\",\"open-d\",\"open-g\",\"open-e\",\"open-c\"]", new_value: "[\"standard\",\"eb-standard\",\"d-standard\",\"drop-d\",\"drop-c\",\"dadgad\",\"open-d\",\"open-g\",\"open-e\",\"open-c\",\"low-g\",\"baritone\",\"five-string\"]" }
- ConstraintTightened ConstraintTightened { vertex_id: "fm.leadsheet.sheet:body.kind", sort: "knownValues", old_value: "[\"chords\",\"tab\",\"ukulele\",\"bass\"]", new_value: "[\"chords\",\"tab\",\"ukulele\",\"bass\",\"piano\"]" }
Non-Breaking Changes (16)
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet#voicing" }
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet#voicing.chord" }
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet#voicing.frets" }
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet#voicing.frets:items" }
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet:body.draft" }
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet:body.links" }
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet:body.links:items" }
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet:body.voicings" }
- AddedVertex AddedVertex { vertex_id: "fm.leadsheet.sheet:body.voicings:items" }
- AddedEdge AddedEdge { src: "fm.leadsheet.sheet#voicing.frets", tgt: "fm.leadsheet.sheet#voicing.frets:items", kind: "items", name: None }
- AddedEdge AddedEdge { src: "fm.leadsheet.sheet:body", tgt: "fm.leadsheet.sheet:body.draft", kind: "prop", name: Some("draft") }
- AddedEdge AddedEdge { src: "fm.leadsheet.sheet:body", tgt: "fm.leadsheet.sheet:body.links", kind: "prop", name: Some("links") }
- AddedEdge AddedEdge { src: "fm.leadsheet.sheet:body", tgt: "fm.leadsheet.sheet:body.voicings", kind: "prop", name: Some("voicings") }
- AddedEdge AddedEdge { src: "fm.leadsheet.sheet:body.links", tgt: "fm.leadsheet.sheet:body.links:items", kind: "items", name: None }
- AddedEdge AddedEdge { src: "fm.leadsheet.sheet:body.voicings", tgt: "fm.leadsheet.sheet:body.voicings:items", kind: "items", name: None }
- AddedEdge AddedEdge { src: "fm.leadsheet.sheet:body.voicings:items", tgt: "fm.leadsheet.sheet#voicing", kind: "ref", name: None }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "fm.leadsheet.sheet#voicing" }AddedVertex { vertex_id: "fm.leadsheet.sheet#voicing.chord" }AddedVertex { vertex_id: "fm.leadsheet.sheet#voicing.frets" }AddedVertex { vertex_id: "fm.leadsheet.sheet#voicing.frets:items" }AddedVertex { vertex_id: "fm.leadsheet.sheet:body.draft" }AddedVertex { vertex_id: "fm.leadsheet.sheet:body.links" }AddedVertex { vertex_id: "fm.leadsheet.sheet:body.links:items" }AddedVertex { vertex_id: "fm.leadsheet.sheet:body.voicings" }AddedVertex { vertex_id: "fm.leadsheet.sheet:body.voicings:items" }
Constraint Changes
- ConstraintTightened ConstraintTightened { vertex_id: "fm.leadsheet.sheet:body.kind", sort: "knownValues", old_value: "[\"chords\",\"tab\",\"ukulele\",\"bass\"]", new_value: "[\"chords\",\"tab\",\"ukulele\",\"bass\",\"piano\"]" }
- ConstraintTightened ConstraintTightened { vertex_id: "fm.leadsheet.sheet:body.tuning", sort: "knownValues", old_value: "[\"standard\",\"eb-standard\",\"d-standard\",\"drop-d\",\"drop-c\",\"dadgad\",\"open-d\",\"open-g\",\"open-e\",\"open-c\"]", new_value: "[\"standard\",\"eb-standard\",\"d-standard\",\"drop-d\",\"drop-c\",\"dadgad\",\"open-d\",\"open-g\",\"open-e\",\"open-c\",\"low-g\",\"baritone\",\"five-string\"]" }
Additional Notes
- Breaking: RequiredEdgeAdded { vertex_id: "fm.leadsheet.sheet#voicing", src: "fm.leadsheet.sheet#voicing", tgt: "fm.leadsheet.sheet#voicing.chord", kind: "prop", name: Some("chord") }
- Breaking: RequiredEdgeAdded { vertex_id: "fm.leadsheet.sheet#voicing", src: "fm.leadsheet.sheet#voicing", tgt: "fm.leadsheet.sheet#voicing.frets", kind: "prop", name: Some("frets") }
- Non-breaking: AddedEdge { src: "fm.leadsheet.sheet#voicing.frets", tgt: "fm.leadsheet.sheet#voicing.frets:items", kind: "items", name: None }
- Non-breaking: AddedEdge { src: "fm.leadsheet.sheet:body", tgt: "fm.leadsheet.sheet:body.draft", kind: "prop", name: Some("draft") }
- Non-breaking: AddedEdge { src: "fm.leadsheet.sheet:body", tgt: "fm.leadsheet.sheet:body.links", kind: "prop", name: Some("links") }
- Non-breaking: AddedEdge { src: "fm.leadsheet.sheet:body", tgt: "fm.leadsheet.sheet:body.voicings", kind: "prop", name: Some("voicings") }
- Non-breaking: AddedEdge { src: "fm.leadsheet.sheet:body.links", tgt: "fm.leadsheet.sheet:body.links:items", kind: "items", name: None }
- Non-breaking: AddedEdge { src: "fm.leadsheet.sheet:body.voicings", tgt: "fm.leadsheet.sheet:body.voicings:items", kind: "items", name: None }
- Non-breaking: AddedEdge { src: "fm.leadsheet.sheet:body.voicings:items", tgt: "fm.leadsheet.sheet#voicing", kind: "ref", name: None }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
5
"description": "A chord sheet or tab for a song, written in ChordPro.",
6
6
"key": "tid",
7
7
"record": {
8
8
"properties": {
9
9
"album": {
10
10
"maxGraphemes": 200,
11
11
"maxLength": 1000,
12
12
"type": "string"
13
13
},
14
14
"artist": {
15
15
"description": "Performing artist, as credited on the recording this sheet follows.",
16
16
"maxGraphemes": 200,
17
17
"maxLength": 1000,
18
18
"type": "string"
19
19
},
20
20
"capo": {
21
21
"maximum": 12,
22
22
"minimum": 0,
23
23
"type": "integer"
24
24
},
25
25
"content": {
26
26
"maxGraphemes": 50000,
27
27
"maxLength": 100000,
28
28
"type": "string"
29
29
},
30
30
"createdAt": {
31
31
"format": "datetime",
32
32
"type": "string"
33
33
},
34
34
"description": {
35
35
"description": "Author's notes: strumming pattern, how the intro is played, etc.",
36
36
"maxGraphemes": 3000,
37
37
"maxLength": 10000,
38
38
"type": "string"
39
39
},
40
40
"difficulty": {
41
41
"knownValues": [
42
42
"beginner",
43
43
"intermediate",
44
44
"advanced"
45
45
],
46
46
"maxLength": 32,
47
47
"type": "string"
48
48
},
49
+
"draft": {
50
+
"default": false,
51
+
"description": "Not published yet: apps list and search only published sheets, and show a draft only to its author. Like any record, a draft is still publicly readable from the author's repo.",
52
+
"type": "boolean"
53
+
},
49
54
"forkOf": {
50
55
"description": "The sheet this one was derived from, as it was when forked.",
51
56
"ref": "com.atproto.repo.strongRef",
52
57
"type": "ref"
53
58
},
54
59
"format": {
55
60
"default": "chordpro",
56
61
"description": "Markup of `content`. ChordPro: inline [C]hords, {directives}, and {start_of_tab} blocks.",
57
62
"knownValues": [
58
63
"chordpro"
59
64
],
60
65
"maxLength": 64,
61
66
"type": "string"
62
67
},
63
68
"key": {
64
69
"description": "Key the sheet is written in, e.g. 'G' or 'F#m'.",
65
70
"maxLength": 16,
66
71
"type": "string"
67
72
},
68
73
"kind": {
69
74
"default": "chords",
70
-
"description": "What the sheet is for: chords over lyrics, guitar tablature, ukulele chords, or bass.",
75
+
"description": "What the sheet is for: chords over lyrics (guitar), guitar tablature, ukulele chords, bass, or piano.",
71
76
"knownValues": [
72
77
"chords",
73
78
"tab",
74
79
"ukulele",
75
-
"bass"
80
+
"bass",
81
+
"piano"
76
82
],
77
83
"maxLength": 64,
78
84
"type": "string"
79
85
},
86
+
"links": {
87
+
"description": "Where to hear the recording this sheet follows: YouTube, Bandcamp, SoundCloud, a streaming service. http(s) URLs.",
88
+
"items": {
89
+
"format": "uri",
90
+
"maxLength": 2000,
91
+
"type": "string"
92
+
},
93
+
"maxLength": 5,
94
+
"type": "array"
95
+
},
80
96
"tags": {
81
97
"items": {
82
98
"maxGraphemes": 64,
83
99
"maxLength": 640,
84
100
"type": "string"
85
101
},
86
102
"maxLength": 10,
87
103
"type": "array"
88
104
},
89
105
"title": {
90
106
"description": "Song title.",
91
107
"maxGraphemes": 200,
92
108
"maxLength": 1000,
93
109
"type": "string"
94
110
},
95
111
"tuning": {
112
+
"description": "How the instrument (see `kind`) is tuned. Unset or 'standard' is that instrument's standard: EADGBE guitar, GCEA ukulele, EADG bass.",
96
113
"knownValues": [
97
114
"standard",
98
115
"eb-standard",
99
116
"d-standard",
100
117
"drop-d",
101
118
"drop-c",
102
119
"dadgad",
103
120
"open-d",
104
121
"open-g",
105
122
"open-e",
106
-
"open-c"
123
+
"open-c",
124
+
"low-g",
125
+
"baritone",
126
+
"five-string"
107
127
],
108
128
"maxLength": 64,
109
129
"type": "string"
110
130
},
111
131
"updatedAt": {
112
132
"format": "datetime",
113
133
"type": "string"
134
+
},
135
+
"voicings": {
136
+
"description": "Chord shapes the author chose, at most one per chord. Readers see these instead of the shapes the app would pick.",
137
+
"items": {
138
+
"ref": "#voicing",
139
+
"type": "ref"
140
+
},
141
+
"maxLength": 100,
142
+
"type": "array"
114
143
}
115
144
},
116
145
"required": [
117
146
"title",
118
147
"artist",
119
148
"content",
120
149
"createdAt"
121
150
],
122
151
"type": "object"
123
152
},
124
153
"type": "record"
154
+
},
155
+
"voicing": {
156
+
"description": "How to play one chord of the sheet.",
157
+
"properties": {
158
+
"chord": {
159
+
"description": "The chord as written in `content`, e.g. 'C' or 'F#m7'.",
160
+
"maxLength": 64,
161
+
"type": "string"
162
+
},
163
+
"frets": {
164
+
"description": "Fret for each string, in chart order (low E side first on guitar and bass, G first on ukulele), in the sheet's tuning and relative to its capo: -1 = not played, 0 = open.",
165
+
"items": {
166
+
"maximum": 24,
167
+
"minimum": -1,
168
+
"type": "integer"
169
+
},
170
+
"maxLength": 12,
171
+
"minLength": 1,
172
+
"type": "array"
173
+
}
174
+
},
175
+
"required": [
176
+
"chord",
177
+
"frets"
178
+
],
179
+
"type": "object"
125
180
}
126
181
},
127
182
"description": "A chord sheet or tab for a song, written in ChordPro.",
128
183
"id": "fm.leadsheet.sheet",
129
184
"lexicon": 1
130
185
}