space.highport.manage.validate
Schema Diff
+8 -8
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"id": "space.highport.manage.validate",
3
3
"defs": {
4
4
"main": {
5
5
"type": "procedure",
6
6
"input": {
7
7
"schema": {
8
8
"type": "object",
9
9
"required": [
10
10
"record"
11
11
],
12
12
"properties": {
13
13
"rkey": {
14
14
"type": "string",
15
-
"description": "Required for a site (the hostname). For a tile: an existing rkey for a new version, a TID the client holds, or absent to have bard mint one."
15
+
"description": "Required for a site (the hostname). For a tile: an existing rkey for a new version, a TID the client chose, or absent to let bard mint one."
16
16
},
17
17
"space": {
18
18
"type": "string",
19
19
"format": "at-uri",
20
-
"description": "Validate as a record in this space; the caller must be its authority."
20
+
"description": "Validate as a record in this space. The caller must be its authority."
21
21
},
22
22
"dryRun": {
23
23
"type": "boolean",
24
-
"description": "Validate only; never prepare."
24
+
"description": "Validate only, without preparing."
25
25
},
26
26
"record": {
27
27
"type": "unknown",
28
-
"description": "A space.highport.sites.site or space.highport.sites.tile record, with $type."
28
+
"description": "A space.highport.sites.site or space.highport.sites.tile record, including $type."
29
29
}
30
30
}
31
31
},
32
32
"encoding": "application/json"
33
33
},
34
34
"errors": [
35
35
{
36
36
"name": "InvalidRecordKey",
37
-
"description": "A site validation without rkey, or an rkey that is not a canonical hostname / valid TID."
37
+
"description": "A site without an rkey, or an rkey that is not a canonical hostname or valid TID."
38
38
},
39
39
{
40
40
"name": "TileNotReady",
41
-
"description": "The bound tile is known only as pending-publication and cannot be bound yet."
41
+
"description": "The bound tile is still pending publication and cannot be bound yet."
42
42
},
43
43
{
44
44
"name": "SpaceNotFound",
45
45
"description": "Bard is not connected to that space."
46
46
},
47
47
{
48
48
"name": "NotSpaceAuthority",
49
49
"description": "Only the space's authority may publish in it."
50
50
},
51
51
{
52
52
"name": "RateLimitExceeded",
53
53
"description": "Too many preparations this hour."
54
54
}
55
55
],
56
56
"output": {
57
57
"schema": {
58
58
"type": "object",
59
59
"required": [
60
60
"valid",
61
61
"errors",
62
62
"parameterErrors",
63
63
"prepared",
64
64
"missingBlobs"
65
65
],
66
66
"properties": {
67
67
"cid": {
68
68
"type": "string",
69
69
"format": "cid"
70
70
},
71
71
"uri": {
72
72
"type": "string",
73
73
"format": "at-uri"
74
74
},
75
75
"state": {
76
76
"ref": "space.highport.defs#indexState",
77
77
"type": "ref"
78
78
},
79
79
"valid": {
80
80
"type": "boolean"
81
81
},
82
82
"errors": {
83
83
"type": "array",
84
84
"items": {
85
85
"ref": "space.highport.defs#validationError",
86
86
"type": "ref"
87
87
}
88
88
},
89
89
"reason": {
90
90
"type": "string",
91
91
"knownValues": [
92
92
"DomainNotVerified",
93
93
"TileAuthorNotPermitted",
94
94
"PreparedQuotaExceeded",
95
95
"SpacePreparationUnsupported",
96
96
"DryRun"
97
97
]
98
98
},
99
99
"record": {
100
100
"type": "unknown",
101
-
"description": "The record as bard will serialize it; submit it verbatim."
101
+
"description": "The record as bard will serialize it. Write it exactly as returned."
102
102
},
103
103
"prepared": {
104
104
"type": "boolean"
105
105
},
106
106
"expiresAt": {
107
107
"type": "string",
108
108
"format": "datetime"
109
109
},
110
110
"entryCount": {
111
111
"type": "integer"
112
112
},
113
113
"totalBytes": {
114
114
"type": "integer"
115
115
},
116
116
"missingBlobs": {
117
117
"type": "array",
118
118
"items": {
119
119
"ref": "space.highport.defs#missingBlob",
120
120
"type": "ref"
121
121
}
122
122
},
123
123
"parameterErrors": {
124
124
"type": "array",
125
125
"items": {
126
126
"ref": "space.highport.defs#validationError",
127
127
"type": "ref"
128
128
}
129
129
}
130
130
}
131
131
},
132
132
"encoding": "application/json"
133
133
},
134
-
"description": "Validate a site or tile record before writing it, and — for an authorized caller — prepare bard for it. Returns the AT-URI the record will have, the CID it will have, and the canonical record to submit with putRecord at that key."
134
+
"description": "Validate a site or tile record before writing it and, for an authorized caller, prepare bard to serve it. Returns the AT-URI and CID the record will have, and the canonical record to write with putRecord at that key."
135
135
}
136
136
},
137
137
"$type": "com.atproto.lexicon.schema",
138
138
"lexicon": 1
139
139
}