diff --git a/docs/graph_pruning.png b/docs/graph_pruning.png new file mode 100644 index 00000000..e94d0bfd Binary files /dev/null and b/docs/graph_pruning.png differ diff --git a/docs/images/overview_screen.png b/docs/images/overview_screen.png new file mode 100644 index 00000000..69a5b3ca Binary files /dev/null and b/docs/images/overview_screen.png differ diff --git a/docs/images/router/ART.png b/docs/images/router/ART.png new file mode 100644 index 00000000..4ebcac31 Binary files /dev/null and b/docs/images/router/ART.png differ diff --git a/docs/images/studio/audit-logs.png b/docs/images/studio/audit-logs.png new file mode 100644 index 00000000..90cc420f Binary files /dev/null and b/docs/images/studio/audit-logs.png differ diff --git a/docs/images/studio/check_information.png b/docs/images/studio/check_information.png new file mode 100644 index 00000000..26a0b221 Binary files /dev/null and b/docs/images/studio/check_information.png differ diff --git a/docs/images/studio/create_new_api_key.png b/docs/images/studio/create_new_api_key.png new file mode 100644 index 00000000..acfff8c8 Binary files /dev/null and b/docs/images/studio/create_new_api_key.png differ diff --git a/docs/images/studio/create_webhook.png b/docs/images/studio/create_webhook.png new file mode 100644 index 00000000..daa1846d Binary files /dev/null and b/docs/images/studio/create_webhook.png differ diff --git a/docs/images/studio/graph_pruning.png b/docs/images/studio/graph_pruning.png new file mode 100644 index 00000000..e94d0bfd Binary files /dev/null and b/docs/images/studio/graph_pruning.png differ diff --git a/docs/images/studio/image-28.png b/docs/images/studio/image-28.png deleted file mode 100644 index 050c20cc..00000000 Binary files a/docs/images/studio/image-28.png and /dev/null differ diff --git a/docs/images/studio/image-29.png b/docs/images/studio/image-29.png deleted file mode 100644 index 95ef4174..00000000 Binary files a/docs/images/studio/image-29.png and /dev/null differ diff --git a/docs/images/studio/image-30.png b/docs/images/studio/image-30.png deleted file mode 100644 index 627f9f24..00000000 Binary files a/docs/images/studio/image-30.png and /dev/null differ diff --git a/docs/images/studio/lint_check.png b/docs/images/studio/lint_check.png new file mode 100644 index 00000000..43c12820 Binary files /dev/null and b/docs/images/studio/lint_check.png differ diff --git a/docs/images/studio/metrics.png b/docs/images/studio/metrics.png new file mode 100644 index 00000000..2919a323 Binary files /dev/null and b/docs/images/studio/metrics.png differ diff --git a/docs/images/studio/new_api_key.png b/docs/images/studio/new_api_key.png new file mode 100644 index 00000000..2f993a35 Binary files /dev/null and b/docs/images/studio/new_api_key.png differ diff --git a/docs/images/studio/operations_check.png b/docs/images/studio/operations_check.png new file mode 100644 index 00000000..39bdfee0 Binary files /dev/null and b/docs/images/studio/operations_check.png differ diff --git a/docs/images/studio/schema_checks.png b/docs/images/studio/schema_checks.png new file mode 100644 index 00000000..60711cff Binary files /dev/null and b/docs/images/studio/schema_checks.png differ diff --git a/docs/images/studio/schema_registry_cdl.png b/docs/images/studio/schema_registry_cdl.png new file mode 100644 index 00000000..3d34f932 Binary files /dev/null and b/docs/images/studio/schema_registry_cdl.png differ diff --git a/docs/images/studio/scim/generate-scim-key.png b/docs/images/studio/scim/generate-scim-key.png new file mode 100644 index 00000000..4ef71411 Binary files /dev/null and b/docs/images/studio/scim/generate-scim-key.png differ diff --git a/docs/images/studio/scim/image-7.png b/docs/images/studio/scim/image-7.png deleted file mode 100644 index 2370a08b..00000000 Binary files a/docs/images/studio/scim/image-7.png and /dev/null differ diff --git a/docs/images/studio/sso/add-claims-tab.png b/docs/images/studio/sso/add-claims-tab.png new file mode 100644 index 00000000..ee12a7d7 Binary files /dev/null and b/docs/images/studio/sso/add-claims-tab.png differ diff --git a/docs/images/studio/sso/api-menu.png b/docs/images/studio/sso/api-menu.png new file mode 100644 index 00000000..e0dacf83 Binary files /dev/null and b/docs/images/studio/sso/api-menu.png differ diff --git a/docs/images/studio/sso/connect-oidc-dialog.png b/docs/images/studio/sso/connect-oidc-dialog.png new file mode 100644 index 00000000..cbf4b1de Binary files /dev/null and b/docs/images/studio/sso/connect-oidc-dialog.png differ diff --git a/docs/images/studio/sso/connect-oidc-success.png b/docs/images/studio/sso/connect-oidc-success.png new file mode 100644 index 00000000..06e149d2 Binary files /dev/null and b/docs/images/studio/sso/connect-oidc-success.png differ diff --git a/docs/images/studio/sso/connect_oidc.png b/docs/images/studio/sso/connect_oidc.png new file mode 100644 index 00000000..e6b5ee43 Binary files /dev/null and b/docs/images/studio/sso/connect_oidc.png differ diff --git a/docs/images/studio/sso/copy-client-credentials.png b/docs/images/studio/sso/copy-client-credentials.png new file mode 100644 index 00000000..edf25f2a Binary files /dev/null and b/docs/images/studio/sso/copy-client-credentials.png differ diff --git a/docs/images/studio/sso/create-app-integration.png b/docs/images/studio/sso/create-app-integration.png new file mode 100644 index 00000000..b452ffb4 Binary files /dev/null and b/docs/images/studio/sso/create-app-integration.png differ diff --git a/docs/images/studio/sso/image-1.png b/docs/images/studio/sso/image-1.png deleted file mode 100644 index e88021f0..00000000 Binary files a/docs/images/studio/sso/image-1.png and /dev/null differ diff --git a/docs/images/studio/sso/image-10.png b/docs/images/studio/sso/image-10.png deleted file mode 100644 index 15e9652b..00000000 Binary files a/docs/images/studio/sso/image-10.png and /dev/null differ diff --git a/docs/images/studio/sso/image-12.png b/docs/images/studio/sso/image-12.png deleted file mode 100644 index 8da370ae..00000000 Binary files a/docs/images/studio/sso/image-12.png and /dev/null differ diff --git a/docs/images/studio/sso/image-17.png b/docs/images/studio/sso/image-17.png deleted file mode 100644 index 057cdc6b..00000000 Binary files a/docs/images/studio/sso/image-17.png and /dev/null differ diff --git a/docs/images/studio/sso/image-18.png b/docs/images/studio/sso/image-18.png deleted file mode 100644 index 040c5afb..00000000 Binary files a/docs/images/studio/sso/image-18.png and /dev/null differ diff --git a/docs/images/studio/sso/image-2.png b/docs/images/studio/sso/image-2.png deleted file mode 100644 index ae124b0e..00000000 Binary files a/docs/images/studio/sso/image-2.png and /dev/null differ diff --git a/docs/images/studio/sso/image-3.png b/docs/images/studio/sso/image-3.png deleted file mode 100644 index 6350de3d..00000000 Binary files a/docs/images/studio/sso/image-3.png and /dev/null differ diff --git a/docs/images/studio/sso/image-4.png b/docs/images/studio/sso/image-4.png deleted file mode 100644 index f0b5d923..00000000 Binary files a/docs/images/studio/sso/image-4.png and /dev/null differ diff --git a/docs/images/studio/sso/image-5.png b/docs/images/studio/sso/image-5.png deleted file mode 100644 index f5bdf5b7..00000000 Binary files a/docs/images/studio/sso/image-5.png and /dev/null differ diff --git a/docs/images/studio/sso/image-6.png b/docs/images/studio/sso/image-6.png deleted file mode 100644 index 1d6d00a7..00000000 Binary files a/docs/images/studio/sso/image-6.png and /dev/null differ diff --git a/docs/images/studio/sso/image-7.png b/docs/images/studio/sso/image-7.png deleted file mode 100644 index 4f73d106..00000000 Binary files a/docs/images/studio/sso/image-7.png and /dev/null differ diff --git a/docs/images/studio/sso/image-8.png b/docs/images/studio/sso/image-8.png deleted file mode 100644 index ee91f94c..00000000 Binary files a/docs/images/studio/sso/image-8.png and /dev/null differ diff --git a/docs/images/studio/sso/image-9.png b/docs/images/studio/sso/image-9.png deleted file mode 100644 index 59a1db9c..00000000 Binary files a/docs/images/studio/sso/image-9.png and /dev/null differ diff --git a/docs/images/studio/sso/integration-assignments.png b/docs/images/studio/sso/integration-assignments.png new file mode 100644 index 00000000..770253f8 Binary files /dev/null and b/docs/images/studio/sso/integration-assignments.png differ diff --git a/docs/images/studio/sso/integration-name.png b/docs/images/studio/sso/integration-name.png new file mode 100644 index 00000000..9c670c8f Binary files /dev/null and b/docs/images/studio/sso/integration-name.png differ diff --git a/docs/images/studio/sso/map-oidc-groups.png b/docs/images/studio/sso/map-oidc-groups.png new file mode 100644 index 00000000..0455e8e2 Binary files /dev/null and b/docs/images/studio/sso/map-oidc-groups.png differ diff --git a/docs/images/studio/sso/metadata-uri.png b/docs/images/studio/sso/metadata-uri.png new file mode 100644 index 00000000..0ac9245a Binary files /dev/null and b/docs/images/studio/sso/metadata-uri.png differ diff --git a/docs/images/studio/webhooks.png b/docs/images/studio/webhooks.png new file mode 100644 index 00000000..ab2dc73e Binary files /dev/null and b/docs/images/studio/webhooks.png differ diff --git a/docs/images/tutorial/github-integration.png b/docs/images/tutorial/github-integration.png new file mode 100644 index 00000000..3ed5e975 Binary files /dev/null and b/docs/images/tutorial/github-integration.png differ diff --git a/docs/router/advanced-request-tracing-art.mdx b/docs/router/advanced-request-tracing-art.mdx index 6baf7fd5..e389254c 100644 --- a/docs/router/advanced-request-tracing-art.mdx +++ b/docs/router/advanced-request-tracing-art.mdx @@ -6,7 +6,7 @@ icon: stars - + diff --git a/docs/studio/alerts-and-notifications/webhooks.mdx b/docs/studio/alerts-and-notifications/webhooks.mdx index 14230b0d..b835095b 100644 --- a/docs/studio/alerts-and-notifications/webhooks.mdx +++ b/docs/studio/alerts-and-notifications/webhooks.mdx @@ -77,12 +77,12 @@ const isVerified = verifySignature(JSON.stringify(req.body), req.headers['x-cosm - + - + diff --git a/docs/studio/analytics/metrics.mdx b/docs/studio/analytics/metrics.mdx index 80a10d73..a985fd7e 100644 --- a/docs/studio/analytics/metrics.mdx +++ b/docs/studio/analytics/metrics.mdx @@ -5,7 +5,7 @@ description: "Metrics give a general overview of the performance of your federat --- - + ### Request rate diff --git a/docs/studio/api-keys.mdx b/docs/studio/api-keys.mdx index 3813afa7..48f99f82 100644 --- a/docs/studio/api-keys.mdx +++ b/docs/studio/api-keys.mdx @@ -17,7 +17,7 @@ The API keys are used to authorize the user to perform actions using [wgc](/cli/ * Give the API key a name, select the expiry, and then click on "Generate API key". - + * Once the API key is generated, it will be displayed for the user to copy it. @@ -27,5 +27,5 @@ The API keys are used to authorize the user to perform actions using [wgc](/cli/ - + diff --git a/docs/studio/audit-log.mdx b/docs/studio/audit-log.mdx index 3d37a9a4..991bb1cb 100644 --- a/docs/studio/audit-log.mdx +++ b/docs/studio/audit-log.mdx @@ -9,5 +9,5 @@ Audit logs are crucial for several reasons. First, they provide a detailed recor Navigate to your organization's page and click on "Audit Log." You will see all audit logs arranged in descending order by their creation date. Each log entry is annotated with information about who performed the action, what was done, and when it occurred. Based on the icon next to the actor, you can determine if the action was performed directly by a user or through their API key. Additionally, several events generated from the Cosmo Platform can be identified accordingly. - + diff --git a/docs/studio/graph-pruning.mdx b/docs/studio/graph-pruning.mdx index 5093715f..dd6ed946 100644 --- a/docs/studio/graph-pruning.mdx +++ b/docs/studio/graph-pruning.mdx @@ -1,35 +1,28 @@ --- title: "Graph Pruning" description: "**Graph Pruning Linter** helps manage the cleanliness and efficiency of your GraphQL schema by running various checks on the schema. When enabled, the lint check will be performed on every [check](https://cosmo-docs.wundergraph.com/cli/subgraph/check) operation of that namespace." -icon: broom-wide +icon: "broom-wide" --- - - + ![Graph Pruning Pn](/docs/images/studio/graph_pruning.png) ## Rules -1. UNUSED\_FIELDS - - * Identifies and lists all fields that are not being used in the schema. - -2. DEPRECATED\_FIELDS - - * Detects fields that have been deprecated but have not yet been removed from the schema. - -3. REQUIRE\_DEPRECATION\_BEFORE\_DELETION - - * Identifies fields that were deleted without being marked as deprecated beforehand. +1. UNUSED_FIELDS + - Identifies and lists all fields that are not being used in the schema. +2. DEPRECATED_FIELDS + - Detects fields that have been deprecated but have not yet been removed from the schema. +3. REQUIRE_DEPRECATION_BEFORE_DELETION + - Identifies fields that were deleted without being marked as deprecated beforehand. ## Rule Configurations ### Severity Level -* Error:- If any configured rules are violated, it causes the check operation to fail. - -* Warning:- If any configured rules are violated, they are flagged as warnings, but they don't cause the check operation to fail. +- Error:- If any configured rules are violated, it causes the check operation to fail. +- Warning:- If any configured rules are violated, they are flagged as warnings, but they don't cause the check operation to fail. ### Grace Period @@ -37,32 +30,27 @@ This is the time period provided to the fields modified on schema publications, ### Schema Usage Check Period (Enterprise only) -* This is the time period used to check the usage of the field. - -* For non-enterprise customers, the value is determined by the limits imposed on the organization according to its current billing plan. +- This is the time period used to check the usage of the field. +- For non-enterprise customers, the value is determined by the limits imposed on the organization according to its current billing plan. ## How to configure graph pruning linter - -Navigate to the Lint Policy page on Cosmo. - - -Select the namespace. - - -Enable the graph pruning linter. - - -Configure the linter rules: - - * Check the checkbox to enable each rule. - - * Select the **severity level** (Warning or Error) for each rule. - - * Set the **grace period** for fields that are modified upon schema publication, allowing time before enforcing these rules during checks. - - * Configure the **schema usage check period** (available only for enterprise customers). - - - + + Navigate to the Lint Policy page on Cosmo. + + + Select the namespace. + + + Enable the graph pruning linter. + + + Configure the linter rules: + + - Check the checkbox to enable each rule. + - Select the **severity level** (Warning or Error) for each rule. + - Set the **grace period** for fields that are modified upon schema publication, allowing time before enforcing these rules during checks. + - Configure the **schema usage check period** (available only for enterprise customers). + + \ No newline at end of file diff --git a/docs/studio/overview-page.mdx b/docs/studio/overview-page.mdx index 5684bd3a..cfdaee53 100644 --- a/docs/studio/overview-page.mdx +++ b/docs/studio/overview-page.mdx @@ -5,7 +5,7 @@ icon: map --- - Overview Page + Overview Page ## Graph details diff --git a/docs/studio/schema-checks.mdx b/docs/studio/schema-checks.mdx index 2c1c74c3..b5fc9199 100644 --- a/docs/studio/schema-checks.mdx +++ b/docs/studio/schema-checks.mdx @@ -34,7 +34,7 @@ This view lists all the checks performed, showing the timestamp of each check, t - + ### Overview @@ -46,7 +46,7 @@ Have a glance at your check. Understand why the check succeeded or failed, and w - + #### Manual overrides @@ -74,7 +74,7 @@ You can override certain changes as safe for future checks. Learn more by clicki - + ### Operation Details @@ -86,6 +86,6 @@ If you click on a specific operation, you can view all the changes that have imp Lists all the lint errors/warnings found in the proposed schema. - + diff --git a/docs/studio/schema-registry.mdx b/docs/studio/schema-registry.mdx index 7ce6c346..580f3eb0 100644 --- a/docs/studio/schema-registry.mdx +++ b/docs/studio/schema-registry.mdx @@ -5,7 +5,7 @@ icon: atom --- - + ## Latest Schema State diff --git a/docs/studio/scim/okta.mdx b/docs/studio/scim/okta.mdx index 1ebf3ccd..e60969df 100644 --- a/docs/studio/scim/okta.mdx +++ b/docs/studio/scim/okta.mdx @@ -76,7 +76,7 @@ Navigate to the API Keys page on WunderGraph Cosmo and click on New API Key. Provide the key with a name, select **Never** for **Expires,** then select **SCIM**under **Permissions, t**hen click on **Generate API key.** - + diff --git a/docs/studio/sso/auth0.mdx b/docs/studio/sso/auth0.mdx index c9ff163a..5365bfd1 100644 --- a/docs/studio/sso/auth0.mdx +++ b/docs/studio/sso/auth0.mdx @@ -34,28 +34,28 @@ description: "Setting up SSO with Auth0" * Click on **Connect.** - + Give the connection a name, the **Discovery Endpoint** will be `https://YOUR_AUTH0_DOMAIN/.well-known/openid-configuration` **,** and paste the **Client ID** and **Client secret**copied before into the **Client ID** and **Client Secret fields respectively,**and then click on **Connect.** - + Configure the mapping between the roles in Cosmo and the user roles in Auth0. The field **Group in the provider** can be populated with the name of the role or a regex to match the user roles. Once all the mappers are configured, click on **Save**. - + Copy the sign-in and sign-out redirect URIs displayed in the dialog. - + diff --git a/docs/studio/sso/keycloak.mdx b/docs/studio/sso/keycloak.mdx index 15c3265f..3b970d01 100644 --- a/docs/studio/sso/keycloak.mdx +++ b/docs/studio/sso/keycloak.mdx @@ -49,28 +49,28 @@ icon: "key" Click on **Connect.** - + Give the connection a name, paste the **OpenID Endpoint Configuration** copied before, into the **Discovery Endpoint,**and paste the **Client ID** and **Client secret**copied before into the **Client ID** and **Client Secret fields respectively,**and then click on **Connect.** - + Configure the mapping between the roles in Cosmo and the user groups in Keycloak. The field **Group in the provider** can be populated with the name of the group or a regex to match the user groups. Once all the mappers are configured, click on **Save**. - + Copy the sign-in and sign-out redirect URIs displayed in the dialog. - + diff --git a/docs/studio/sso/microsoft-entra.mdx b/docs/studio/sso/microsoft-entra.mdx index 73e85a15..601fd63a 100644 --- a/docs/studio/sso/microsoft-entra.mdx +++ b/docs/studio/sso/microsoft-entra.mdx @@ -63,7 +63,7 @@ Copy the **value(client secret)** and store it, as it won't be shown again. Navigate to the settings page on Cosmo. - + diff --git a/docs/studio/sso/okta.mdx b/docs/studio/sso/okta.mdx index 8bee57c9..897fdbbe 100644 --- a/docs/studio/sso/okta.mdx +++ b/docs/studio/sso/okta.mdx @@ -15,44 +15,44 @@ icon: "user-shield" Click on **Create App Integration**. - A dialog appears, select OIDC - OpenID Connect as the sign-in method. + A dialog appears, select **OIDC - OpenID Connect** as the sign-in method. - Now select the type of application and click on **Next.** + For the application type, select **Web Application** and click on **Next**. - + - Now give the app a name and scroll down to **Assignments.** + Now give the app a name. - + For **Grant Type,** keep the defaults. - For **Assignments,** select one of the options based on your choice and then click on **Save.** + Scroll down to the **Assignments** section and select one of the options based on your choice and then click on **Save.** - + Copy the **Client ID** and **Client Secret.** - + - Navigate to Security -> API. + Navigate to **Security** -> **API**. - + @@ -62,7 +62,7 @@ icon: "user-shield" Copy the **Metadata URI.** - + @@ -70,28 +70,28 @@ icon: "user-shield" Navigate to the settings page on Cosmo. - + Give the connection a name, paste the **Metadata URI** copied before, into the **Discovery Endpoint,**and paste the **Client ID** and **Client secret**copied before into the **Client ID** and **Client Secret fields respectively,**and then click on **Connect.** - + Configure the mapping between the roles in Cosmo and the user groups in Okta. The field **Group in the provider** can be populated with the name of the group or a regex to match the user groups. Once all the mappers are configured, click on **Save**. - + Copy the sign-in and sign-out redirect URIs displayed in the dialog. - + @@ -106,7 +106,7 @@ icon: "user-shield" Navigate to Security-> API, and click on the **default** auth server. Navigate to the **claims** tab and then click on **Add Claim.** - + diff --git a/docs/tutorial/pr-based-workflow-for-federation.mdx b/docs/tutorial/pr-based-workflow-for-federation.mdx index 8195e7bc..b114f6d3 100644 --- a/docs/tutorial/pr-based-workflow-for-federation.mdx +++ b/docs/tutorial/pr-based-workflow-for-federation.mdx @@ -48,7 +48,7 @@ jobs: By installing the [Cosmo GitHub App](https://github.com/apps/wundergraph-cosmo) onto your repositories, we can apply status checks to commits in your pull request. - Cosmo GitHub App Integration + Cosmo GitHub App Integration The check fails if composition errors or breaking changes are detected. In the case of only breaking changes, you can override the status of the check in the Studio.