docs(python): add condition/context support, cleanup some snippets (#623

) Co-authored-by: Raghd Hamzeh <[email protected]>
openfga · Jan 16, 2024 · bcbeb93 · bcbeb93
1 parent a9b5846
commit bcbeb93
Show file tree

Hide file tree

Showing 8 changed files with 190 additions and 110 deletions.
diff --git a/docs/content/getting-started/create-store.mdx b/docs/content/getting-started/create-store.mdx
@@ -82,18 +82,14 @@ namespace ExampleApp;
 
 class MyProgram {
     static async Task Main() {
-        var configuration = new ClientConfiguration() {
-            ApiScheme = Environment.GetEnvironmentVariable("FGA_API_SCHEME"), // optional. Can be "http" or "https". Defaults to "https"
-            ApiHost = Environment.GetEnvironmentVariable("FGA_API_HOST"), // required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
+         var configuration = new ClientConfiguration() {
+            ApiUrl = Environment.GetEnvironmentVariable("FGA_API_URL") ?? "http://localhost:8080", // required, e.g. https://api.fga.example
             StoreId = Environment.GetEnvironmentVariable("FGA_STORE_ID"), // optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
             AuthorizationModelId = Environment.GetEnvironmentVariable("FGA_MODEL_ID"), // optional, can be overridden per request
         };
         var fgaClient = new OpenFgaClient(configuration);
 
-        var store = await fgaClient.CreateStore(new ClientCreateStoreRequest(){Name = "FGA Demo"})
-        {
-            Name = "FGA Demo Store"
-        });
+        var store = await fgaClient.CreateStore(new ClientCreateStoreRequest(){Name = "FGA Demo Store"});
     }
 }
 ```
@@ -103,32 +99,25 @@ class MyProgram {
 <TabItem value={SupportedLanguage.PYTHON_SDK} label={languageLabelMap.get(SupportedLanguage.PYTHON_SDK)}>
 
 ```python
+import asyncio
 import os
 import openfga_sdk
 from openfga_sdk.client import OpenFgaClient
 from openfga_sdk.models.create_store_request import CreateStoreRequest
 
-configuration = openfga_sdk.Configuration(
-    scheme = os.environ.get('FGA_API_SCHEME'),
-    api_host = os.environ.get('FGA_API_HOST'),
-)
-
-async with OpenFgaClient(configuration) as fga_client:
-  body = CreateStoreRequest(
-      name = "FGA Demo Store",
-  )
-  response = await fga_client.create_store(body)
+async def main():
+    configuration = openfga_sdk.Configuration(
+        api_scheme = os.environ.get('FGA_API_SCHEME'),
+        api_host = os.environ.get('FGA_API_HOST'),
+    )
 
-async def create_store():
-    try:
-        # Create a store
+    async with OpenFgaClient(configuration) as fga_client:
         body = CreateStoreRequest(
-            name = "FGA Demo",
+            name = "FGA Demo Store",
         )
-        api_response = await fga_client_instance.create_store(body)
-    except openfga_sdk.ApiException as e:
-        print("Exception when calling OpenFgaClient->create_store: %s\n" % e)
+        response = await fga_client.create_store(body)
 
+asyncio.run(main())
 ```
 
 </TabItem>

diff --git a/docs/content/getting-started/setup-sdk-client.mdx b/docs/content/getting-started/setup-sdk-client.mdx
@@ -78,8 +78,7 @@ namespace ExampleApp;
 class MyProgram {
     static async Task Main() {
         var configuration = new ClientConfiguration() {
-            ApiScheme = Environment.GetEnvironmentVariable("FGA_API_SCHEME"), // optional. Can be "http" or "https". Defaults to "https"
-            ApiHost = Environment.GetEnvironmentVariable("FGA_API_HOST"), // required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
+            ApiUrl = Environment.GetEnvironmentVariable("FGA_API_URL") ?? "http://localhost:8080", // required, e.g. https://api.fga.example
             StoreId = Environment.GetEnvironmentVariable("FGA_STORE_ID"), // optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
             AuthorizationModelId = Environment.GetEnvironmentVariable("FGA_MODEL_ID"), // optional, can be overridden per request
         };
@@ -92,20 +91,24 @@ class MyProgram {
 <TabItem value={SupportedLanguage.PYTHON_SDK} label={languageLabelMap.get(SupportedLanguage.PYTHON_SDK)}>
 
 ```python
+import asyncio
 import os
 import openfga_sdk
 from openfga_sdk.client import OpenFgaClient
 
