Skip to content
This repository was archived by the owner on Apr 14, 2023. It is now read-only.

Commit b738a39

Browse files
committed
add subgraph doc infor for sandbox diffs & checks with screenshots
1 parent 56dd454 commit b738a39

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

studio-docs/source/explorer/sandbox.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ From [Sandbox](https://studio.apollographql.com/sandbox/), open the **Schema Dif
5858

5959
<img class="screenshot" src="../img/sandbox-diff.jpg" alt="Schema diff in Sandbox" />
6060

61+
> If you are introspecting a subgraph, you will see the subgraph sdl, _not_ the federation-generated subgraph schema. You can see the federation-generated subgraph schema on the SDL page in Sandbox.
62+
6163
In addition to viewing the diff on this page, you can click **Run a Check** in the upper-right to run [schema checks](#schema-checks) against the currently selected variant.
6264

6365
### Schema checks
@@ -76,6 +78,17 @@ Select any accessible organization, graph, and variant to check against and clic
7678

7779
To view the result's _full_ details in Studio, click **Go to details**.
7880

81+
#### Subgraph checks
82+
83+
You can run subgraph checks on federated graphs. If you are introspecting a subgraph you will see a subgraph dropdown where you can select the subgraph that you want your local subgraph to replace.
84+
85+
<img class="screenshot" src="../img/sandbox-subgraph-check-prompt.jpg" alt="Sandbox subgraph check prompt" width="400" />
86+
87+
When you click **Run a check**, composition validation will be run. If composition is successful, you will see both the composition result and the results of the operation check, otherwise you will just see the composition failure.
88+
89+
<img class="screenshot" src="../img/sandbox-subgraph-check-result.jpg" alt="Sandbox subgraph check result" width="400" />
90+
91+
7992
## Offline Sandbox
8093

8194
You can use Sandbox _without_ an internet connection if you're querying a graph running on `localhost`. To do so, [open Sandbox in your browser](https://studio.apollographql.com/sandbox/) at least once while connected to the internet. You can then use that browser to open Sandbox while offline.
66.3 KB
Loading
158 KB
Loading

0 commit comments

Comments
 (0)