forked from
npmx.dev/npmx.dev
[READ-ONLY]
a fast, modern browser for the npm registry
1{
2 "id": "site.standard.document",
3 "defs": {
4 "main": {
5 "key": "tid",
6 "type": "record",
7 "record": {
8 "type": "object",
9 "required": ["site", "title", "publishedAt"],
10 "properties": {
11 "path": {
12 "type": "string",
13 "description": "Combine with site or publication url to construct a canonical URL to the document. Prepend with a leading slash."
14 },
15 "site": {
16 "type": "string",
17 "format": "uri",
18 "description": "Points to a publication record (at://) or a publication url (https://) for loose documents. Avoid trailing slashes."
19 },
20 "tags": {
21 "type": "array",
22 "items": {
23 "type": "string"
24 },
25 "maxLength": 1280,
26 "description": "Array of strings used to tag or categorize the document. Avoid prepending tags with hashtags.",
27 "maxGraphemes": 128
28 },
29 "title": {
30 "type": "string",
31 "maxLength": 5000,
32 "description": "Title of the document.",
33 "maxGraphemes": 500
34 },
35 "content": {
36 "refs": [],
37 "type": "union",
38 "closed": false,
39 "description": "Open union used to define the record's content. Each entry must specify a $type and may be extended with other lexicons to support additional content formats."
40 },
41 "updatedAt": {
42 "type": "string",
43 "format": "datetime",
44 "description": "Timestamp of the documents last edit."
45 },
46 "coverImage": {
47 "type": "blob",
48 "accept": ["image/*"],
49 "maxSize": 1000000,
50 "description": "Image to used for thumbnail or cover image. Less than 1MB is size."
51 },
52 "bskyPostRef": {
53 "ref": "com.atproto.repo.strongRef",
54 "type": "ref",
55 "description": "Strong reference to a Bluesky post. Useful to keep track of comments off-platform."
56 },
57 "description": {
58 "type": "string",
59 "maxLength": 30000,
60 "description": "A brief description or excerpt from the document.",
61 "maxGraphemes": 3000
62 },
63 "publishedAt": {
64 "type": "string",
65 "format": "datetime",
66 "description": "Timestamp of the documents publish time."
67 },
68 "textContent": {
69 "type": "string",
70 "description": "Plaintext representation of the documents contents. Should not contain markdown or other formatting."
71 }
72 }
73 },
74 "description": "A document record representing a published article, blog post, or other content. Documents can belong to a publication or exist independently."
75 }
76 },
77 "$type": "com.atproto.lexicon.schema",
78 "lexicon": 1
79}