fm.leadsheet.sheet
Schema Diff
+18 -2
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 6 non-breaking changes.
Breaking Changes (1)
- 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 (6)
- 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" }
- 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.links", tgt: "fm.leadsheet.sheet:body.links:items", kind: "items", name: None }
Migration Guidance
Added Elements
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" }
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\"]" }
Additional Notes
- 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.links", tgt: "fm.leadsheet.sheet:body.links:items", kind: "items", 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": {
96
112
"description": "How the instrument (see `kind`) is tuned. Unset or 'standard' is that instrument's standard: EADGBE guitar, GCEA ukulele, EADG bass.",
97
113
"knownValues": [
98
114
"standard",
99
115
"eb-standard",
100
116
"d-standard",
101
117
"drop-d",
102
118
"drop-c",
103
119
"dadgad",
104
120
"open-d",
105
121
"open-g",
106
122
"open-e",
107
123
"open-c",
108
124
"low-g",
109
125
"baritone",
110
126
"five-string"
111
127
],
112
128
"maxLength": 64,
113
129
"type": "string"
114
130
},
115
131
"updatedAt": {
116
132
"format": "datetime",
117
133
"type": "string"
118
134
},
119
135
"voicings": {
120
136
"description": "Chord shapes the author chose, at most one per chord. Readers see these instead of the shapes the app would pick.",
121
137
"items": {
122
138
"ref": "#voicing",
123
139
"type": "ref"
124
140
},
125
141
"maxLength": 100,
126
142
"type": "array"
127
143
}
128
144
},
129
145
"required": [
130
146
"title",
131
147
"artist",
132
148
"content",
133
149
"createdAt"
134
150
],
135
151
"type": "object"
136
152
},
137
153
"type": "record"
138
154
},
139
155
"voicing": {
140
156
"description": "How to play one chord of the sheet.",
141
157
"properties": {
142
158
"chord": {
143
159
"description": "The chord as written in `content`, e.g. 'C' or 'F#m7'.",
144
160
"maxLength": 64,
145
161
"type": "string"
146
162
},
147
163
"frets": {
148
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.",
149
165
"items": {
150
166
"maximum": 24,
151
167
"minimum": -1,
152
168
"type": "integer"
153
169
},
154
170
"maxLength": 12,
155
171
"minLength": 1,
156
172
"type": "array"
157
173
}
158
174
},
159
175
"required": [
160
176
"chord",
161
177
"frets"
162
178
],
163
179
"type": "object"
164
180
}
165
181
},
166
182
"description": "A chord sheet or tab for a song, written in ChordPro.",
167
183
"id": "fm.leadsheet.sheet",
168
184
"lexicon": 1
169
185
}