Skip to content

Update Images #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/graph_pruning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/overview_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/router/ART.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/audit-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/check_information.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/create_new_api_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/create_webhook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/graph_pruning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/studio/image-28.png
Binary file not shown.
Binary file removed docs/images/studio/image-29.png
Binary file not shown.
Binary file removed docs/images/studio/image-30.png
Binary file not shown.
Binary file added docs/images/studio/lint_check.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/new_api_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/operations_check.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/schema_checks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/schema_registry_cdl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/scim/generate-scim-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/studio/scim/image-7.png
Binary file not shown.
Binary file added docs/images/studio/sso/add-claims-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/sso/api-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/sso/connect-oidc-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/sso/connect-oidc-success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/studio/sso/connect_oidc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/studio/sso/image-1.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-10.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-12.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-17.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-18.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-2.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-3.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-4.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-5.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-6.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-7.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-8.png
Diff not rendered.
Binary file removed docs/images/studio/sso/image-9.png
Diff not rendered.
Binary file added docs/images/studio/sso/integration-name.png
Binary file added docs/images/studio/sso/map-oidc-groups.png
Binary file added docs/images/studio/sso/metadata-uri.png
Binary file added docs/images/studio/webhooks.png
Binary file added docs/images/tutorial/github-integration.png
2 changes: 1 addition & 1 deletion docs/router/advanced-request-tracing-art.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ icon: stars


<Frame>
<img src="/images/router/image-6.png" />
<img src="/images/router/ART.png" />
</Frame>

