December 14, 2021

How to run diffs and operation checks in Apollo Sandbox

Parul Schroff
Product Management at Apollo
AnnouncementPlatform

When you’re making changes to your GraphQL schema, you probably make those changes locally before you publish them to a graph registry like Apollo Studio.

We created Apollo Sandbox so that you can use the best GraphQL IDE when working locally, but wouldn’t it be great if you could easily see the diff between your local schema and the existing schema in Studio?

And even better – what if you could run checks to see if your local changes could break operations against the production graph? Well, now you can do both right from Apollo Sandbox! Let’s take a look at how:

Validate your schema changes before publishing them to Studio!

Want to feel confident about your schema changes before publishing them to Studio? Simply head over to Apollo Sandbox and connect to your localhost via the Sandbox endpoint field (or you can connect to a remote endpoint if you like).

Compare your schema to a registered graph in Studio

Go to the Diffs tab and sign into Studio to select a registered graph to diff your local schema against and explore your diff! See a summary of how many types and fields have been added or removed and select to view it as a line wrap if needed.

Make sure there are no breaking changes

Try running an operation check on your local schema by either:

  1. Using the Run check button from the loaded diff view or
  2. Going to the Checks tab and selecting a registered graph to check against

Once you see a summary of results, you can also view more details by navigating to the main checks page on Studio.

Remember, you can always move back and forth between Sandbox and the full Studio experience by clicking the box icon in the top righthand corner in the navigation bar.

⚠️ Note: For checks to work, you’ll need to have a Studio account with a registered graph that is receiving traffic and access to Checks, which is available on Team and Enterprise plans only.

Try these new improvements out today!

Head over to Apollo Sandbox and compare your local changes with registered graphs and ensure there are no breaking changes! And as always, we love hearing from you, so if you have any feedback, please fill out this feedback form or drop a post on the Apollo Studio GitHub Community!

Written by

Parul Schroff

Stay in our orbit!

Become an Apollo insider and get first access to new features, best practices, and community events. Oh, and no junk mail. Ever.

Make this article better!

Was this post helpful? Have suggestions? Consider so we can improve it for future readers ✨.

Similar posts

January 12, 2022

Automatically Authenticate with Preflight Scripts in Apollo Studio Explorer

by Parul Schroff

Company