Spec Update 10/11/2022 (#75)

Change Notes: openid_openid_types Namespace - Add OpenIdError, UserInfoError unions - Remove UserInfoError structs - Remove AuthError unions - Update UserInfoArgs struct to include documentation team_policies Namespace - Add examples Co-authored-by: Brent Bumann <[email protected]>
dropbox · Oct 11, 2022 · 18963b8 · 18963b8
1 parent c36ba27
commit 18963b8
Show file tree

Hide file tree

Showing 3 changed files with 150 additions and 10 deletions.
diff --git a/openid_openid_types.stone b/openid_openid_types.stone
@@ -4,20 +4,16 @@ namespace openid
 
 import common
 
-union AuthError
-    invalid_token
-    no_openid_auth
+union OpenIdError
+    incorrect_openid_scopes
+        "Missing openid claims for the associated access token."
 
 
-struct UserInfoError
-    err err_union?
-        union
-            auth_error AuthError = invalid_token
-    error_message String = ""
-        "Brief explanation of the error."
+union UserInfoError
+    openid_error OpenIdError = incorrect_openid_scopes
 
 struct UserInfoArgs
-    "This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone."
+    "No Parameters"
 
 struct UserInfoResult
     family_name String?

diff --git a/team_policies.stone b/team_policies.stone
@@ -32,11 +32,14 @@ struct TeamSharingPolicies
         "Which shared folders team members can join."
     shared_link_create_policy SharedLinkCreatePolicy
         "Who can view shared links owned by team members."
+    group_creation_policy GroupCreation
+        "Who can create groups."
 
     example default
         shared_folder_member_policy = team
         shared_folder_join_policy = from_anyone
         shared_link_create_policy = team_only
+        group_creation_policy = admins_only
 
 # NOTE: we do not reuse sharing.MemberPolicy here since we may want to enable folder-specific member
 # policies that work on top of the broader team policies.

diff --git a/team_sharing_allowlist.stone b/team_sharing_allowlist.stone
@@ -0,0 +1,141 @@
+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 = ["[email protected]", "[email protected]"]
+
+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 = ["[email protected]", "[email protected]"]
+        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 = ["[email protected]", "[email protected]"]
+
+
+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"
+