space.highport.manage.setDomainBilling
Schema Diff
+15 -15
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
-
"description": "Set whose allowance a domain's traffic draws on. Changing payerPolicy revokes every visitor approval the domain holds: consent was given to a different arrangement. The owner always remains the residual payer.",
5
+
"description": "Set whose allowance a domain's traffic uses. Changing payerPolicy revokes every visitor approval on the domain, since visitors agreed to the old arrangement. The owner always pays whatever nobody else covers.",
6
6
"errors": [
7
7
{
8
-
"description": "Not a syntactically valid, non-reserved, public-suffix-safe domain. Distinct from DomainNotFound: the string is not a hostname at all.",
8
+
"description": "Not a valid, non-reserved, public-suffix-safe domain. Unlike DomainNotFound, the input is not a hostname at all.",
9
9
"name": "InvalidDomain"
10
10
},
11
11
{
12
-
"description": "No such domain, or it is not registered to the calling identity.",
12
+
"description": "No such domain, or it does not belong to the caller.",
13
13
"name": "DomainNotFound"
14
14
},
15
15
{
16
-
"description": "payerPolicy is not one of owner or visitor.",
16
+
"description": "payerPolicy must be owner or visitor.",
17
17
"name": "InvalidRequest"
18
18
}
19
19
],
20
20
"input": {
21
21
"encoding": "application/json",
22
22
"schema": {
23
23
"properties": {
24
24
"domain": {
25
-
"description": "The registered hostname. Must be registered to the calling identity.",
25
+
"description": "The registered hostname. Must belong to the caller.",
26
26
"maxLength": 253,
27
27
"type": "string"
28
28
},
29
29
"fallbackToOwner": {
30
30
"default": true,
31
-
"description": "Under the visitor policy, whether a visitor with nothing left falls back to the owner rather than being refused. True is what stops a site going dark because one visitor overspent.",
31
+
"description": "Under the visitor policy: whether a visitor who has run out falls back to the owner instead of being refused. True keeps the site up when one visitor overspends.",
32
32
"type": "boolean"
33
33
},
34
34
"ownerBudgetBytes": {
35
-
"description": "Bytes of the owner's own allowance this site may spend on readers who have not signed in, per period. 0 requires a sign-in before anything is served; omitted leaves payerPolicy and fallbackToOwner in charge. When present it derives both.",
35
+
"description": "How many bytes of the owner's allowance this site may spend per period on readers who are not signed in. 0 requires sign-in for everything. When set, it determines payerPolicy and fallbackToOwner; when omitted, those two apply as set.",
36
36
"minimum": 0,
37
37
"type": "integer"
38
38
},
39
39
"payerPolicy": {
40
-
"description": "owner: every byte draws on the domain owner's allowance. visitor: authenticated visitors spend their own, and the owner pays for anonymous traffic and for visitors with nothing left.",
40
+
"description": "owner: all traffic uses the owner's allowance. visitor: signed-in visitors use their own, and the owner pays for anonymous traffic and for visitors who have run out.",
41
41
"knownValues": [
42
42
"owner",
43
43
"visitor"
44
44
],
45
45
"type": "string"
46
46
},
47
47
"visitorCapBytes": {
48
-
"description": "A ceiling on what any single visitor may spend here per period. Absent means no ceiling beyond the one the visitor themselves set.",
48
+
"description": "The most any one visitor can spend here per period. Absent means only the visitor's own cap applies.",
49
49
"minimum": 0,
50
50
"type": "integer"
51
51
}
52
52
},
53
53
"required": [
54
54
"domain",
55
55
"payerPolicy"
56
56
],
57
57
"type": "object"
58
58
}
59
59
},
60
60
"output": {
61
61
"encoding": "application/json",
62
62
"schema": {
63
63
"properties": {
64
64
"approvalsRevoked": {
65
-
"description": "How many visitor approvals the policy change invalidated.",
65
+
"description": "How many visitor approvals the policy change revoked.",
66
66
"type": "integer"
67
67
},
68
68
"billing": {
69
-
"description": "Whose allowance a domain's traffic draws on.",
69
+
"description": "Whose allowance a domain's traffic uses.",
70
70
"properties": {
71
71
"domain": {
72
72
"description": "The domain.",
73
73
"type": "string"
74
74
},
75
75
"fallbackToOwner": {
76
-
"description": "Under the visitor policy, whether a visitor with nothing left falls back to the owner rather than being refused.",
76
+
"description": "Under the visitor policy: whether a visitor who has run out falls back to the owner instead of being refused.",
77
77
"type": "boolean"
78
78
},
79
79
"ownerBudgetBytes": {
80
-
"description": "Bytes of the owner's own allowance this site may spend on readers who have not signed in, per period. 0 requires a sign-in before anything is served; omitted leaves payerPolicy and fallbackToOwner in charge. When present it derives both.",
80
+
"description": "How many bytes of the owner's allowance this site may spend per period on readers who are not signed in. 0 requires sign-in for everything. When set, it determines payerPolicy and fallbackToOwner; when omitted, those two apply as set.",
81
81
"minimum": 0,
82
82
"type": "integer"
83
83
},
84
84
"payerPolicy": {
85
85
"description": "owner or visitor.",
86
86
"knownValues": [
87
87
"owner",
88
88
"visitor"
89
89
],
90
90
"type": "string"
91
91
},
92
92
"updatedAt": {
93
-
"description": "When it last changed. Absent when the domain has no arrangement recorded and is reporting the default.",
93
+
"description": "When this last changed. Absent when the domain is using the default.",
94
94
"format": "datetime",
95
95
"type": "string"
96
96
},
97
97
"visitorCapBytes": {
98
-
"description": "A ceiling on what any single visitor may spend here per period.",
98
+
"description": "The most any one visitor can spend here per period.",
99
99
"type": "integer"
100
100
}
101
101
},
102
102
"required": [
103
103
"domain",
104
104
"payerPolicy",
105
105
"fallbackToOwner"
106
106
],
107
107
"type": "object"
108
108
}
109
109
},
110
110
"required": [
111
111
"billing"
112
112
],
113
113
"type": "object"
114
114
}
115
115
},
116
116
"type": "procedure"
117
117
}
118
118
},
119
119
"id": "space.highport.manage.setDomainBilling",
120
120
"lexicon": 1
121
121
}