How can I enable the Contracts feature?

Have more questions? Submit a request

Contracts are currently available as a public preview feature for Enterprise plans only. A feature in public preview is enabled for Apollo users by default. However, it might still contain bugs or undergo iteration. Contracts currently only support federated graphs.

Apollo Studio contracts enable you to deliver different subsets of your graph to different consumers. Each contract filters specific portions of your graph's API schema:

contracts.png

You usually create a contract to support a contract gateway or contract documentation (or both). You can deploy a managed instance of your gateway that uses a contract schema. In Studio, each contract variant has its own README, schema reference, and Explorer.

contract_gateway.png

To configure contracts for your federated graph, see the setup.

  1. Update your gateway and subgraphs
  2. Enable variant support for @tag
  3. Add @tags
  4. Register updated subgraph schemas
  5. Create a contract
  6. Use your new contract variant

You can find more information on contracts here.

Articles in this section

Was this article helpful?
0 out of 0 found this helpful
Share

Comments

0 comments

Please sign in to leave a comment.