Merge pull request #1603 from Permify/lookup-improvements

feat: add scope of entityIds to lookup-entity api filter
Permify · Sep 18, 2024 · 0f1b552 · 0f1b552
2 parents 64abf6f + 7c9f4b5
commit 0f1b552
Show file tree

Hide file tree

Showing 49 changed files with 4,986 additions and 4,908 deletions.
diff --git a/assets/example-shapes/banking-system.yaml b/assets/example-shapes/banking-system.yaml
@@ -12,14 +12,14 @@ schema: |-
         // Permission to withdraw from an account.
         // A user can withdraw from an account if the requested amount is less than or equal to the current balance,
         // the requested amount is less than or equal to 5000, and the user is the owner of the account.
-        permission withdraw = check_balance(request.amount, balance) and owner
+        permission withdraw = check_balance(balance) and owner
     }
 
     // Rule to verify if a withdrawal is possible.
     // The withdrawal is allowed if the current balance can cover the requested amount,
     // and if the requested amount doesn't exceed a limit of 5000.
-    rule check_balance(amount integer, balance integer) {
-        (balance >= amount) && (amount <= 5000)
+    rule check_balance(balance integer) {
+        (balance >= context.data.amount) && (context.data.amount <= 5000)
     }
 
 relationships:

diff --git a/assets/example-shapes/disney-plus.yaml b/assets/example-shapes/disney-plus.yaml
@@ -36,17 +36,17 @@ schema: |-
         attribute age_rating integer
         attribute allowed_region string[]
 
-        action view = check_age(request.age, age_rating) and check_region(request.region, allowed_region)
+        action view = check_age(age_rating) and check_region(allowed_region)
         action add_watchlist = user 
 
     }
 
-    rule check_age(age integer, age_rating integer) {
-        age >= age_rating
+    rule check_age(age_rating integer) {
+        context.data.age >= age_rating
     }
 
     rule check_region(region string, allowed_region string[]) {
-        region in allowed_region
+        context.data.region in allowed_region
     }
 
 relationships:

diff --git a/assets/example-shapes/mercury.yaml b/assets/example-shapes/mercury.yaml
@@ -24,15 +24,15 @@ schema: |-
         attribute withdraw_limit double
         attribute balance double 
 
-        action withdraw = check_balance(balance, request.amount) and (check_limit(withdraw_limit, request.amount) or owner.approval)
+        action withdraw = check_balance(balance) and (check_limit(withdraw_limit) or owner.approval)
     }
 
-    rule check_balance(balance double, amount double) {
-        balance >= amount
+    rule check_balance(balance double) {
+        balance >= context.data.amount
     }
 
-    rule check_limit(withdraw_limit double, amount double) {
-        withdraw_limit >= amount 
+    rule check_limit(withdraw_limit double) {
+        withdraw_limit >= context.data.amount
     }
 
     rule check_admin_approval(approval_num integer, admin_approval_limit integer) {

diff --git a/assets/example-shapes/weekday.yaml b/assets/example-shapes/weekday.yaml
diff --git a/docs/api-reference/apidocs.swagger.json b/docs/api-reference/apidocs.swagger.json
@@ -1428,9 +1428,6 @@
       "properties": {
         "computedAttribute": {
           "$ref": "#/definitions/ComputedAttribute"
-        },
-        "contextAttribute": {
-          "$ref": "#/definitions/ContextAttribute"
         }
       },
       "description": "Argument defines the type of argument in a Call. It can be either a ComputedAttribute or a ContextAttribute."
@@ -1779,16 +1776,6 @@
       },
       "description": "Context encapsulates the information related to a single operation,\nincluding the tuples involved and the associated attributes."
     },
-    "ContextAttribute": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "title": "Name of the context attribute"
-        }
-      },
-      "description": "ContextAttribute defines a context attribute which includes its name."
-    },
     "CreateList": {
       "type": "object",
       "properties": {
@@ -2283,6 +2270,13 @@
           "$ref": "#/definitions/Context",
           "description": "Context associated with this request."
         },
+        "scope": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/StringArrayValue"
+          },
+          "description": "Scope: A map that associates entity types with lists of identifiers. Each entry\nhelps filter requests by specifying which entities are relevant to the operation."
+        },
         "page_size": {
           "type": "integer",
           "format": "int64",
@@ -2318,6 +2312,13 @@
           "$ref": "#/definitions/Context",
           "description": "Context associated with this request."
         },
+        "scope": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/StringArrayValue"
+          },
+          "description": "Scope: A map that associates entity types with lists of identifiers. Each entry\nhelps filter requests by specifying which entities are relevant to the operation."
+        },
         "page_size": {
           "type": "integer",
           "format": "int64",
@@ -3143,6 +3144,19 @@
         }
       }
     },
+    "StringArrayValue": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The array of strings."
+        }
+      },
+      "description": "Wrapper for an array of strings."
+    },
     "Subject": {
       "type": "object",
       "properties": {

diff --git a/docs/api-reference/openapiv2/apidocs.swagger.json b/docs/api-reference/openapiv2/apidocs.swagger.json
@@ -1428,9 +1428,6 @@
       "properties": {
         "computedAttribute": {
           "$ref": "#/definitions/ComputedAttribute"
-        },
-        "contextAttribute": {
-          "$ref": "#/definitions/ContextAttribute"
         }
       },
       "description": "Argument defines the type of argument in a Call. It can be either a ComputedAttribute or a ContextAttribute."
@@ -1775,16 +1772,6 @@
       },
       "description": "Context encapsulates the information related to a single operation,\nincluding the tuples involved and the associated attributes."
     },
-    "ContextAttribute": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "title": "Name of the context attribute"
-        }
-      },
-      "description": "ContextAttribute defines a context attribute which includes its name."
-    },
     "CreateList": {
       "type": "object",
       "properties": {
@@ -2273,6 +2260,13 @@
           "$ref": "#/definitions/Context",
           "description": "Context associated with this request."
         },
+        "scope": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/StringArrayValue"
+          },
+          "description": "Scope: A map that associates entity types with lists of identifiers. Each entry\nhelps filter requests by specifying which entities are relevant to the operation."
+        },
         "page_size": {
           "type": "integer",
           "format": "int64",
@@ -2308,6 +2302,13 @@
           "$ref": "#/definitions/Context",
           "description": "Context associated with this request."
         },
+        "scope": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/StringArrayValue"
+          },
+          "description": "Scope: A map that associates entity types with lists of identifiers. Each entry\nhelps filter requests by specifying which entities are relevant to the operation."
+        },
         "page_size": {
           "type": "integer",
           "format": "int64",
@@ -3123,6 +3124,19 @@
         }
       }
     },
+    "StringArrayValue": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The array of strings."
+        }
+      },
+      "description": "Wrapper for an array of strings."
+    },
     "Subject": {
       "type": "object",
       "properties": {