fix(dotnet): update README templates for correct BatchCheck documenta… (#663)

Author: SoulPancake

config/clients/dotnet/config.overrides.json

@@ -11,7 +11,7 @@
   "testPackageGuid": "d119dfae-509a-4eba-a973-645b739356fc",
   "packageName": "OpenFga.Sdk",
   "testPackageName": "OpenFga.Sdk.Test",
-  "packageVersion": "0.8.0",
+  "packageVersion": "0.9.0",
   "licenseUrl": "https://github.com/openfga/dotnet-sdk/blob/main/LICENSE",
   "fossaComplianceNoticeId": "f8ac2ec4-84fc-44f4-a617-5800cd3d180e",
   "termsOfService": "",

config/clients/dotnet/template/README_calling_api.mustache

@@ -381,8 +381,15 @@ var response = await fgaClient.Check(body, options);
 
 ##### Batch Check
 
-Run a set of [checks](#check). Batch Check will return `allowed: false` if it encounters an error, and will return the error in the body.
-If 429s or 5xxs are encountered, the underlying check will retry up to {{defaultMaxRetry}} times before giving up.
+Similar to [check](#check), but instead of checking a single user-object relationship, accepts a list of relationships to check. Requires OpenFGA server version [1.8.0](https://github.com/openfga/openfga/releases/tag/v1.8.0) or greater.
+
+This method automatically handles:
+- Generating correlation IDs for checks that don't have one
+- Validating that correlation IDs are unique
+- Chunking requests based on `MaxBatchSize` (default: {{clientMaxBatchSize}})
+- Executing batches in parallel based on `MaxParallelRequests` (default: {{clientMaxMethodParallelRequests}})
+
+If 429s or 5xxs are encountered, the underlying requests will retry up to {{defaultMaxRetry}} times before giving up.
 
 > **Note**: The order of `BatchCheck` results is not guaranteed to match the order of the checks provided. Use `correlationId` to pair responses with requests.
 
@@ -391,87 +398,139 @@ var options = new ClientBatchCheckOptions {
     // You can rely on the model id set in the configuration or override it for this specific request
     AuthorizationModelId = "01GXSA8YR785C4FYS3C0RTG7B1",
     MaxParallelRequests = 5, // Max number of requests to issue in parallel, defaults to {{clientMaxMethodParallelRequests}}
+    MaxBatchSize = 20, // Max number of checks per batch request, defaults to {{clientMaxBatchSize}}
 };
-var body = new List<ClientCheckRequest>(){
-    new() {
-        User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-        Relation = "viewer",
-        Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
-        ContextualTuples = new List<ClientTupleKey>() {
-            new() {
-                User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-                Relation = "editor",
-                Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
-            }
+var body = new ClientBatchCheckRequest {
+    Checks = new List<ClientBatchCheckItem>() {
+        new() {
+            User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+            Relation = "viewer",
+            Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+            ContextualTuples = new ContextualTupleKeys {
+                TupleKeys = new List<TupleKey>() {
+                    new() {
+                        User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+                        Relation = "editor",
+                        Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+                    }
+                }
+            },
+            // CorrelationId is optional - will be auto-generated if not provided
         },
-    },
-    new() {
-        User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-        Relation = "admin",
-        Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
-        ContextualTuples = new List<ClientTupleKey>() {
-            new() {
-                User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-                Relation = "editor",
-                Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
-            }
+        new() {
+            User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+            Relation = "admin",
+            Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+            ContextualTuples = new ContextualTupleKeys {
+                TupleKeys = new List<TupleKey>() {
+                    new() {
+                        User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+                        Relation = "editor",
+                        Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+                    }
+                }
+            },
+            CorrelationId = "check-admin-01234", // Custom correlation ID
         },
-    },
-    new() {
-        User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-        Relation = "creator",
-        Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
-    },
-    new() {
-        User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-        Relation = "deleter",
-        Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+        new() {
+            User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+            Relation = "creator",
+            Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+        },
+        new() {
+            User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+            Relation = "deleter",
+            Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+        }
     }
 };
 
 var response = await fgaClient.BatchCheck(body, options);
 
 /*
-response.Responses = [{
+response.Result = [{
+  CorrelationId: "01JA8PM3QM7VBPGB8KMPK8SBD5", // Auto-generated
   Allowed: false,
   Request: {
     User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "viewer",
     Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
-    ContextualTuples: [{
-      User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-      Relation: "editor",
-      Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
-    }]
+    ContextualTuples: { ... }
   }
 }, {
+  CorrelationId: "check-admin-01234", // Custom ID
   Allowed: false,
   Request: {
     User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "admin",
     Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
-    ContextualTuples: [{
-      User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-      Relation: "editor",
-      Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
-    }]
+    ContextualTuples: { ... }
   }
 }, {
+  CorrelationId: "01JA8PMM6A90NV5ET0F28CYSZQ",
   Allowed: false,
   Request: {
     User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "creator",
     Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
   },
-  Error: <FgaError ...>
+  Error: { Message: "...", InputError: "..." } // Error details if check failed
 }, {
+  CorrelationId: "01JA8PN7K2XBVW9R3FQMH5JZTA",
   Allowed: true,
   Request: {
     User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "deleter",
     Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
-  }},
-]
+  }
+}]
+*/
+```
+
+##### Client Batch Check
+
+Run a set of [checks](#check) by making individual `/check` API calls in parallel on the client side. This is useful for small batches (< 10 checks) when you want more control over each individual request.
+
+For larger batches or to use the server-side batch endpoint, use [`BatchCheck`](#batch-check) instead.
+
+```csharp
+var options = new ClientBatchCheckClientOptions {
+    AuthorizationModelId = "01GXSA8YR785C4FYS3C0RTG7B1",
+    MaxParallelRequests = 5, // Max number of requests to issue in parallel, defaults to {{clientMaxMethodParallelRequests}}
+};
+var body = new List<ClientCheckRequest>() {
+    new() {
+        User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+        Relation = "viewer",
+        Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+    },
+    new() {
+        User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+        Relation = "admin",
+        Object = "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
+    }
+};
+
+var response = await fgaClient.ClientBatchCheck(body, options);
+
+/*
+response.Responses = [{
+  Allowed: false,
+  Request: {
+    User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+    Relation: "viewer",
+    Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
+  },
+  Error: null
+}, {
+  Allowed: true,
+  Request: {
+    User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+    Relation: "admin",
+    Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
+  },
+  Error: null
+}]
 */
 ```
 

config/clients/dotnet/template/README_initializing.mustache

@@ -78,6 +78,10 @@ namespace Example {
                     Credentials = new Credentials() {
                         Method = CredentialsMethod.ClientCredentials,
                         Config = new CredentialsConfig() {
+                            // API Token Issuer can contain:
+                            // - a scheme, defaults to https
+                            // - a path, defaults to /oauth/token
+                            // - a port
                             ApiTokenIssuer = Environment.GetEnvironmentVariable("FGA_API_TOKEN_ISSUER"),
                             ApiAudience = Environment.GetEnvironmentVariable("FGA_API_AUDIENCE"),
                             ClientId = Environment.GetEnvironmentVariable("FGA_CLIENT_ID"),

config/common/files/README.mustache

@@ -37,6 +37,7 @@
     - [Relationship Queries](#relationship-queries)
       - [Check](#check)
       - [Batch Check](#batch-check)
+      - [Client Batch Check](#client-batch-check)
       - [Expand](#expand)
       - [List Objects](#list-objects)
       {{#supportsStreamedListObjects}}