From fdc81b62eaf09b7ec67bdfa24961389351c4d917 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 24 Apr 2025 09:08:18 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- docs/cli/schema-contracts/create.mdx | 33 ++++++++++--------------- docs/cli/schema-contracts/update.mdx | 36 +++++++++++----------------- 2 files changed, 27 insertions(+), 42 deletions(-) diff --git a/docs/cli/schema-contracts/create.mdx b/docs/cli/schema-contracts/create.mdx index 370b422..66ed48d 100644 --- a/docs/cli/schema-contracts/create.mdx +++ b/docs/cli/schema-contracts/create.mdx @@ -1,7 +1,7 @@ --- title: "Create" description: "Creates a contract from a federated graph or monograph." -icon: plus +icon: "plus" --- ## Usage @@ -24,7 +24,7 @@ The `npx wgc contract create` command allows you to create a contract from a fed ## Parameters -* ``: The name of the contract graph you want to create. +- ``: The name of the contract graph you want to create. ## Required Options @@ -35,34 +35,27 @@ The `npx wgc contract create` command allows you to create a contract from a fed ## Options - The --exclude and --include options are currently *mutually exclusive*. An error will be returned if more than one are defined. + The --exclude and --include options are currently _mutually exclusive_. An error will be returned if more than one are defined. -* `-n, --namespace` : The namespace of the contract graph and source graph (Default: "default"). - -* `--exclude` : The list of tags that need to be excluded from the source graph schema. - -* `--include` : The list of tags that need to be included from the source graph schema. - -* `--admission-webhook-url ` the base url of the admission webhook. This is the url that the controlplane will use to implement admission control for the contract graph. Example: `https://admission.example.com` (without the `/validate-config` path name) - -* `--admission-webhook-secret`: Allows you to sign requests (HMAC) made to your admission webhook url. The header containing this signature is `X-Cosmo-Signature-256` - -* `--readme` : The markdown file which describes the contract graph. - -* `--suppress-warnings`: This flag suppresses any warnings produced by composition. +- `-n, --namespace` : The namespace of the contract graph and source graph (Default: "default"). +- `--exclude` : The list of tags that need to be excluded from the source graph schema. +- `--include` : The list of tags that need to be included from the source graph schema. +- `--admission-webhook-url ` the base url of the admission webhook. This is the url that the controlplane will use to implement admission control for the contract graph. Example: `https://admission.example.com` (without the `/validate-config` path name) +- `--admission-webhook-secret`: Allows you to sign requests (HMAC) made to your admission webhook url. The header containing this signature is `X-Cosmo-Signature-256` +- `--readme` : The markdown file which describes the contract graph. +- `--suppress-warnings`: This flag suppresses any warnings produced by composition. ## Examples ```bash -npx wgc contract create production-external --source production --exlude internal,experimental -r http://router.example.com/graphql +npx wgc contract create production-external --source production --exlude internal experimental -r http://router.example.com/graphql ``` Create a contract graph named `production-external` from the source graph schema of `production` that excludes all schema elements tagged with `internal` or `experimental`. ```bash -npx wgc contract create production-external --source production --include public,api -r http://router.example.com/graphql +npx wgc contract create production-external --source production --include public api -r http://router.example.com/graphql ``` -Create a contract graph named `production-external` from the source graph schema of `production` that excludes all schema elements tagged with `public` or `api`. - +Create a contract graph named `production-external` from the source graph schema of `production` that excludes all schema elements tagged with `public` or `api`. \ No newline at end of file diff --git a/docs/cli/schema-contracts/update.mdx b/docs/cli/schema-contracts/update.mdx index 9b95123..f42a897 100644 --- a/docs/cli/schema-contracts/update.mdx +++ b/docs/cli/schema-contracts/update.mdx @@ -1,7 +1,7 @@ --- title: "Update" description: "This command updates the tag filters for the contract. To update other aspects of the contract graph please use the federated-graph or monograph update commands." -icon: pen-to-square +icon: "pen-to-square" --- ## Usage @@ -24,41 +24,33 @@ The `npx wgc contract update` command allows you to update the tag filters for t ## Parameters -* ``: The name of the contract graph you want to update. +- ``: The name of the contract graph you want to update. ## Options - The --exclude and --include options are currently *mutually exclusive*. An error will be returned if more than one are defined. The undefined option will be automatically unset. + The --exclude and --include options are currently _mutually exclusive_. An error will be returned if more than one are defined. The undefined option will be automatically unset. -* `-n, --namespace` : The namespace of the federated graph (Default: "default"). - -* `--exclude` : The list of tags that should be excluded from the source graph schema. - -* `--include` : The list of tags that should be included from the source graph schema. - -* `-r , --routing-url`: The routing URL of your router. This URL defines the endpoint where the router will be accessible. The contract graph will be accessible through this router. - -* `--admission-webhook-url ` the base url of the admission webhook. This is the url that the controlplane will use to implement admission control for the contract graph. Example: `https://admission.example.com` (without the `/validate-config` path name) - -* `--admission-webhook-secret`: Allows you to sign requests (HMAC) made to your admission webhook url. The header containing this signature is `X-Cosmo-Signature-256` - -* `--readme` : The markdown file which describes the contract graph. - -* `--suppress-warnings`: This flag suppresses any warnings produced by composition. +- `-n, --namespace` : The namespace of the federated graph (Default: "default"). +- `--exclude` : The list of tags that should be excluded from the source graph schema. +- `--include` : The list of tags that should be included from the source graph schema. +- `-r , --routing-url`: The routing URL of your router. This URL defines the endpoint where the router will be accessible. The contract graph will be accessible through this router. +- `--admission-webhook-url ` the base url of the admission webhook. This is the url that the controlplane will use to implement admission control for the contract graph. Example: `https://admission.example.com` (without the `/validate-config` path name) +- `--admission-webhook-secret`: Allows you to sign requests (HMAC) made to your admission webhook url. The header containing this signature is `X-Cosmo-Signature-256` +- `--readme` : The markdown file which describes the contract graph. +- `--suppress-warnings`: This flag suppresses any warnings produced by composition. ## Examples ```bash -npx wgc contract update production-external --exclude experimental,deprecated +npx wgc contract update production-external --exclude experimental deprecated ``` Updates a contract graph named `production-external` with the new exclude tags: `experimental` and `deprecated`. ```bash -npx wgc contract update production-external --include public,api +npx wgc contract update production-external --include public api ``` -Updates a contract graph named `production-external` with the new include tags: `public` and `api`. - +Updates a contract graph named `production-external` with the new include tags: `public` and `api`. \ No newline at end of file