docs: add permissions and tokens page (i-am-bee#1576)

Signed-off-by: Radek Ježek <[email protected]>
Signed-off-by: Matous Havlena <[email protected]>
Co-authored-by: Matous Havlena <[email protected]>
Signed-off-by: Eden Gilbert <[email protected]>

Author: 2 people

apps/agentstack-sdk-py/src/agentstack_sdk/platform/context.py

@@ -37,7 +37,7 @@ class ResourceIdPermission(pydantic.BaseModel):
 
 class ContextPermissions(pydantic.BaseModel):
     files: set[Literal["read", "write", "extract", "*"]] = set()
-    vector_stores: set[Literal["read", "write", "extract", "*"]] = set()
+    vector_stores: set[Literal["read", "write", "*"]] = set()
     context_data: set[Literal["read", "write", "*"]] = set()
 
 

apps/agentstack-server/src/agentstack_server/api/schema/contexts.py

@@ -37,14 +37,14 @@ class ContextListQuery(PaginationQuery):
 
 class ContextPermissionsGrant(BaseModel):
     files: list[Literal["read", "write", "extract", "*"]] = Field(default_factory=list)
-    vector_stores: list[Literal["read", "write", "extract", "*"]] = Field(default_factory=list)
+    vector_stores: list[Literal["read", "write", "*"]] = Field(default_factory=list)
     context_data: list[Literal["read", "write", "*"]] = Field(default_factory=list)
 
 
 class GlobalPermissionGrant(BaseModel):
     files: list[Literal["read", "write", "extract", "*"]] = Field(default_factory=list)
     feedback: list[Literal["write"]] = Field(default_factory=list)
-    vector_stores: list[Literal["read", "write", "extract", "*"]] = Field(default_factory=list)
+    vector_stores: list[Literal["read", "write", "*"]] = Field(default_factory=list)
 
     # openai proxy
     llm: list[Literal["*"] | ResourceIdPermission] = Field(default_factory=list)

apps/agentstack-server/src/agentstack_server/domain/models/permissions.py

@@ -27,7 +27,7 @@ class Permissions(BaseModel):
 
     files: SerializeAsAny[set[Literal["read", "write", "extract", "*"]]] = set()
     feedback: SerializeAsAny[set[Literal["write"]]] = set()
-    vector_stores: SerializeAsAny[set[Literal["read", "write", "extract", "*"]]] = set()
+    vector_stores: SerializeAsAny[set[Literal["read", "write", "*"]]] = set()
     variables: SerializeAsAny[set[Literal["read", "write", "*"]]] = set()
 
     # openai proxy

apps/agentstack-server/tests/unit/domain/models/test_permissions.py

@@ -43,7 +43,7 @@
             ),
             Permissions(
                 files={"read"},
-                vector_stores={"extract"},
+                vector_stores={"read"},
                 feedback={"write"},
                 providers={"read"},
             ),
@@ -54,7 +54,7 @@
             Permissions(
                 files={"*"},
                 feedback={"write"},
-                vector_stores={"read", "write", "extract"},
+                vector_stores={"read", "write"},
                 llm={"*"},
                 embeddings={"*"},
                 a2a_proxy={"*"},
@@ -65,7 +65,7 @@
             Permissions(
                 files={"read"},
                 feedback={"write"},
-                vector_stores={"extract"},
+                vector_stores={"write"},
                 providers={"read"},
                 provider_variables={"write"},
                 contexts={"read"},
@@ -102,7 +102,7 @@ def test_admin_all_permissions_check():
 
     required_perms = Permissions(
         files={"read", "write", "extract"},
-        vector_stores={"read", "write", "extract"},
+        vector_stores={"read", "write"},
         feedback={"write"},
         providers={"read", "write"},
         provider_variables={"read", "write"},

docs/docs.json

@@ -62,9 +62,8 @@
       },
       {
         "group": "Advanced Integration",
-        "pages": ["guides/connectors"]
+        "pages": ["guides/connectors", "guides/permissions-and-tokens"]
       },
-
       {
         "group": "Join Our Community",
         "pages": ["community/contribute"]