a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto
bluesky
typescript
npm
docs(lexicon-doc): JSON schema
+29
+29
packages/lexicons/lexicon-doc/README.md
+29
packages/lexicons/lexicon-doc/README.md
···
97
97
},
98
98
});
99
99
```
100
+
101
+
## JSON schema
102
+
103
+
this package also provides JSON schemas for authoring lexicon documents, add a `$schema` property to
104
+
your document:
105
+
106
+
```json
107
+
{
108
+
"$schema": "https://unpkg.com/@atcute/lexicon-doc/schema/lexicon-doc.schema.json",
109
+
"lexicon": 1,
110
+
"id": "com.example.link",
111
+
"defs": {
112
+
"main": {
113
+
"type": "record",
114
+
"description": "a link submission",
115
+
"key": "tid",
116
+
"record": {
117
+
"type": "object",
118
+
"required": ["url", "createdAt"],
119
+
"properties": {
120
+
"title": { "type": "string", "maxLength": 300 },
121
+
"url": { "type": "string", "format": "uri" },
122
+
"createdAt": { "type": "string", "format": "datetime" }
123
+
}
124
+
}
125
+
}
126
+
}
127
+
}
128
+
```