From 1afbb29ca59bb1180e604446bafd8f2003ef7ae8 Mon Sep 17 00:00:00 2001 From: hasura-bot Date: Tue, 15 Jul 2025 12:21:15 +0000 Subject: [PATCH] Updates CLI docs --- docs/reference/cli/commands/ddn_auth_login.mdx | 14 +++++++++++--- docs/reference/cli/commands/ddn_context_get.mdx | 2 +- docs/reference/cli/commands/ddn_context_set.mdx | 2 +- docs/reference/cli/commands/ddn_context_unset.mdx | 2 +- docs/reference/cli/commands/ddn_subgraph_init.mdx | 2 +- .../reference/cli/commands/ddn_supergraph_init.mdx | 2 +- 6 files changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/reference/cli/commands/ddn_auth_login.mdx b/docs/reference/cli/commands/ddn_auth_login.mdx index 961f22cb3..07d8384d4 100644 --- a/docs/reference/cli/commands/ddn_auth_login.mdx +++ b/docs/reference/cli/commands/ddn_auth_login.mdx @@ -31,14 +31,22 @@ ddn auth login [flags] # Login with Personal Access Token ddn auth login --access-token + +# Login with OIDC ID Token + ddn auth login --oidc-id-token + +# Login with OIDC Access Token + ddn auth login --oidc-access-token ``` ## Options ```sass - --access-token string The Personal Access Token or Service Account Token [env: HASURA_DDN_ACCESS_TOKEN] --h, --help help for login - --pat string Personal Access token [env: HASURA_DDN_PAT] (DEPRECATED: use --access-token instead) + --access-token string The Personal Access Token or Service Account Token [env: HASURA_DDN_ACCESS_TOKEN] +-h, --help help for login + --oidc-access-token string The OIDC Access Token [env: HASURA_DDN_OIDC_ACCESS_TOKEN] + --oidc-id-token string The OIDC ID Token [env: HASURA_DDN_OIDC_ID_TOKEN] + --pat string Personal Access token [env: HASURA_DDN_PAT] (DEPRECATED: use --access-token instead) ``` ## Options inherited from parent operations diff --git a/docs/reference/cli/commands/ddn_context_get.mdx b/docs/reference/cli/commands/ddn_context_get.mdx index 293370ab2..9e2063aa2 100644 --- a/docs/reference/cli/commands/ddn_context_get.mdx +++ b/docs/reference/cli/commands/ddn_context_get.mdx @@ -20,7 +20,7 @@ Get the value of a key in the context. Get the value of a key in the context ```bash -ddn context get (Allowed keys: project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane, noBuildConnectors) [flags] +ddn context get (Allowed keys: noBuildConnectors, project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane) [flags] ``` ## Examples diff --git a/docs/reference/cli/commands/ddn_context_set.mdx b/docs/reference/cli/commands/ddn_context_set.mdx index 3d4f18fe4..9a390c235 100644 --- a/docs/reference/cli/commands/ddn_context_set.mdx +++ b/docs/reference/cli/commands/ddn_context_set.mdx @@ -20,7 +20,7 @@ Set the value of a key in the context. Set default value of keys to be used in DDN CLI commands. ```bash -ddn context set (Allowed keys: noBuildConnectors, project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane) [flags] +ddn context set (Allowed keys: cloudEnvFile, selfHostedDataPlane, noBuildConnectors, project, supergraph, subgraph, localEnvFile) [flags] ``` ## Examples diff --git a/docs/reference/cli/commands/ddn_context_unset.mdx b/docs/reference/cli/commands/ddn_context_unset.mdx index 8d4d9436d..b79da3e1d 100644 --- a/docs/reference/cli/commands/ddn_context_unset.mdx +++ b/docs/reference/cli/commands/ddn_context_unset.mdx @@ -20,7 +20,7 @@ Unset the value of a key in the context. Unset the value of a key in the context ```bash -ddn context unset (Allowed keys: project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane, noBuildConnectors) [flags] +ddn context unset (Allowed keys: subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane, noBuildConnectors, project, supergraph) [flags] ``` ## Examples diff --git a/docs/reference/cli/commands/ddn_subgraph_init.mdx b/docs/reference/cli/commands/ddn_subgraph_init.mdx index 45d743d11..550dc3a29 100644 --- a/docs/reference/cli/commands/ddn_subgraph_init.mdx +++ b/docs/reference/cli/commands/ddn_subgraph_init.mdx @@ -40,7 +40,7 @@ ddn subgraph init --dir [flags] --graphql-root-field-prefix string Prefix to use while generating GraphQL root fields --graphql-type-name-prefix string Prefix to use while generating GraphQL type names -h, --help help for init - --subgraph-naming-convention string Naming convention for the subgraph. Can be 'graphql', 'snake_case' or 'none'. + --subgraph-naming-convention string Naming convention for the subgraph. Can be 'graphql', 'snake_case', 'snake_case_v2' or 'none'. --target-supergraph stringArray Supergraph config file to add the Subgraph. Can be repeated to provide multiple Supergraph config files ``` diff --git a/docs/reference/cli/commands/ddn_supergraph_init.mdx b/docs/reference/cli/commands/ddn_supergraph_init.mdx index c14dc02e7..7269ff270 100644 --- a/docs/reference/cli/commands/ddn_supergraph_init.mdx +++ b/docs/reference/cli/commands/ddn_supergraph_init.mdx @@ -45,7 +45,7 @@ ddn supergraph init [flags] --project-data-plane-id uuid The DDN instance where the Project should be hosted, only used with --create-project flag or --with-promptql flag --project-name string Create a new project with this name, only used with --create-project flag or --with-promptql flag --project-plan string DDN Project plan, only used with --create-project flag or --with-promptql flag - --subgraph-naming-convention string Naming convention for the subgraph. Can be 'graphql', 'snake_case' or 'none'. + --subgraph-naming-convention string Naming convention for the subgraph. Can be 'graphql', 'snake_case', 'snake_case_v2' or 'none'. --with-project string Use an existing project instead of creating a new one, only used with --create-project flag or --with-promptql flag --with-promptql Initialize with PromptQL support, this also initializes a project with PromptQL enabled. (alpha) ```