A loose federation of distributed, typed datasets
docs: enhance sampleSchema lexicon with detailed field descriptions and metadata structure
Improved documentation and structure for sampleSchema lexicon:
- Clarified name field as display name, NSID provides unique identification
- Added structured metadata schema with author, license, tags properties
- Added size constraints (maxProperties, maxLength) to metadata fields
- Enhanced previousVersion/migrationLens relationship documentation
- Documented createdAt field immutability guarantee
- Added 'rkey' to VSCode dictionary
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
+28
-5
.chainlink/issues.db
.chainlink/issues.db
This is a binary file and will not be displayed.
+27
-5
.planning/lexicons/ac.foundation.dataset.sampleSchema.json
+27
-5
.planning/lexicons/ac.foundation.dataset.sampleSchema.json
···
18
18
"properties": {
19
19
"name": {
20
20
"type": "string",
21
-
"description": "Human-readable name for this sample type",
21
+
"description": "Human-readable display name for this sample type. Used for documentation and UI. The NSID in the record URI provides unique identification; name collisions across NSIDs are acceptable.",
22
22
"maxLength": 100
23
23
},
24
24
"version": {
···
65
65
},
66
66
"metadata": {
67
67
"type": "object",
68
-
"description": "Arbitrary metadata (author, license, tags, etc.)"
68
+
"description": "Optional metadata about this schema. Common fields include author, license, and tags, but any additional fields are permitted.",
69
+
"maxProperties": 50,
70
+
"properties": {
71
+
"author": {
72
+
"type": "string",
73
+
"description": "Creator of this schema (DID, handle, or name)",
74
+
"maxLength": 200
75
+
},
76
+
"license": {
77
+
"type": "string",
78
+
"description": "License identifier (e.g., MIT, Apache-2.0, CC-BY-4.0)",
79
+
"maxLength": 100
80
+
},
81
+
"tags": {
82
+
"type": "array",
83
+
"description": "Categorization tags for discovery",
84
+
"items": {
85
+
"type": "string",
86
+
"maxLength": 50
87
+
},
88
+
"maxLength": 20
89
+
}
90
+
}
69
91
},
70
92
"previousVersion": {
71
93
"type": "string",
72
94
"format": "at-uri",
73
-
"description": "AT-URI reference to the previous version of this schema (if any)",
95
+
"description": "AT-URI reference to the previous version of this schema. Used to track schema evolution history. May exist without migrationLens if changes are backward-compatible.",
74
96
"maxLength": 500
75
97
},
76
98
"migrationLens": {
77
99
"type": "string",
78
100
"format": "at-uri",
79
-
"description": "AT-URI reference to a Lens for migrating from previous version (if applicable)",
101
+
"description": "AT-URI reference to a Lens for migrating data from previousVersion to this version. Required only for breaking changes; optional for backward-compatible updates.",
80
102
"maxLength": 500
81
103
},
82
104
"createdAt": {
83
105
"type": "string",
84
106
"format": "datetime",
85
-
"description": "Timestamp when this schema version was created"
107
+
"description": "Timestamp when this schema version was created. Immutable once set (ATProto records are permanent)."
86
108
}
87
109
}
88
110
}