garden.lexicon.documentation
Schema Diff
+1 -1
1
1
{
2
2
"id": "garden.lexicon.documentation",
3
3
"defs": {
4
4
"main": {
5
-
"key": "tid",
5
+
"key": "nsid",
6
6
"type": "record",
7
7
"record": {
8
8
"type": "object",
9
9
"required": [
10
10
"lexicon",
11
11
"createdAt"
12
12
],
13
13
"properties": {
14
14
"lexicon": {
15
15
"type": "string",
16
16
"format": "nsid",
17
17
"description": "The NSID of the lexicon being documented."
18
18
},
19
19
"createdAt": {
20
20
"type": "string",
21
21
"format": "datetime",
22
22
"description": "Timestamp when this documentation was created."
23
23
},
24
24
"definitions": {
25
25
"type": "array",
26
26
"items": {
27
27
"ref": "#definitionDoc",
28
28
"type": "ref"
29
29
},
30
30
"description": "Documentation for specific definitions within the lexicon (e.g., main, replyRef)."
31
31
},
32
32
"description": {
33
33
"type": "array",
34
34
"items": {
35
35
"ref": "#localizedString",
36
36
"type": "ref"
37
37
},
38
38
"description": "Localized descriptions for the lexicon."
39
39
}
40
40
}
41
41
},
42
42
"description": "Auxiliary documentation for a lexicon schema, supporting localized descriptions for the lexicon and its properties."
43
43
},
44
44
"propertyDoc": {
45
45
"type": "object",
46
46
"required": [
47
47
"name"
48
48
],
49
49
"properties": {
50
50
"name": {
51
51
"type": "string",
52
52
"maxLength": 256,
53
53
"description": "The property name being documented."
54
54
},
55
55
"description": {
56
56
"type": "array",
57
57
"items": {
58
58
"ref": "#localizedString",
59
59
"type": "ref"
60
60
},
61
61
"description": "Localized descriptions for this property."
62
62
}
63
63
},
64
64
"description": "Documentation for a specific property within a definition."
65
65
},
66
66
"definitionDoc": {
67
67
"type": "object",
68
68
"required": [
69
69
"name"
70
70
],
71
71
"properties": {
72
72
"name": {
73
73
"type": "string",
74
74
"maxLength": 512,
75
75
"description": "The name of the definition being documented (e.g., 'main', 'replyRef')."
76
76
},
77
77
"properties": {
78
78
"type": "array",
79
79
"items": {
80
80
"ref": "#propertyDoc",
81
81
"type": "ref"
82
82
},
83
83
"description": "Documentation for properties within this definition."
84
84
},
85
85
"description": {
86
86
"type": "array",
87
87
"items": {
88
88
"ref": "#localizedString",
89
89
"type": "ref"
90
90
},
91
91
"description": "Localized descriptions for this definition."
92
92
}
93
93
},
94
94
"description": "Documentation for a definition within a lexicon."
95
95
},
96
96
"localizedString": {
97
97
"type": "object",
98
98
"required": [
99
99
"lang",
100
100
"value"
101
101
],
102
102
"properties": {
103
103
"lang": {
104
104
"type": "string",
105
105
"format": "language",
106
106
"description": "ISO 639 language code (e.g., 'en', 'es', 'ja')."
107
107
},
108
108
"value": {
109
109
"type": "string",
110
110
"maxLength": 10000,
111
111
"description": "The localized string value."
112
112
}
113
113
},
114
114
"description": "A string with an associated language code."
115
115
}
116
116
},
117
117
"$type": "com.atproto.lexicon.schema",
118
118
"lexicon": 1
119
119
}