-configuration = openfga_sdk.Configuration(
-    api_scheme = os.environ.get('FGA_API_SCHEME'), # optional. Can be "http" or "https". Defaults to "https"
-    api_host = os.environ.get('FGA_API_HOST'), # required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
-    store_id = os.environ.get('FGA_STORE_ID'), # optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
-    model_id = os.environ.get('FGA_MODEL_ID'), # optional, can be overridden per request
-)
+async def main():
+    configuration = openfga_sdk.Configuration(
+        api_scheme = os.environ.get('FGA_API_SCHEME'), # optional. Can be "http" or "https". Defaults to "https"
+        api_host = os.environ.get('FGA_API_HOST'), # required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
+        store_id = os.environ.get('FGA_STORE_ID'), # optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
+        model_id = os.environ.get('FGA_MODEL_ID'), # optional, can be overridden per request
+    )
+
+    async with OpenFgaClient(configuration) as fga_client:
+        api_response = await fga_client.read_authorization_models() # call requests
+        await fga_client.close() # close when done
 
-async with OpenFgaClient(configuration) as fga_client:
-    api_response = await fga_client.read_authorization_models() // call requests
-    await fga_client.close() // close when done
+asyncio.run(main())
 ```
 
 </TabItem>
@@ -186,17 +189,15 @@ func main() {
 
 ```dotnet
 using OpenFga.Sdk.Client;