<Note>
Expand Down
4 changes: 2 additions & 2 deletions docs/studio/alerts-and-notifications/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,12 @@ const isVerified = verifySignature(JSON.stringify(req.body), req.headers['x-cosm
<Step title="Navigate to the notifications page on Cosmo"/>
<Step title="In the Webhooks tab, click on the Create button.">
<Frame>
<img src="/images/studio/image-40.png" />
<img src="/images/studio/webhooks.png" />
</Frame>
</Step>
<Step title="Provide the endpoint of the webhook, and the webhook secret for verification and then select the events you want to be notified of.">
<Frame>
<img src="/images/studio/image-41.png" />
<img src="/images/studio/create_webhook.png" />
</Frame>
</Step>
<Step title="Lastly, click on the Create button."/>
Expand Down
2 changes: 1 addition & 1 deletion docs/studio/analytics/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Metrics give a general overview of the performance of your federat
---

<Frame caption="The Metrics overview">
<img src="/images/studio/image-27.png" />
<img src="/images/studio/metrics.png" />
</Frame>

### Request rate
Expand Down
4 changes: 2 additions & 2 deletions docs/studio/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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".

<Frame>
<img src="/images/studio/image-29.png" />
<img src="/images/studio/create_new_api_key.png" />
</Frame>

* Once the API key is generated, it will be displayed for the user to copy it.
Expand All @@ -27,5 +27,5 @@ The API keys are used to authorize the user to perform actions using [wgc](/cli/
</Info>

<Frame>
<img src="/images/studio/image-30.png" />
<img src="/images/studio/new_api_key.png" />
</Frame>
2 changes: 1 addition & 1 deletion docs/studio/audit-log.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Frame caption="Audit Log View">
<img src="/images/studio/image-50.png" />
<img src="/images/studio/audit-logs.png" />
</Frame>
72 changes: 30 additions & 42 deletions docs/studio/graph-pruning.mdx
Original file line number Diff line number Diff line change
@@ -1,68 +1,56 @@
---
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"
---


<Frame>
<img src="/images/studio/image-52.png" />
![Graph Pruning Pn](/docs/images/studio/graph_pruning.png)
</Frame>

## 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

This is the time period provided to the fields modified on schema publications, allowing time before enforcing these rules during checks.

### 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

<Steps>
<Step>
Navigate to the Lint Policy page on Cosmo.
</Step>
<Step>
Select the namespace.
</Step>
<Step>
Enable the graph pruning linter.
</Step>
<Step>
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).

</Step>
</Steps>
<Step>
Navigate to the Lint Policy page on Cosmo.
</Step>
<Step>
Select the namespace.
</Step>
<Step>
Enable the graph pruning linter.
</Step>
<Step>
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).
</Step>
</Steps>
2 changes: 1 addition & 1 deletion docs/studio/overview-page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: map
---

<Frame caption="Federated Graph Overview">
<img src="/images/image-7.png" alt="Overview Page" />
<img src="/images/overview_screen.png" alt="Overview Page" />
</Frame>

## Graph details
Expand Down
8 changes: 4 additions & 4 deletions docs/studio/schema-checks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This view lists all the checks performed, showing the timestamp of each check, t


<Frame caption="Schema Checks View">
<img src="/images/studio/image-5.png" />
<img src="/images/studio/schema_checks.png" />
</Frame>

### Overview
Expand All @@ -46,7 +46,7 @@ Have a glance at your check. Understand why the check succeeded or failed, and w
</Info>

<Frame>
<img src="/images/studio/image-6.png" />
<img src="/images/studio/check_information.png" />
</Frame>

#### Manual overrides
Expand Down Expand Up @@ -74,7 +74,7 @@ You can override certain changes as safe for future checks. Learn more by clicki
</Info>

<Frame>
<img src="/images/studio/image-7.png" />
<img src="/images/studio/operations_check.png" />
</Frame>

### Operation Details
Expand All @@ -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.

<Frame>
<img src="/images/studio/image-8.png" />
<img src="/images/studio/lint_check.png" />
</Frame>

2 changes: 1 addition & 1 deletion docs/studio/schema-registry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: atom
---

<Frame caption="Schema Registry SDL view">
<img src="/images/studio/image-4.png" />
<img src="/images/studio/schema_registry_cdl.png" />
</Frame>

## Latest Schema State
Expand Down
2 changes: 1 addition & 1 deletion docs/studio/scim/okta.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

<Frame>
<img src="/images/studio/scim/image-7.png" />
<img src="/images/studio/scim/generate-scim-key.png" />
</Frame>
</Step>
<Step>
Expand Down
8 changes: 4 additions & 4 deletions docs/studio/sso/auth0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,28 +34,28 @@ description: "Setting up SSO with Auth0"
* Click on **Connect.**

<Frame>
<img src="/images/studio/sso/image-16.png" />
<img src="/images/studio/sso/connect_oidc.png" />
</Frame>
</Step>
<Step>
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,**&#x61;nd then click on **Connect.**

<Frame>
<img src="/images/studio/sso/image-17.png" />
<img src="/images/studio/sso/connect-oidc-dialog.png" />
</Frame>
</Step>
<Step>
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**.

<Frame>
<img src="/images/studio/sso/image-18.png" />
<img src="/images/studio/sso/map-oidc-groups.png" />
</Frame>
</Step>
<Step>
Copy the sign-in and sign-out redirect URIs displayed in the dialog.

<Frame>
<img src="/images/studio/sso/image-19.png" />
<img src="/images/studio/sso/connect-oidc-success.png" />
</Frame>
</Step>
<Step>
Expand Down
8 changes: 4 additions & 4 deletions docs/studio/sso/keycloak.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,28 +49,28 @@ icon: "key"
Click on **Connect.**

<Frame>
<img src="/images/studio/sso/image-27.png" />
<img src="/images/studio/sso/connect_oidc.png" />
</Frame>
</Step>
<Step>
Give the connection a name, paste the **OpenID Endpoint Configuration** copied before, into the **Discovery Endpoint,**&#x61;nd paste the **Client ID** and **Client secret**copied before into the **Client ID** and **Client Secret fields respectively,**&#x61;nd then click on **Connect.**

<Frame>
<img src="/images/studio/sso/image-28.png" />
<img src="/images/studio/sso/connect-oidc-dialog.png" />
</Frame>
</Step>
<Step>
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**.

<Frame>
<img src="/images/studio/sso/image-29.png" />
<img src="/images/studio/sso/map-oidc-groups.png" />
</Frame>
</Step>
<Step>
Copy the sign-in and sign-out redirect URIs displayed in the dialog.

<Frame>
<img src="/images/studio/sso/image-30.png" />
<img src="/images/studio/sso/connect-oidc-success.png" />
</Frame>
</Step>
<Step>
Expand Down
2 changes: 1 addition & 1 deletion docs/studio/sso/microsoft-entra.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Frame>
<img src="/images/studio/sso/image-39.png" />
<img src="/images/studio/sso/connect_oidc.png" />
</Frame>
</Step>
<Step>
Expand Down
32 changes: 16 additions & 16 deletions docs/studio/sso/okta.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,44 +15,44 @@ icon: "user-shield"
Click on **Create App Integration**.
</Step>
<Step>
A dialog appears, select OIDC - OpenID Connect as the sign-in method.
A dialog appears, select **OIDC - OpenID Connect** as the sign-in method.
</Step>
<Step>
Now select the type of application and click on **Next.**
For the application type, select **Web Application** and click on **Next**.

<Frame>
<img src="/images/studio/sso/image-1.png" />
<img src="/images/studio/sso/create-app-integration.png" />
</Frame>
</Step>
<Step>
Now give the app a name and scroll down to **Assignments.**
Now give the app a name.

<Frame>
<img src="/images/studio/sso/image-2.png" />
<img src="/images/studio/sso/integration-name.png" />
</Frame>
</Step>
<Step>
For **Grant Type,** keep the defaults.
</Step>
<Step>
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.**

<Frame>
<img src="/images/studio/sso/image-3.png" />
<img src="/images/studio/sso/integration-assignments.png" />
</Frame>
</Step>
<Step>
Copy the **Client ID** and **Client Secret.**

<Frame>
<img src="/images/studio/sso/image-4.png" />
<img src="/images/studio/sso/copy-client-credentials.png" />
</Frame>
</Step>
<Step>
Navigate to Security -> API.
Navigate to **Security** -> **API**.

<Frame>
<img src="/images/studio/sso/image-5.png" />
<img src="/images/studio/sso/api-menu.png" />
</Frame>
</Step>
<Step>
Expand All @@ -62,36 +62,36 @@ icon: "user-shield"
Copy the **Metadata URI.**

<Frame>
<img src="/images/studio/sso/image-6.png" />
<img src="/images/studio/sso/metadata-uri.png" />
</Frame>
</Step>

<Step>
Navigate to the settings page on Cosmo.

<Frame>
<img src="/images/studio/sso/image-7.png" />
<img src="/images/studio/sso/connect_oidc.png" />
</Frame>
</Step>
<Step>
Give the connection a name, paste the **Metadata URI** copied before, into the **Discovery Endpoint,**&#x61;nd paste the **Client ID** and **Client secret**copied before into the **Client ID** and **Client Secret fields respectively,**&#x61;nd then click on **Connect.**

<Frame>
<img src="/images/studio/sso/image-8.png" />
<img src="/images/studio/sso/connect-oidc-dialog.png" />
</Frame>
</Step>
<Step>
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**.

<Frame>
<img src="/images/studio/sso/image-9.png" />
<img src="/images/studio/sso/map-oidc-groups.png" />
</Frame>
</Step>
<Step>
Copy the sign-in and sign-out redirect URIs displayed in the dialog.

<Frame>
<img src="/images/studio/sso/image-10.png" />
<img src="/images/studio/sso/connect-oidc-success.png" />
</Frame>
</Step>
<Step>
Expand All @@ -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.**

<Frame>
<img src="/images/studio/sso/image-12.png" />
<img src="/images/studio/sso/add-claims-tab.png" />
</Frame>
</Step>
<Step>
Expand Down
Loading