-
Notifications
You must be signed in to change notification settings - Fork 41
/
team_sharing_allowlist.stone
141 lines (112 loc) · 5.35 KB
/
team_sharing_allowlist.stone
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
namespace team
import common
struct SharingAllowlistAddArgs
"Structure representing Approve List entries. Domain and emails are supported.
At least one entry of any supported type is required."
domains List(String)?
"List of domains represented by valid string representation (RFC-1034/5)."
emails List(String)?
"List of emails represented by valid string representation (RFC-5322/822)."
example default
domains = ["test-domain.com", "subdomain.some.com"]
emails = ["adam@test-domain.com", "john@some.com"]
struct SharingAllowlistAddResponse
"This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone."
union SharingAllowlistAddError
malformed_entry String
"One of provided values is not valid."
no_entries_provided
"Neither single domain nor email provided."
too_many_entries_provided
"Too many entries provided within one call."
team_limit_reached
"Team entries limit reached."
unknown_error
"Unknown error."
entries_already_exist String
"Entries already exists."
struct SharingAllowlistListArg
limit UInt32(max_value=1000, min_value=1) = 1000
"The number of entries to fetch at one time."
example default
limit = 100
struct SharingAllowlistListContinueArg
cursor String
"The cursor returned from a previous call to :route:`sharing_allowlist/list` or :route:`sharing_allowlist/list/continue`."
example default
cursor = "dGVzdF9jdXJzb3IK"
struct SharingAllowlistListError
"This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone."
struct SharingAllowlistListResponse
domains List(String)
"List of domains represented by valid string representation (RFC-1034/5)."
emails List(String)
"List of emails represented by valid string representation (RFC-5322/822)."
cursor String = ""
"If this is nonempty, there are more entries that can be fetched with :route:`sharing_allowlist/list/continue`."
has_more Boolean = false
"if true indicates that more entries can be fetched with :route:`sharing_allowlist/list/continue`."
example default
domains = ["test-domain.com", "subdomain.some.com"]
emails = ["adam@test-domain.com", "john@some.com"]
cursor = "dGVzdF9jdXJzb3IK"
has_more = true
union SharingAllowlistListContinueError
invalid_cursor
"Provided cursor is not valid."
struct SharingAllowlistRemoveArgs
domains List(String)?
"List of domains represented by valid string representation (RFC-1034/5)."
emails List(String)?
"List of emails represented by valid string representation (RFC-5322/822)."
example default
domains = ["test-domain.com", "subdomain.some.com"]
emails = ["adam@test-domain.com", "john@some.com"]
struct SharingAllowlistRemoveResponse
"This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone."
union SharingAllowlistRemoveError
malformed_entry String
"One of provided values is not valid."
entries_do_not_exist String
"One or more provided values do not exist."
no_entries_provided
"Neither single domain nor email provided."
too_many_entries_provided
"Too many entries provided within one call."
unknown_error
"Unknown error."
route sharing_allowlist/add (SharingAllowlistAddArgs, SharingAllowlistAddResponse, SharingAllowlistAddError)
"Endpoint adds Approve List entries. Changes are effective immediately.
Changes are committed in transaction. In case of single validation error - all entries are rejected.
Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted.
Added entries cannot overflow limit of 10000 entries per team.
Maximum 100 entries per call is allowed."
attrs
auth = "team"
is_preview = true
scope = "team_info.write"
route sharing_allowlist/list (SharingAllowlistListArg, SharingAllowlistListResponse, SharingAllowlistListError)
"Lists Approve List entries for given team, from newest to oldest, returning
up to `limit` entries at a time. If there are more than `limit` entries
associated with the current team, more can be fetched by passing the
returned `cursor` to :route:`sharing_allowlist/list/continue`."
attrs
auth = "team"
is_preview = true
scope = "team_info.read"
route sharing_allowlist/list/continue (SharingAllowlistListContinueArg, SharingAllowlistListResponse, SharingAllowlistListContinueError)
"Lists entries associated with given team, starting from a the cursor. See :route:`sharing_allowlist/list`."
attrs
auth = "team"
is_preview = true
scope = "team_info.read"
route sharing_allowlist/remove (SharingAllowlistRemoveArgs, SharingAllowlistRemoveResponse, SharingAllowlistRemoveError)
"Endpoint removes Approve List entries. Changes are effective immediately.
Changes are committed in transaction. In case of single validation error - all entries are rejected.
Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted.
Entries being removed have to be present on the list.
Maximum 1000 entries per call is allowed."
attrs
auth = "team"
is_preview = true
scope = "team_info.write"