Docs
Launch GraphOS Studio

Operation collections in the Explorer

Save and share frequently used GraphQL operations


You can create operation collections in the , enabling you to save, organize, and share your organization's frequently used :

Explorer collections list

Each variant of a has its own set of collections. An operation collection can be either personal (visible only to you) or shared (visible to all organization members who can view the corresponding ).

Operation collections help you and your team:

  • Stop writing the same over and over
  • Organize common by how they're used and who uses them
  • Design, execute, and share all in a single interface
  • Onboard new team members

Creating a collection

To create an collection in the Explorer:

  1. Open Studio and navigate to the Explorer.

    Explorer collections list
  2. In the top left, select the / combination you want to create a collection for (for example, docs-example-graph/current in the screenshot above).

  3. Click the "bookmark" tab in the Explorer's left panel to open your collection settings (shown in the screenshot above).

  4. Click + Create collection at the top of either the Personal or the Shared section, depending on which type of collection you want to create.

    A dialog like the following appears:

    Create collection dialog
  5. Provide a name and optional description for your collection.

  6. If you're creating a shared collection, you can click Advanced permissions for this collection to specify whether non-admin members of the organization can modify your shared collection and its .

  7. Click Add.

That's it! Your newly created collection appears in its corresponding list.

Adding operations

To add to a collection:

  1. Define at least one in the Explorer's editor panel:

    Example query in the Explorer editor panel

    NOTE

    If you define multiple in a single editor, all those operations are saved together as a single entry in a collection.

  2. Click the "floppy disk" button (shown in the screenshot above) to open the save dialog:

    Dialog for saving operation to collection
  3. Provide a name for the collection entry, then use the dropdown menu to select a collection to add it to.

    NOTE

    If you don't see the collection you want, make sure you've selected the correct / combination in the Explorer.

  4. Click Save.

That's it! Your newly saved entry appears in its corresponding collection:

Saved operation shown in left panel

If you've saved the entry to a shared collection, it also appears for other authorized members of your organization.

💡 TIP

After you add multiple to a collection, you can drag and drop to reorder them within the collection.

Modifying collections and operations

NOTE

Non-admin organization members can't edit another team member's shared collection, unless that team member specifically configures the collection to allow this.

To edit a collection's details, click the ••• button next to its entry in the list and select Configure.

To edit an existing operation in a collection, click that to open it and make any necessary changes. Then click the "floppy disk" icon to save those changes.

Cloning collections and operations

It's often helpful to create a new collection or based on an existing one.

  • To clone an entire collection, click the ••• button next to its entry in the list and select Duplicate.
    • You can save the new collection to any of any you have access to, and you can make it personal or shared.
    • If you're using , you can also save the new collection as a Sandbox collection.
    • Cloning a collection creates a new collection with an identical set of . Modifying the new collection has no effect on the original.
  • To clone a single operation, open it in the editor panel and click the dropdown arrow next to the "floppy disk" icon. Then select Save As.
    • This enables you to save a copy of the to any collection for the current .

Sharing collections

Every shared collection is automatically visible in the Explorer for every organization member that has access to the corresponding .

You can also give authorized team members a link directly to a particular shared collection or . To do so, click the ••• button next to any shared collection or in the list and select the Copy link option.

NOTE

Team members must be signed in to Studio to view a linked collection or , unless it's a public collection.

Embedding in the README page

Each in Studio has a README page that you can customize to that . You can embed a variant's shared collections and in its README using shortcodes that are shown in the README editor.

Public collections

If you create a public variant of your , any shared collections for that are visible to everyone, not just members of your organization. Anonymous users can view and execute in a public collection, but they can't make any changes to the collection.

Sandbox collections

Apollo Sandbox is a special mode of that doesn't require an Apollo account. If you use Sandbox and do sign in with your Apollo account, you can save personal collections that are specific to Sandbox:

Operation collections in Apollo Sandbox

These Sandbox collections persist regardless of which endpoint you connect to.

While signed in to Sandbox, you can also access the collections for any and your account has access to.

NOTE

If you don't sign in to Sandbox, collections are not available.

Previous
Embedding
Next
Additional features
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company