-using OpenFga.Sdk.Client.Model;
-using OpenFga.Sdk.Model;
+using OpenFga.Sdk.Configuration;
 using Environment = System.Environment;
 
 namespace ExampleApp;
 
 class MyProgram {
     static async Task Main() {
         var configuration = new ClientConfiguration() {
-            ApiScheme = Environment.GetEnvironmentVariable("FGA_API_SCHEME"), // optional. Can be "http" or "https". Defaults to "https"
-            ApiHost = Environment.GetEnvironmentVariable("FGA_API_HOST"), // required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
+            ApiUrl = Environment.GetEnvironmentVariable("FGA_API_URL") ?? "http://localhost:8080", // required, e.g. https://api.fga.example
             StoreId = Environment.GetEnvironmentVariable("FGA_STORE_ID"), // optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
             AuthorizationModelId = Environment.GetEnvironmentVariable("FGA_MODEL_ID"), // optional, can be overridden per request
             Credentials = new Credentials() {
@@ -215,24 +216,33 @@ class MyProgram {
 <TabItem value={SupportedLanguage.PYTHON_SDK} label={languageLabelMap.get(SupportedLanguage.PYTHON_SDK)}>
 
 ```python
+import asyncio
 import os
 import openfga_sdk
 from openfga_sdk.client import OpenFgaClient
 from openfga_sdk.credentials import Credentials, CredentialConfiguration
 
-credentials = Credentials(method='api_token',
-    configuration=CredentialConfiguration(api_token=os.environ.get(FGA_API_TOKEN)))
-configuration = openfga_sdk.Configuration(
-    api_scheme = os.environ.get('FGA_API_SCHEME'), # optional. Can be "http" or "https". Defaults to "https"
-    api_host = os.environ.get('FGA_API_HOST'), # required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
-    store_id = os.environ.get('FGA_STORE_ID'), # optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
-    model_id = os.environ.get('FGA_MODEL_ID'), # optional, can be overridden per request
-    credentials = credentials,
-)
+async def main():
+
+    credentials = Credentials(
+        method='api_token',
+        configuration=CredentialConfiguration(
+            api_token=os.environ.get('FGA_API_TOKEN')
+        )
+    )
+    configuration = openfga_sdk.Configuration(
+        api_scheme = os.environ.get('FGA_API_SCHEME'), # optional. Can be "http" or "https". Defaults to "https"
+        api_host = os.environ.get('FGA_API_HOST'), # required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
+        store_id = os.environ.get('FGA_STORE_ID'), # optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
+        model_id = os.environ.get('FGA_MODEL_ID'), # optional, can be overridden per request
+        credentials = credentials,
+    )
+
+    async with OpenFgaClient(configuration) as fga_client:
+        api_response = await fga_client.read_authorization_models() # call requests
+        await fga_client.close() # close when done
 
-async with OpenFgaClient(configuration) as fga_client:
-    api_response = await fga_client.read_authorization_models() // call requests
-    await fga_client.close() // close when done
+asyncio.run(main())
 ```
 
 </TabItem>
@@ -316,28 +326,26 @@ func main() {
 
 ```dotnet
 using OpenFga.Sdk.Client;
-using OpenFga.Sdk.Client.Model;
-using OpenFga.Sdk.Model;
+using OpenFga.Sdk.Configuration;
 using Environment = System.Environment;
 
 namespace ExampleApp;
 
 class MyProgram {
     static async Task Main() {
         var configuration = new ClientConfiguration() {
-            ApiScheme = Environment.GetEnvironmentVariable("FGA_API_SCHEME"), // optional. Can be "http" or "https". Defaults to "https"
-            ApiHost = Environment.GetEnvironmentVariable("FGA_API_HOST"), // required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
+            ApiUrl = Environment.GetEnvironmentVariable("FGA_API_URL") ?? "http://localhost:8080", // required, e.g. https://api.fga.example
             StoreId = Environment.GetEnvironmentVariable("FGA_STORE_ID"), // optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
             AuthorizationModelId = Environment.GetEnvironmentVariable("FGA_MODEL_ID"), // optional, can be overridden per request
-                   Credentials = new Credentials() {
-                        Method = CredentialsMethod.ClientCredentials,
-                        Config = new CredentialsConfig() {
-                            ApiTokenIssuer = Environment.GetEnvironmentVariable("FGA_API_TOKEN_ISSUER"),
-                            ApiAudience = Environment.GetEnvironmentVariable("FGA_API_AUDIENCE"),
-                            ClientId = Environment.GetEnvironmentVariable("FGA_CLIENT_ID"),
-                            ClientSecret = Environment.GetEnvironmentVariable("FGA_CLIENT_SECRET"),
-                        }
-                    }
+            Credentials = new Credentials() {
+                Method = CredentialsMethod.ClientCredentials,
+                Config = new CredentialsConfig() {
+                    ApiTokenIssuer = Environment.GetEnvironmentVariable("FGA_API_TOKEN_ISSUER"),
+                    ApiAudience = Environment.GetEnvironmentVariable("FGA_API_AUDIENCE"),
+                    ClientId = Environment.GetEnvironmentVariable("FGA_CLIENT_ID"),
+                    ClientSecret = Environment.GetEnvironmentVariable("FGA_CLIENT_SECRET"),
+                }
+            }
         };
         var fgaClient = new OpenFgaClient(configuration);
     }
@@ -348,31 +356,36 @@ class MyProgram {
 <TabItem value={SupportedLanguage.PYTHON_SDK} label={languageLabelMap.get(SupportedLanguage.PYTHON_SDK)}>
 
 ```python
+import asyncio
 import os
 import openfga_sdk
 from openfga_sdk.client import OpenFgaClient
 from openfga_sdk.credentials import Credentials, CredentialConfiguration
 
-credentials = Credentials(
-    method='client_credentials',
-    configuration=CredentialConfiguration(
-        api_issuer= os.environ.get('FGA_API_TOKEN_ISSUER'),
-        api_audience= os.environ.get('FGA_API_AUDIENCE'),
-        client_id= os.environ.get('FGA_CLIENT_ID'),
-        client_secret= os.environ.get('FGA_CLIENT_SECRET'),
+async def main():
+
+    credentials = Credentials(
+        method='client_credentials',
+        configuration=CredentialConfiguration(
+            api_issuer= os.environ.get('FGA_API_TOKEN_ISSUER'),
+            api_audience= os.environ.get('FGA_API_AUDIENCE'),
+            client_id= os.environ.get('FGA_CLIENT_ID'),
+            client_secret= os.environ.get('FGA_CLIENT_SECRET'),
+        )
     )
-)
-configuration = openfga_sdk.Configuration(
-    api_scheme = os.environ.get('FGA_API_SCHEME'), # optional. Can be "http" or "https". Defaults to "https"
-    api_host = os.environ.get('FGA_API_HOST'), # required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
-    store_id = os.environ.get('FGA_STORE_ID'), # optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
-    model_id = os.environ.get('FGA_MODEL_ID'), # optional, can be overridden per request
-    credentials = credentials,
-)
+    configuration = openfga_sdk.Configuration(
+        api_scheme = os.environ.get('FGA_API_SCHEME'), # optional. Can be "http" or "https". Defaults to "https"
+        api_host = os.environ.get('FGA_API_HOST'), # required, define without the scheme (e.g. api.fga.example instead of https://api.fga.example)
+        store_id = os.environ.get('FGA_STORE_ID'), # optional, not needed for \`CreateStore\` and \`ListStores\`, required before calling for all other methods
+        model_id = os.environ.get('FGA_MODEL_ID'), # optional, can be overridden per request
+        credentials = credentials,
+    )
+
+    async with OpenFgaClient(configuration) as fga_client:
+        api_response = await fga_client.read_authorization_models() # call requests
+        await fga_client.close() # close when done
 
-async with OpenFgaClient(configuration) as fga_client:
-    api_response = await fga_client.read_authorization_models() // call requests
-    await fga_client.close() // close when done
+asyncio.run(main())
 ```
 
 </TabItem>

diff --git a/docs/content/modeling/conditions.mdx b/docs/content/modeling/conditions.mdx
@@ -105,6 +105,8 @@ Write the model to the FGA store:
   allowedLanguages={[
     SupportedLanguage.JS_SDK,
     SupportedLanguage.GO_SDK,
+    SupportedLanguage.DOTNET_SDK,
+    SupportedLanguage.PYTHON_SDK,
     SupportedLanguage.CLI,
     SupportedLanguage.CURL,
   ]}
@@ -134,6 +136,8 @@ For example, we can give `user:anne` viewer access to `document:1` for 10 minute
   allowedLanguages={[
     SupportedLanguage.JS_SDK,
     SupportedLanguage.GO_SDK,
+    SupportedLanguage.DOTNET_SDK,
+    SupportedLanguage.PYTHON_SDK,
     SupportedLanguage.CLI,
     SupportedLanguage.CURL,
   ]}
@@ -152,6 +156,8 @@ Now that we have written a [Conditional Relationship Tuple](../concepts.mdx#what
   allowedLanguages={[
     SupportedLanguage.JS_SDK,
     SupportedLanguage.GO_SDK,
+    SupportedLanguage.DOTNET_SDK,
+    SupportedLanguage.PYTHON_SDK,
     SupportedLanguage.CLI,
     SupportedLanguage.CURL,
   ]}
@@ -169,6 +175,8 @@ but if the current time is outside the grant window then you get a deny decision
   allowedLanguages={[
     SupportedLanguage.JS_SDK,
     SupportedLanguage.GO_SDK,
+    SupportedLanguage.DOTNET_SDK,
+    SupportedLanguage.PYTHON_SDK,
     SupportedLanguage.CLI,
     SupportedLanguage.CURL,
   ]}
@@ -186,6 +194,8 @@ Similarly, we can use the [ListObjects API](https://openfga.dev/api/service#/Rel
   allowedLanguages={[
     SupportedLanguage.JS_SDK,
     SupportedLanguage.GO_SDK,
+    SupportedLanguage.DOTNET_SDK,
+    SupportedLanguage.PYTHON_SDK,
     SupportedLanguage.CLI,
     SupportedLanguage.CURL,
   ]}
@@ -203,6 +213,8 @@ but if the current time is outside the grant window then we don't get the object
   allowedLanguages={[
     SupportedLanguage.JS_SDK,
     SupportedLanguage.GO_SDK,
+    SupportedLanguage.DOTNET_SDK,
+    SupportedLanguage.PYTHON_SDK,
     SupportedLanguage.CLI,
     SupportedLanguage.CURL,
   ]}

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -95,10 +95,10 @@ using OpenFga.Sdk.Model;`,
         setupNote: `// ApiTokenIssuer, ApiAudience, ClientId and ClientSecret are optional.\n`,
       },
       python: {
-        importStatement: `import os
+        importStatement: `import asyncio
+import os
 import json
-from openfga_sdk.client import ClientConfiguration
-from openfga_sdk.client import OpenFgaClient`,
+from openfga_sdk.client import ClientConfiguration, OpenFgaClient`,
         apiName: `OpenFgaClient`,
         setupNote: `# ApiTokenIssuer, ApiAudience, ClientId and ClientSecret are optional.\n`,
       },

diff --git a/src/components/Docs/SnippetViewer/CheckRequestViewer.tsx b/src/components/Docs/SnippetViewer/CheckRequestViewer.tsx
@@ -139,6 +139,13 @@ var body = new ClientCheckRequest {
 })`
         : ''
     }
+    ${
+      context
+        ? `Context = new { ${Object.entries(context)
+            .map(([k, v]) => `${k}="${v}"`)
+            .join(',')} }`
+        : ''
+    }
 };
 var response = await fgaClient.Check(body, options);
 
@@ -161,6 +168,17 @@ body = ClientCheckRequest(
           .join(',\n                ')}
     ],`
         : ``
+    }${
+      context
+        ? `
+    context=dict(${Object.entries(context)
+      .map(
+        ([k, v]) => `
+        ${k}="${v}"`,
+      )
+      .join(',')}
+    )`
+        : ''
     }
 )