Skip to content

Commit 6c7dc86

Browse files
mintlify[bot]akshaygarg576
mintlify[bot]
and
akshaygarg576
authored
feat(docs): Add docs for Share Playground session (#69)
* Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * fix: revert unnecessary changes * fix: revert unnecessary changes * Fix: typo --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Akshay Garg <[email protected]>
1 parent 536f4f9 commit 6c7dc86

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

‎docs/studio/playground/shared-playground-state.mdx

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: "Sharing Playground Sessions"
3+
description: "You can now share your Cosmo Playground session with others using a single URL. This feature enables easier collaboration and debugging across your team — no need to copy and paste queries or configurations manually."
4+
---
5+
6+
## What's Included in the Share Link?
7+
8+
When creating a shareable link, you can **choose which parts** of your Playground session to include.
9+
10+
Here's what you can share:
11+
12+
| Option | Shareable? | Required | Notes |
13+
| :---------------- | :--------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14+
| GraphQL Operation | Always | Yes | Always included by default. Cannot be deselected. |
15+
| Variables | If present | No | Included only when content is available and the option is selected. If no content is present, the option appears disabled under "No content available to share. Add content to enable sharing these options." To enable it, add relevant content in the Playground. |
16+
| Headers | If present | No | Included only when content is available and the option is selected. If no content is present, the option appears disabled under "No content available to share. Add content to enable sharing these options." To enable it, add relevant content in the Playground. |
17+
18+
<Note>
19+
The GraphQL Operation could be a query, mutation or subscription
20+
</Note>
21+
22+
## How to Share a Session?
23+
24+
<iframe src="https://www.loom.com/embed/76b9d1e51ecd4481a334daaaba145f0c?sid=e8104713-5cff-466c-b898-5c4ec1d892f5" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen width="100%" height="400" ></iframe>
25+
26+
<Steps>
27+
<Step title="Open the Playground and compose your GraphQL operation">
28+
29+
</Step>
30+
<Step title="Add any variables or headers you’d like to include">
31+
32+
</Step>
33+
<Step title="Click Share icon with the tooltip “Share Playground State” in the toolbar">
34+
35+
</Step>
36+
<Step title="A modal will appear with options to choose:">
37+
- Available options will appear in top section
38+
- Unavailable options (if no content available) will appear in the bottom section
39+
</Step>
40+
<Step title="Select the available options you want to include in the shared link">
41+
42+
</Step>
43+
<Step title='Click "Copy link" to generate and copy the shareable URL'>
44+
45+
</Step>
46+
</Steps>
47+
48+
## Opening a Shared Link
49+
50+
Recipients of a shared link will see the shared Playground session in a new tab with:
51+
52+
- The **operation** restored exactly as composed
53+
- Optional **variables** and **headers** if they were included
54+
55+
## Not Included in Shared Links
56+
57+
The following are never included in the shared link:
58+
59+
- Pre-flight scripts
60+
- Pre-operation scripts
61+
- Post-operation scripts
62+
63+
## Security Considerations
64+
65+
If you choose to include headers, they are compressed and encoded as part of the generated URL. While the data is not human-readable, it is accessible to anyone who has the link. For your safety, avoid including sensitive data such as API tokens or credentials in shared headers.
66+
67+
## Use Cases
68+
69+
- Share reproducible bugs with your team
70+
- Collaborate on queries with full context
71+
- Link to example queries in internal docs
72+
- Speed up onboarding of new developers with pre-filled queries

0 commit comments

Comments
 (0)