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