diff --git a/docs/cli/mcp.mdx b/docs/cli/mcp.mdx index 359d1e41..d87ba0fc 100644 --- a/docs/cli/mcp.mdx +++ b/docs/cli/mcp.mdx @@ -25,7 +25,7 @@ To install the MCP Server, you'll need to create an API key and configure your I You can create an API key in [Cosmo Studio](https://cosmo.wundergraph.com). -![Create API key](/images/studio/create_api_key.png) +![Graphs section with Members tab](/images/studio/graphs-section-with-members-tab.png) ### 2. Configure your IDE diff --git a/docs/images/studio/create_new_api_key.png b/docs/images/studio/api-key-creation-dialog.png similarity index 100% rename from docs/images/studio/create_new_api_key.png rename to docs/images/studio/api-key-creation-dialog.png diff --git a/docs/images/studio/new_api_key.png b/docs/images/studio/api-key-generation-and-copy-prompt.png similarity index 100% rename from docs/images/studio/new_api_key.png rename to docs/images/studio/api-key-generation-and-copy-prompt.png diff --git a/docs/images/studio/image-37.png b/docs/images/studio/api-keys-highlighted-in-general-settings.png similarity index 100% rename from docs/images/studio/image-37.png rename to docs/images/studio/api-keys-highlighted-in-general-settings.png diff --git a/docs/images/studio/api-key-list.png b/docs/images/studio/api-keys-management-page.png similarity index 100% rename from docs/images/studio/api-key-list.png rename to docs/images/studio/api-keys-management-page.png diff --git a/docs/images/studio/image-39.png b/docs/images/studio/apollo-migration-page-with-api-key-fields.png similarity index 100% rename from docs/images/studio/image-39.png rename to docs/images/studio/apollo-migration-page-with-api-key-fields.png diff --git a/docs/images/studio/authentication.png b/docs/images/studio/app-settings-page.png similarity index 100% rename from docs/images/studio/authentication.png rename to docs/images/studio/app-settings-page.png diff --git a/docs/images/studio/image-18.png b/docs/images/studio/authorization-variable-setup.png similarity index 100% rename from docs/images/studio/image-18.png rename to docs/images/studio/authorization-variable-setup.png diff --git a/docs/images/studio/image-36.png b/docs/images/studio/build-variant-settings-this-graph.png similarity index 100% rename from docs/images/studio/image-36.png rename to docs/images/studio/build-variant-settings-this-graph.png diff --git a/docs/images/studio/image-34.png b/docs/images/studio/cloud-supergraph-section-overview.png similarity index 100% rename from docs/images/studio/image-34.png rename to docs/images/studio/cloud-supergraph-section-overview.png diff --git a/docs/images/studio/image-26.png b/docs/images/studio/composition-error-from-missing-field.png similarity index 100% rename from docs/images/studio/image-26.png rename to docs/images/studio/composition-error-from-missing-field.png diff --git a/docs/images/studio/image-14.png b/docs/images/studio/composition-updates-in-wundergraph-docs.png similarity index 100% rename from docs/images/studio/image-14.png rename to docs/images/studio/composition-updates-in-wundergraph-docs.png diff --git a/docs/images/studio/image-24.png b/docs/images/studio/compositions-list-with-composes-status.png similarity index 100% rename from docs/images/studio/image-24.png rename to docs/images/studio/compositions-list-with-composes-status.png diff --git a/docs/images/studio/api-key-permissions.png b/docs/images/studio/create-api-key-dialog.png similarity index 100% rename from docs/images/studio/api-key-permissions.png rename to docs/images/studio/create-api-key-dialog.png diff --git a/docs/images/studio/image-38.png b/docs/images/studio/create-api-key-for-spotify-demo-graph.png similarity index 100% rename from docs/images/studio/image-38.png rename to docs/images/studio/create-api-key-for-spotify-demo-graph.png diff --git a/docs/images/studio/image-42.png b/docs/images/studio/create-slack-integration.png similarity index 100% rename from docs/images/studio/image-42.png rename to docs/images/studio/create-slack-integration.png diff --git a/docs/images/studio/create_webhook.png b/docs/images/studio/create-webhook-dialog.png similarity index 100% rename from docs/images/studio/create_webhook.png rename to docs/images/studio/create-webhook-dialog.png diff --git a/docs/images/studio/deprecated-fields.png b/docs/images/studio/deprecated-fields-in-cosmo-studio-schema-explorer.png similarity index 100% rename from docs/images/studio/deprecated-fields.png rename to docs/images/studio/deprecated-fields-in-cosmo-studio-schema-explorer.png diff --git a/docs/images/studio/image-13.png b/docs/images/studio/employee-override-configuration.png similarity index 100% rename from docs/images/studio/image-13.png rename to docs/images/studio/employee-override-configuration.png diff --git a/docs/images/studio/image-15.png b/docs/images/studio/employee-query-in-graphiql-playground.png similarity index 100% rename from docs/images/studio/image-15.png rename to docs/images/studio/employee-query-in-graphiql-playground.png diff --git a/docs/images/studio/operations_check.png b/docs/images/studio/failed-operation-update-with-lint-issues.png similarity index 100% rename from docs/images/studio/operations_check.png rename to docs/images/studio/failed-operation-update-with-lint-issues.png diff --git a/docs/images/studio/image-10.png b/docs/images/studio/failed-schema-update-affecting-query-employees.png similarity index 100% rename from docs/images/studio/image-10.png rename to docs/images/studio/failed-schema-update-affecting-query-employees.png diff --git a/docs/images/studio/type-scopes.png b/docs/images/studio/field-details-for-factcontent-type.png similarity index 100% rename from docs/images/studio/type-scopes.png rename to docs/images/studio/field-details-for-factcontent-type.png diff --git a/docs/images/studio/image-11.png b/docs/images/studio/field-type-changes-in-employees-and-roles.png similarity index 100% rename from docs/images/studio/image-11.png rename to docs/images/studio/field-type-changes-in-employees-and-roles.png diff --git a/docs/images/studio/graph_pruning.png b/docs/images/studio/graph-pruning-lint-rules-overview.png similarity index 100% rename from docs/images/studio/graph_pruning.png rename to docs/images/studio/graph-pruning-lint-rules-overview.png diff --git a/docs/images/studio/create_api_key.png b/docs/images/studio/graphs-section-with-members-tab.png similarity index 100% rename from docs/images/studio/create_api_key.png rename to docs/images/studio/graphs-section-with-members-tab.png diff --git a/docs/images/studio/delete-group-dialog.png b/docs/images/studio/group-deletion-confirmation-dialog.png similarity index 100% rename from docs/images/studio/delete-group-dialog.png rename to docs/images/studio/group-deletion-confirmation-dialog.png diff --git a/docs/images/studio/delete-group-dialog2.png b/docs/images/studio/group-deletion-with-reassignment-option.png similarity index 100% rename from docs/images/studio/delete-group-dialog2.png rename to docs/images/studio/group-deletion-with-reassignment-option.png diff --git a/docs/images/studio/group-list.png b/docs/images/studio/groups-default-roles-overview.png similarity index 100% rename from docs/images/studio/group-list.png rename to docs/images/studio/groups-default-roles-overview.png diff --git a/docs/images/studio/image-19.png b/docs/images/studio/image-19.png deleted file mode 100644 index ef2aeddb..00000000 Binary files a/docs/images/studio/image-19.png and /dev/null differ diff --git a/docs/images/studio/image-20.png b/docs/images/studio/image-20.png deleted file mode 100644 index acd3c1a2..00000000 Binary files a/docs/images/studio/image-20.png and /dev/null differ diff --git a/docs/images/studio/image-21.png b/docs/images/studio/image-21.png deleted file mode 100644 index f17824e5..00000000 Binary files a/docs/images/studio/image-21.png and /dev/null differ diff --git a/docs/images/studio/image-22.png b/docs/images/studio/image-22.png deleted file mode 100644 index 80d37a69..00000000 Binary files a/docs/images/studio/image-22.png and /dev/null differ diff --git a/docs/images/studio/image-23.png b/docs/images/studio/image-23.png deleted file mode 100644 index adebdfe2..00000000 Binary files a/docs/images/studio/image-23.png and /dev/null differ diff --git a/docs/images/studio/image-27.png b/docs/images/studio/image-27.png deleted file mode 100644 index 2973eca7..00000000 Binary files a/docs/images/studio/image-27.png and /dev/null differ diff --git a/docs/images/studio/image-4.png b/docs/images/studio/image-4.png deleted file mode 100644 index f08cc496..00000000 Binary files a/docs/images/studio/image-4.png and /dev/null differ diff --git a/docs/images/studio/image-40.png b/docs/images/studio/image-40.png deleted file mode 100644 index 18c29f83..00000000 Binary files a/docs/images/studio/image-40.png and /dev/null differ diff --git a/docs/images/studio/image-41.png b/docs/images/studio/image-41.png deleted file mode 100644 index 7c1f5b10..00000000 Binary files a/docs/images/studio/image-41.png and /dev/null differ diff --git a/docs/images/studio/image-46.png b/docs/images/studio/image-46.png deleted file mode 100644 index 79893325..00000000 Binary files a/docs/images/studio/image-46.png and /dev/null differ diff --git a/docs/images/studio/image-47.png b/docs/images/studio/image-47.png deleted file mode 100644 index c5aac146..00000000 Binary files a/docs/images/studio/image-47.png and /dev/null differ diff --git a/docs/images/studio/image-5.png b/docs/images/studio/image-5.png deleted file mode 100644 index 61773fb3..00000000 Binary files a/docs/images/studio/image-5.png and /dev/null differ diff --git a/docs/images/studio/image-50.png b/docs/images/studio/image-50.png deleted file mode 100644 index 4c775fa8..00000000 Binary files a/docs/images/studio/image-50.png and /dev/null differ diff --git a/docs/images/studio/image-51.png b/docs/images/studio/image-51.png deleted file mode 100644 index e5814038..00000000 Binary files a/docs/images/studio/image-51.png and /dev/null differ diff --git a/docs/images/studio/image-52.png b/docs/images/studio/image-52.png deleted file mode 100644 index c7cf5b33..00000000 Binary files a/docs/images/studio/image-52.png and /dev/null differ diff --git a/docs/images/studio/image-6.png b/docs/images/studio/image-6.png deleted file mode 100644 index 50c7ca81..00000000 Binary files a/docs/images/studio/image-6.png and /dev/null differ diff --git a/docs/images/studio/image-7.png b/docs/images/studio/image-7.png deleted file mode 100644 index 8095c910..00000000 Binary files a/docs/images/studio/image-7.png and /dev/null differ diff --git a/docs/images/studio/image-8.png b/docs/images/studio/image-8.png deleted file mode 100644 index 524c3f6c..00000000 Binary files a/docs/images/studio/image-8.png and /dev/null differ diff --git a/docs/images/studio/image-9.png b/docs/images/studio/image-9.png deleted file mode 100644 index 099b56fb..00000000 Binary files a/docs/images/studio/image-9.png and /dev/null differ diff --git a/docs/images/studio/image-55.png b/docs/images/studio/lint-policy-default-tab-active.png similarity index 100% rename from docs/images/studio/image-55.png rename to docs/images/studio/lint-policy-default-tab-active.png diff --git a/docs/images/studio/image-54.png b/docs/images/studio/lint-policy-enabled-with-apply-option.png similarity index 100% rename from docs/images/studio/image-54.png rename to docs/images/studio/lint-policy-enabled-with-apply-option.png diff --git a/docs/images/studio/field-scopes.png b/docs/images/studio/mutation-scopes-addfact.png similarity index 100% rename from docs/images/studio/field-scopes.png rename to docs/images/studio/mutation-scopes-addfact.png diff --git a/docs/images/studio/image-33.png b/docs/images/studio/no-graphs-found-migrate-from-apollo.png similarity index 100% rename from docs/images/studio/image-33.png rename to docs/images/studio/no-graphs-found-migrate-from-apollo.png diff --git a/docs/images/studio/image-2.png b/docs/images/studio/object-search-interface-with-categories.png similarity index 100% rename from docs/images/studio/image-2.png rename to docs/images/studio/object-search-interface-with-categories.png diff --git a/docs/images/studio/image-17.png b/docs/images/studio/operation-execution-workflow.png similarity index 100% rename from docs/images/studio/image-17.png rename to docs/images/studio/operation-execution-workflow.png diff --git a/docs/images/studio/image-12.png b/docs/images/studio/operations-with-overrides-and-status-info.png similarity index 100% rename from docs/images/studio/image-12.png rename to docs/images/studio/operations-with-overrides-and-status-info.png diff --git a/docs/images/studio/image-53.png b/docs/images/studio/organization-invitation-prompt.png similarity index 100% rename from docs/images/studio/image-53.png rename to docs/images/studio/organization-invitation-prompt.png diff --git a/docs/images/studio/image-16.png b/docs/images/studio/parallel-queries-for-employees-and-products.png similarity index 100% rename from docs/images/studio/image-16.png rename to docs/images/studio/parallel-queries-for-employees-and-products.png diff --git a/docs/images/studio/image-45.png b/docs/images/studio/rbac-settings-with-enable-option.png similarity index 100% rename from docs/images/studio/image-45.png rename to docs/images/studio/rbac-settings-with-enable-option.png diff --git a/docs/images/studio/group-example2.png b/docs/images/studio/role-permissions-settings-page.png similarity index 100% rename from docs/images/studio/group-example2.png rename to docs/images/studio/role-permissions-settings-page.png diff --git a/docs/images/studio/image-48.png b/docs/images/studio/router-cluster-with-memory-stats.png similarity index 100% rename from docs/images/studio/image-48.png rename to docs/images/studio/router-cluster-with-memory-stats.png diff --git a/docs/images/studio/image-49.png b/docs/images/studio/router-details-with-uptime-and-cpu-stats.png similarity index 100% rename from docs/images/studio/image-49.png rename to docs/images/studio/router-details-with-uptime-and-cpu-stats.png diff --git a/docs/images/studio/update-group-screen.png b/docs/images/studio/rule-configuration-for-test-and-admin.png similarity index 100% rename from docs/images/studio/update-group-screen.png rename to docs/images/studio/rule-configuration-for-test-and-admin.png diff --git a/docs/images/studio/group-graph-resource-selector.png b/docs/images/studio/rule-granting-full-access-to-resources.png similarity index 100% rename from docs/images/studio/group-graph-resource-selector.png rename to docs/images/studio/rule-granting-full-access-to-resources.png diff --git a/docs/images/image-8.png b/docs/images/studio/schema-check-days-to-consider.png similarity index 100% rename from docs/images/image-8.png rename to docs/images/studio/schema-check-days-to-consider.png diff --git a/docs/images/studio/image-25.png b/docs/images/studio/schema-composed-successfully-without-changes.png similarity index 100% rename from docs/images/studio/image-25.png rename to docs/images/studio/schema-composed-successfully-without-changes.png diff --git a/docs/images/studio/explorer.png b/docs/images/studio/schema-explorer-query-fields-overview.png similarity index 100% rename from docs/images/studio/explorer.png rename to docs/images/studio/schema-explorer-query-fields-overview.png diff --git a/docs/images/studio/lint_check.png b/docs/images/studio/schema-update-with-no-lint-issues.png similarity index 100% rename from docs/images/studio/lint_check.png rename to docs/images/studio/schema-update-with-no-lint-issues.png diff --git a/docs/images/studio/group-role-selector.png b/docs/images/studio/selecting-user-role-for-wundergraph.png similarity index 100% rename from docs/images/studio/group-role-selector.png rename to docs/images/studio/selecting-user-role-for-wundergraph.png diff --git a/docs/images/studio/group-rules.png b/docs/images/studio/setting-viewer-access-rules.png similarity index 100% rename from docs/images/studio/group-rules.png rename to docs/images/studio/setting-viewer-access-rules.png diff --git a/docs/images/studio/image-35.png b/docs/images/studio/settings-option-in-operations-section.png similarity index 100% rename from docs/images/studio/image-35.png rename to docs/images/studio/settings-option-in-operations-section.png diff --git a/docs/images/studio/image-43.png b/docs/images/studio/slack-access-request-for-wundergraph-cosmo.png similarity index 100% rename from docs/images/studio/image-43.png rename to docs/images/studio/slack-access-request-for-wundergraph-cosmo.png diff --git a/docs/images/studio/image-44.png b/docs/images/studio/slack-integration-for-schema-updates.png similarity index 100% rename from docs/images/studio/image-44.png rename to docs/images/studio/slack-integration-for-schema-updates.png diff --git a/docs/images/studio/check_information.png b/docs/images/studio/successful-schema-update-with-one-addition.png similarity index 100% rename from docs/images/studio/check_information.png rename to docs/images/studio/successful-schema-update-with-one-addition.png diff --git a/docs/images/studio/webhooks.png b/docs/images/studio/webhook-configuration-page.png similarity index 100% rename from docs/images/studio/webhooks.png rename to docs/images/studio/webhook-configuration-page.png diff --git a/docs/images/studio/audit-logs.png b/docs/images/studio/wundergraph-dashboard-overview.png similarity index 100% rename from docs/images/studio/audit-logs.png rename to docs/images/studio/wundergraph-dashboard-overview.png diff --git a/docs/images/studio/group-example1.png b/docs/images/studio/wundergraph-rule-without-description.png similarity index 100% rename from docs/images/studio/group-example1.png rename to docs/images/studio/wundergraph-rule-without-description.png diff --git a/docs/studio/alerts-and-notifications/slack-integration.mdx b/docs/studio/alerts-and-notifications/slack-integration.mdx index cd94df37..ae1d2340 100644 --- a/docs/studio/alerts-and-notifications/slack-integration.mdx +++ b/docs/studio/alerts-and-notifications/slack-integration.mdx @@ -10,18 +10,30 @@ icon: slack - + Create Slack integration in Integrations section of Cosmo Docs - - - + + WunderGraph Cosmo requesting access to Slack workspace with permission options + - - - + + Create Slack integration for federated graph schema update events + diff --git a/docs/studio/alerts-and-notifications/webhooks.mdx b/docs/studio/alerts-and-notifications/webhooks.mdx index b835095b..f9269701 100644 --- a/docs/studio/alerts-and-notifications/webhooks.mdx +++ b/docs/studio/alerts-and-notifications/webhooks.mdx @@ -77,12 +77,20 @@ const isVerified = verifySignature(JSON.stringify(req.body), req.headers['x-cosm - + Cosmo Studio configuration page for creating new organization webhooks. - + Create webhook dialog showing endpoint input, secret key, and schema update event selection. diff --git a/docs/studio/api-keys.mdx b/docs/studio/api-keys.mdx index fbf46aa9..ad705210 100644 --- a/docs/studio/api-keys.mdx +++ b/docs/studio/api-keys.mdx @@ -7,7 +7,11 @@ sidebarTitle: Overview The API keys are used to authorize the user to perform actions using [wgc](/cli/intro) (Wundergraph Cosmo CLI Command). On the overview, we display all keys across the organization. Only members of role Admin and Developer have the ability to create new keys. - + Cosmo Studio API keys management page showing an organization API key list with options to create new keys. ### How to create an API Token @@ -17,7 +21,11 @@ The API keys are used to authorize the user to perform actions using [wgc](/cli/ * Give the API key a name, select the expiry, the group and then click on "Generate API key". - + Create API key dialog with fields for name, expiry, and group selection. * Once the API key is generated, it will be displayed for the user to copy it. @@ -27,5 +35,9 @@ The API keys are used to authorize the user to perform actions using [wgc](/cli/ - + API key generated prompt showing a one-time view of the new key with copy and confirmation options. diff --git a/docs/studio/api-keys/api-key-permissions.mdx b/docs/studio/api-keys/api-key-permissions.mdx index 20735e9e..01e59ad0 100644 --- a/docs/studio/api-keys/api-key-permissions.mdx +++ b/docs/studio/api-keys/api-key-permissions.mdx @@ -11,7 +11,11 @@ The configurable permissions provided are:- 1. System for Cross-domain Identity Management (SCIM) - + Cosmo Studio Create API Key dialog showing fields for name, expiry, group, and a permissions section for SCIM. diff --git a/docs/studio/audit-log.mdx b/docs/studio/audit-log.mdx index 991bb1cb..cce7c0c7 100644 --- a/docs/studio/audit-log.mdx +++ b/docs/studio/audit-log.mdx @@ -9,5 +9,9 @@ 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. - + Cosmo Studio Audit Log showing user actions, namespaces, and timestamps for updates and creations. diff --git a/docs/studio/changelog.mdx b/docs/studio/changelog.mdx index b5828531..c8e311fd 100644 --- a/docs/studio/changelog.mdx +++ b/docs/studio/changelog.mdx @@ -6,8 +6,12 @@ icon: file-plus-minus The schema changes are listed in a chronological order, with the most recent changes appearing at the top. Each entry provides specific details about what was added or removed from the schema. This includes changes to types, fields, directives, and any other elements that make up your federated graph's schema. - - + + WunderGraph Docs showing recent Composition updates for Mutation and Subscription diff --git a/docs/studio/cluster-management.mdx b/docs/studio/cluster-management.mdx index f9e49c43..2cbaf14e 100644 --- a/docs/studio/cluster-management.mdx +++ b/docs/studio/cluster-management.mdx @@ -13,7 +13,11 @@ As part of our OpenTelemetry instrumentation, the router sends periodically data ## Routers - + Router cluster view showing 3 routers, memory usage, and cluster details The list displays all running router instances. Upon closer inspection, you can verify the currently deployed graph composition and vital metrics such as CPU and memory utilization. Here is a summary of all provided information: @@ -36,8 +40,13 @@ The list displays all running router instances. Upon closer inspection, you can If your router fails to push uptime metrics for any reason, the instance will disappear. As long as one metric sample reaches us within 45 seconds, we assume the router is operational. + - + Router details view showing uptime, memory, and CPU usage in Cosmo Docs If you click on a router instance, a summary displaying all the metrics available for your router instance will be shown. We will reserve this space to add additional metrics and diagrams in the future. If you have any ideas or requirements, please don't hesitate to make a [feature request](https://github.com/wundergraph/cosmo/issues/new?assignees=\&labels=enhancement%2Cneeds+triage\&projects=\&template=feature_request.yaml). diff --git a/docs/studio/compositions.mdx b/docs/studio/compositions.mdx index c1393ec4..972760f7 100644 --- a/docs/studio/compositions.mdx +++ b/docs/studio/compositions.mdx @@ -5,7 +5,11 @@ icon: books --- - + Cosmo Docs compositions list with green Composes status icons The highlights of the compositions page are as follows: @@ -19,9 +23,17 @@ The highlights of the compositions page are as follows: * Understand what version is currently available to the router. - + Composed schema with no changes and trigger from suvj@wundergraph.com in Cosmo Docs
- + Cosmo Docs composition error caused by missing schema field diff --git a/docs/studio/graph-pruning.mdx b/docs/studio/graph-pruning.mdx index dd6ed946..7eb05771 100644 --- a/docs/studio/graph-pruning.mdx +++ b/docs/studio/graph-pruning.mdx @@ -4,8 +4,12 @@ description: "**Graph Pruning Linter** helps manage the cleanliness and efficien icon: "broom-wide" --- - - ![Graph Pruning Pn](/docs/images/studio/graph_pruning.png) + + Cosmo Studio Graph Pruning Linter interface showing rules for unused, deprecated, and deleted fields with severity and period settings. ## Rules diff --git a/docs/studio/groups.mdx b/docs/studio/groups.mdx index c4a234cc..c87fdd66 100644 --- a/docs/studio/groups.mdx +++ b/docs/studio/groups.mdx @@ -6,15 +6,19 @@ sidebarTitle: Overview --- - To create, modify or delete groups, you need have RBAC enabled for your organization. This feature is available starting on the Scale plan. + To create, modify, or delete groups, you need to have RBAC enabled for your organization. This feature is available starting on the Scale plan. -Groups allow you to manage teams, separate people access for specific resources and much more without managing them manually. Including the benefits of SCIM. +Groups let you manage team access to specific resources without manual setup, and include the benefits of SCIM integration. Groups can be linked to both your organization members and your [API Keys](/studio/api-keys), enabling flexible and centralized access management. - + Cosmo Studio Groups page showing admin, developer, and viewer roles with member counts. ### How to create a group @@ -23,7 +27,11 @@ Groups can be linked to both your organization members and your [API Keys](/stud * Give the group a name, an optional description and then click on **Create group**. - + Create group dialog with name, description, and create button. Once the group has been created, the group modification screen will show up. Here you can configure the [group rules](/studio/groups/group-rules). @@ -46,12 +54,16 @@ To learn more about managing group rules refer to the [group rules](/studio/grou To delete an existing group, click on the three dots to the right of the groups table and click **Delete**. From there, one of two scenarios may occur. -**Scenario 1**: The group have not been assigned to any member, API key and/or OIDC mapper. +**Scenario 1**: The group has not been assigned to any member, API key and/or OIDC mapper. This is the simplest scenario, as you'll only need to fill the confirmation input and press the **Delete group** button. - + Confirmation dialog for deleting a group with password entry. **Scenario 2**: The group is being used by a member, API key and/or OIDC mapper. @@ -59,5 +71,9 @@ This is the simplest scenario, as you'll only need to fill the confirmation inpu For this scenario, you'll be shown what is using the group and you'll need to select a group to move the objects using the group to. After that, you'll just have to fill the confirmation and press the **Delete group** button. - - + Confirmation dialog for deleting a group that requires selecting a new group. One member has been assigned to this group. One API key has been assigned to this group. + \ No newline at end of file diff --git a/docs/studio/groups/group-rules.mdx b/docs/studio/groups/group-rules.mdx index 1cc70723..b01a63e9 100644 --- a/docs/studio/groups/group-rules.mdx +++ b/docs/studio/groups/group-rules.mdx @@ -7,7 +7,11 @@ icon: "database" A **group rule** defines the roles and associated resources that determine what group members and API keys can access, as well as the level of permissions granted. - + Cosmo Studio group configuration page showing viewer rules granting access to multiple resources. When a group rule doesn't have any explicit resources, the group will always have access to all resources within the organization. @@ -23,7 +27,11 @@ In the same way, if a rule is limited to a single resource and that resource is You can assign multiple roles to a group using the `Add rule` button. If no group rules are configured, group members will not have access to any resources. - + Cosmo Studio role selector for a group showing organization roles like Admin, Developer, and API Key Manager. Each role type can only be added once per group. For example, you can assign the `Organization Admin` and `Organization Viewer` roles in the same group, but you cannot assign the same role type more than once. You could also add a `Graph Admin` role to that group, as long as each role type appears only once. @@ -31,7 +39,11 @@ Each role type can only be added once per group. For example, you can assign the The order in which roles are assigned does not affect how access checks are performed. For example, given the following group: - + Cosmo Studio group rule editor showing roles for wundergraph without a description or namespace assigned. The members for this group will have **Admin** access to the `default` namespace and **Viewer** to the `test` and any other namespace that may exist in the organization. @@ -41,7 +53,11 @@ If the namespace `default` is deleted, the **Admin** role is no longer scoped an With this in mind, members of the following example will have **Organization Admin** access to all resources. - + Cosmo Studio settings page showing role permissions for Admin, Developer, and API Key Manager roles. ### Organization Roles @@ -75,7 +91,11 @@ Graph resources can be assigned in one of two ways: If no graphs are explicitly assigned, the group will have access to all graphs in the organization. Groups with the **Admin** role will also be able to create new graphs. - + Cosmo Studio graph resource selector showing default and test namespaces with full access permissions. ### Subgraph Roles @@ -95,7 +115,11 @@ If no subgraph resources are assigned, the group will have access to all subgrap ## Resources - + Cosmo Studio rule configuration screen for test and admin namespaces showing one selected rule. Resources represent entities in your organization, including but not limited to: diff --git a/docs/studio/invitations.mdx b/docs/studio/invitations.mdx index 63fa3939..754d90b4 100644 --- a/docs/studio/invitations.mdx +++ b/docs/studio/invitations.mdx @@ -11,6 +11,10 @@ If you're not currently a user on Cosmo, upon receiving an invitation, you'll ge If you're already a user on Cosmo and receive an invitation, you'll get an email that guides you to the invitations page. Once there, you'll have the option to either accept or decline the invitation. - + Invitation to join organization with Accept or Decline options in Cosmo Docs diff --git a/docs/studio/migrate-from-apollo.mdx b/docs/studio/migrate-from-apollo.mdx index 334861fa..5ab87cec 100644 --- a/docs/studio/migrate-from-apollo.mdx +++ b/docs/studio/migrate-from-apollo.mdx @@ -7,7 +7,11 @@ icon: "swap-arrows" If you are a user of Apollo GraphOS with configured graphs, then you can migrate to WunderGraph Cosmo with a click of a button. - + WunderGraph Docs showing no graphs found with option to migrate from Apollo Once you have clicked on "Migrate from Apollo", a modal will appear. This modal will request your "Graph API Key" for the federated graph you wish to migrate. @@ -20,36 +24,59 @@ Once you have clicked on "Migrate from Apollo", a modal will appear. This modal - - + Cosmo Docs cloud supergraph section with main variant and graph search bar - + Cosmo Docs user interface showing settings option in operations section - + Cosmo Docs settings page for build variant with This Graph tab highlighted
- + General settings section showing API Keys highlighted as current selection - + Create API key for Spotify Demo Graph to uniquely identify data
- + Cosmo Docs migration modal showing Graph API Key and Variant Name fields diff --git a/docs/studio/overrides.mdx b/docs/studio/overrides.mdx index 26b5399a..de36485f 100644 --- a/docs/studio/overrides.mdx +++ b/docs/studio/overrides.mdx @@ -13,23 +13,38 @@ Whenever you run a check against a subgraph we detect breaking changes that affe - + Failed schema update with two changes, one affecting Query.employees field You can also toggle overrides for all changes in the click of a button. Setting `Ignore All` will consider all current and new breaking changes as safe for the operation. - + Two field type changes: Query.employees and Employee.role updated to new types - ## Viewing all overrides You can view all overrides in a single place. From here you can open the configuration to fine tune existing overrides or go to metrics/traces to check current usage. - + Two operations with overrides showing timestamps and statuses in Cosmo Docs
- + Override configuration for employees with hash copy and view options in Cosmo Docs diff --git a/docs/studio/playground.mdx b/docs/studio/playground.mdx index 4f3f25d8..e18f647b 100644 --- a/docs/studio/playground.mdx +++ b/docs/studio/playground.mdx @@ -6,15 +6,23 @@ sidebarTitle: Overview --- - + GraphiQL playground employee query with data visualization in WunderGraph -The playground is enchanced with visual representations of the query execution plan along with details like timings, inputs outputs for each subgraph and much more. The `X-WG-TRACE` header must be included to enable the visualization. It is available in 2 modes tree view and waterfall view. +The playground is enhanced with visual representations of the query execution plan along with details like timings, inputs, and outputs for each subgraph and much more. The `X-WG-TRACE` header must be included to enable the visualization. It is available in 2 modes tree view and waterfall view. For more information about Advanced Request Tracing (ART) click [here](/router/advanced-request-tracing-art) - + GraphiQL playground parallel queries for employees and products with timing visualization diff --git a/docs/studio/playground/custom-scripts.mdx b/docs/studio/playground/custom-scripts.mdx index a0e10d64..06177fb4 100644 --- a/docs/studio/playground/custom-scripts.mdx +++ b/docs/studio/playground/custom-scripts.mdx @@ -21,9 +21,14 @@ Create one or more scripts to handle various stages of the request lifecycle for Below depicts the execution lifecycle with operation and scripts configured - + Workflow showing execution of operations with pre-flight, pre-operation, and post-operation scripts + ## Creating and running scripts You can create multiple scripts of each type and select the appropriate one as needed. All created scripts are accessible at the account level; however, scripts selected for use are scoped specifically to your device or browser. @@ -77,7 +82,11 @@ Environment variables are local key-value pairs stored as JSON within your brows In the playground's **Headers** tab, you can reference an environment variable by using the syntax `{{key}}`. The playground will replace `{{key}}` with the corresponding value from the environment variables before executing your operation. - + Cosmo Docs variable setup with Authorization token in Variables section ## Examples diff --git a/docs/studio/policies.mdx b/docs/studio/policies.mdx index 8c64bb0c..b2892bd2 100644 --- a/docs/studio/policies.mdx +++ b/docs/studio/policies.mdx @@ -9,7 +9,11 @@ sidebarTitle: Overview Schema linting capabilities enable developers to uphold GraphQL schema quality and adhere to established conventions effortlessly. By integrating schema linting into your development workflow, you can ensure consistency, enhance code maintainability, and catch issues early in the development process. - + Lint Policy section showing Linter enabled and Apply button in Cosmo Docs ### How to configure schema lintings @@ -21,7 +25,11 @@ Navigate to the Lint Policy page on Cosmo. Select the namespace. - + Lint Policy section showing Default tab selected and Apply button available @@ -48,7 +56,11 @@ To configure how far back in date the operation checks look at traffic follow th - Select the desired timeframe from the **Checks days to consider** dropdown - + Schema Checks section showing dropdown with selectable check days in Cosmo Docs diff --git a/docs/studio/rbac.mdx b/docs/studio/rbac.mdx index ffca8904..06028659 100644 --- a/docs/studio/rbac.mdx +++ b/docs/studio/rbac.mdx @@ -15,7 +15,11 @@ You have the option to modify the roles of all users not integrated with Single ## Enable Access-Control - + RBAC settings page showing enable or disable toggle option in organization settings Go to your organization settings page and navigate to "Resource Based Access Control (RBAC)". After you have enabled it, you'll be able to manage [groups](/studio/groups). diff --git a/docs/studio/schema-checks.mdx b/docs/studio/schema-checks.mdx index b5fc9199..c3b9a1c4 100644 --- a/docs/studio/schema-checks.mdx +++ b/docs/studio/schema-checks.mdx @@ -46,7 +46,11 @@ Have a glance at your check. Understand why the check succeeded or failed, and w - + Cosmo Studio schema check view showing a successful update with one field addition and no deletions. #### Manual overrides @@ -74,7 +78,11 @@ You can override certain changes as safe for future checks. Learn more by clicki - + Cosmo Studio schema check showing a failed operation update with multiple changes and lint issues. ### Operation Details @@ -86,6 +94,10 @@ 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. - + Cosmo Studio schema check result showing no lint issues and a successful update. diff --git a/docs/studio/schema-explorer.mdx b/docs/studio/schema-explorer.mdx index 11419399..4a1b308c 100644 --- a/docs/studio/schema-explorer.mdx +++ b/docs/studio/schema-explorer.mdx @@ -4,8 +4,12 @@ icon: file-lines description: "An interactive explorer to navigate though your federated graph schema. It has built in search and usage tracking for every type in your schema" --- - - + + Cosmo Studio Schema Explorer displaying the Query root with fields like findEmployees, products, and teammates. @@ -26,7 +30,11 @@ Check the docs here to see how the usage for each type looks like Open the search modal by hitting `Cmd/Ctrl + K` on your keyboard. Jump to any type you like to view. - + Cosmo Studio search interface showing objects like Identifiable, City, Mood, and Time. ## Deprecated Fields @@ -34,7 +42,11 @@ Open the search modal by hitting `Cmd/Ctrl + K` on your keyboard. Jump to any ty You can view all deprecated fields in your schema in one place along with their usage. This helps to determine if it is safe to remove the field/argument. - + Cosmo Studio schema view showing deprecated fields teammates query and middlename string marked as no longer supported. ## Authenticated Types and Fields @@ -46,17 +58,29 @@ You can easily view all types and fields that use the `@authenticated` and/or `@ - + Cosmo Studio view listing authenticated schema fields and types in the router schema. When a type or field is annotated with the `@requiresScopes` directive, the list of required scopes can be accessed by clicking the `View scopes` button in the type header. - - + + Cosmo Studio field details for FactContent tyspe with read:entity access scope. Or beside the type/field name in the table. - - + + Cosmo Studio Mutation view with addFact field requiring authentication scopes write:fact or write:all.