space.highport.sites.defs
Schema Diff
+42 -9
Compatibility Analysis
Backward Compatible
Backward compatible. 13 non-breaking changes.
Non-Breaking Changes (13)
- AddedVertex AddedVertex { vertex_id: "space.highport.sites.defs#access" }
- AddedVertex AddedVertex { vertex_id: "space.highport.sites.defs#access.audience" }
- AddedVertex AddedVertex { vertex_id: "space.highport.sites.defs#access.audience:variant0" }
- AddedVertex AddedVertex { vertex_id: "space.highport.sites.defs#access.requireAuth" }
- AddedVertex AddedVertex { vertex_id: "space.highport.sites.defs#access.requireAuth:items" }
- AddedVertex AddedVertex { vertex_id: "space.highport.sites.defs#spaceMembers" }
- AddedVertex AddedVertex { vertex_id: "space.highport.sites.defs#wellKnown.standardSitePublication" }
- AddedEdge AddedEdge { src: "space.highport.sites.defs#access", tgt: "space.highport.sites.defs#access.audience", kind: "prop", name: Some("audience") }
- AddedEdge AddedEdge { src: "space.highport.sites.defs#access", tgt: "space.highport.sites.defs#access.requireAuth", kind: "prop", name: Some("requireAuth") }
- AddedEdge AddedEdge { src: "space.highport.sites.defs#access.audience", tgt: "space.highport.sites.defs#access.audience:variant0", kind: "variant", name: Some("space.highport.sites.defs#spaceMembers") }
- AddedEdge AddedEdge { src: "space.highport.sites.defs#access.audience:variant0", tgt: "space.highport.sites.defs#spaceMembers", kind: "ref", name: None }
- AddedEdge AddedEdge { src: "space.highport.sites.defs#access.requireAuth", tgt: "space.highport.sites.defs#access.requireAuth:items", kind: "items", name: None }
- AddedEdge AddedEdge { src: "space.highport.sites.defs#wellKnown", tgt: "space.highport.sites.defs#wellKnown.standardSitePublication", kind: "prop", name: Some("standardSitePublication") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "space.highport.sites.defs#access" }AddedVertex { vertex_id: "space.highport.sites.defs#access.audience" }AddedVertex { vertex_id: "space.highport.sites.defs#access.audience:variant0" }AddedVertex { vertex_id: "space.highport.sites.defs#access.requireAuth" }AddedVertex { vertex_id: "space.highport.sites.defs#access.requireAuth:items" }AddedVertex { vertex_id: "space.highport.sites.defs#spaceMembers" }AddedVertex { vertex_id: "space.highport.sites.defs#wellKnown.standardSitePublication" }
Additional Notes
- Non-breaking: AddedEdge { src: "space.highport.sites.defs#access", tgt: "space.highport.sites.defs#access.audience", kind: "prop", name: Some("audience") }
- Non-breaking: AddedEdge { src: "space.highport.sites.defs#access", tgt: "space.highport.sites.defs#access.requireAuth", kind: "prop", name: Some("requireAuth") }
- Non-breaking: AddedEdge { src: "space.highport.sites.defs#access.audience", tgt: "space.highport.sites.defs#access.audience:variant0", kind: "variant", name: Some("space.highport.sites.defs#spaceMembers") }
- Non-breaking: AddedEdge { src: "space.highport.sites.defs#access.audience:variant0", tgt: "space.highport.sites.defs#spaceMembers", kind: "ref", name: None }
- Non-breaking: AddedEdge { src: "space.highport.sites.defs#access.requireAuth", tgt: "space.highport.sites.defs#access.requireAuth:items", kind: "items", name: None }
- Non-breaking: AddedEdge { src: "space.highport.sites.defs#wellKnown", tgt: "space.highport.sites.defs#wellKnown.standardSitePublication", kind: "prop", name: Some("standardSitePublication") }
1
1
{
2
2
"id": "space.highport.sites.defs",
3
3
"defs": {
4
+
"access": {
5
+
"type": "object",
6
+
"properties": {
7
+
"audience": {
8
+
"refs": [
9
+
"space.highport.sites.defs#spaceMembers"
10
+
],
11
+
"type": "union",
12
+
"closed": true,
13
+
"description": "Who the requireAuth paths are for. Absent means any signed-in reader. Only meaningful alongside requireAuth. The union is closed so that a host which does not recognize an audience rejects the record instead of opening the gate to everyone."
14
+
},
15
+
"requireAuth": {
16
+
"type": "array",
17
+
"items": {
18
+
"type": "string",
19
+
"maxLength": 1024
20
+
},
21
+
"maxLength": 64,
22
+
"description": "Path prefixes that always require a signed-in reader and always bill that reader, whatever the owner budget says. Matched against the normalized request path, so a prefix covers everything under it. \"/\" gates the whole site, the same as an owner budget of zero."
23
+
}
24
+
},
25
+
"description": "Which parts of a site require a signed-in reader, and which readers qualify. Absent means nothing is gated and the owner budget decides every path, which suits most sites. This is content policy, not billing: it lives in the record, so it moves with the site and anyone can read it."
26
+
},
4
27
"manifest": {
5
28
"type": "object",
6
29
"required": [
7
30
"resources"
8
31
],
9
32
"properties": {
10
33
"name": {
11
34
"type": "string",
12
35
"maxLength": 1000,
13
-
"description": "Bundle name. Required when the manifest is a tile's content; optional for an inline site source.",
36
+
"description": "Bundle name. Required for tile content, optional for an inline site source.",
14
37
"maxGraphemes": 100
15
38
},
16
39
"resources": {
17
40
"type": "unknown",
18
-
"description": "Map of absolute request path (beginning with '/') to space.highport.sites.defs#resource. Lexicon has no map type. A '/' entry is required for tile content and recommended for sites."
41
+
"description": "Map of absolute request path (starting with '/') to space.highport.sites.defs#resource, since Lexicon has no map type. Tile content must have a '/' entry, and sites should."
19
42
}
20
43
},
21
-
"description": "A path-keyed bundle of resources — bard's camelCase subset of a MASL bundle-mode document. The inline source of a site, or the content of a tile."
44
+
"description": "A bundle of resources keyed by path, using bard's camelCase subset of a MASL bundle-mode document. It is a site's inline source or a tile's content."
22
45
},
23
46
"redirect": {
24
47
"type": "object",
25
48
"required": [
26
49
"from",
27
50
"to"
28
51
],
29
52
"properties": {
30
53
"to": {
31
54
"type": "string",
32
55
"maxLength": 2048,
33
-
"description": "Destination path. Must be an absolute path on this site that exists as a manifest key."
56
+
"description": "Destination path. Must be an absolute path that exists as a manifest key on this site."
34
57
},
35
58
"from": {
36
59
"type": "string",
37
60
"maxLength": 2048,
38
-
"description": "The request path to match, optionally including a query string. Matching is exact."
61
+
"description": "The request path to match, optionally with a query string. Must match exactly."
39
62
},
40
63
"status": {
41
64
"type": "integer",
42
65
"description": "Redirect status. Defaults to 302.",
43
66
"knownValues": [
44
67
301,
45
68
302,
46
69
307,
47
70
308
48
71
]
49
72
}
50
73
}
51
74
},
52
75
"resource": {
53
76
"type": "object",
54
77
"required": [
55
78
"src"
56
79
],
57
80
"properties": {
58
81
"src": {
59
82
"type": "blob",
60
83
"description": "The blob holding this resource's bytes."
61
84
},
62
85
"status": {
63
86
"type": "integer",
64
87
"description": "Response status. Defaults to 200 for manifest entries and 404 for the notFound resource.",
65
88
"knownValues": [
66
89
200,
67
90
404,
68
91
410
69
92
]
70
93
},
71
94
"contentType": {
72
95
"type": "string",
73
96
"maxLength": 255,
74
-
"description": "Serve the asset with this content type instead of the blob's mimeType."
97
+
"description": "Content type to serve instead of the blob's mimeType."
75
98
},
76
99
"contentEncoding": {
77
100
"type": "string",
78
-
"description": "Declares the stored blob is already encoded with this algorithm; the origin serves it as-is with a matching Content-Encoding header.",
101
+
"description": "The encoding the stored blob already has. The origin serves it unchanged, with a matching Content-Encoding header.",
79
102
"knownValues": [
80
103
"gzip",
81
104
"br",
82
105
"zstd",
83
106
"identity"
84
107
]
85
108
}
86
109
},
87
-
"description": "A single addressable resource within a manifest."
110
+
"description": "One addressable resource in a manifest."
88
111
},
89
112
"wellKnown": {
90
113
"type": "object",
91
114
"properties": {
92
115
"rasl": {
93
116
"type": "boolean",
94
117
"description": "Serve GET /.well-known/rasl/{cid} for every CID this site references. Default true."
95
118
},
96
119
"atproto": {
97
120
"type": "boolean",
98
121
"description": "Serve GET /.well-known/atproto-did with the site's owning DID. Default true."
122
+
},
123
+
"standardSitePublication": {
124
+
"type": "string",
125
+
"format": "at-uri",
126
+
"description": "Serve GET /.well-known/site.standard.publication with this AT-URI. It must name a site.standard.publication record in the site owner's repository whose url host is this domain, or the site record is rejected at indexing. While set, a manifest entry at that path is rejected."
99
127
}
100
128
},
101
-
"description": "Controls the responses bard synthesizes under /.well-known/. Every field defaults to true; the object exists only to turn things off."
129
+
"description": "Controls the responses bard generates under /.well-known/. Both flags default to true and exist only to turn things off. standardSitePublication is absent unless the publisher sets it."
130
+
},
131
+
"spaceMembers": {
132
+
"type": "object",
133
+
"properties": {},
134
+
"description": "The members of the space this site lives in, as the space's host reports them. Only valid on a site served from a space, and rejected (not ignored) anywhere else. The record lists no members; the space's host is asked."
102
135
}
103
136
},
104
137
"$type": "com.atproto.lexicon.schema",
105
138
"lexicon": 1
106
139
}