Launch GraphOS Studio

Schema proposal configurations

Configure default reviewers, approval requirements, and more

This feature is only available with a

You can test it out by signing up for a free
Enterprise trial

can configure these aspects of :

Which roles can create and edit proposals
Default reviewers
Which team members are default reviewers and whether default reviewer approval is required
Required approvals
The minimum number of approvals needed for a proposal to achieve
Approved status
Description template
An editable description that prepopulates every new proposal created for the graph
Schema checks
Whether and how
schema checks
incorporate proposals
Whether to send email notifications for proposal activity

Configurations are available on a 's Settings page in



configurations are on a per-graph basisnot per-organization or per-proposal. This includes

, which are sent on a per-graph, per-teammate basis.

Configure permissions and approvals

Permissions for proposal actions are set at the graph level with the following defaults:

Proposal ActionOrg AdminGraph AdminContributorObserver / DocumenterConsumer
Change proposal status
Create proposals
Edit proposals
Add reviewers
View proposals
Make comments
Approve proposals

can configure which roles can create and edit proposals. Permissions for other proposal actions aren't configurable. Refer to the
configuration reference table
below for default and valid values.

Configuration reference

Default value
Valid values


  • Create: Observers

  • Edit: Admins

The minimum

required to create or edit proposals.

Observers is the least restrictive setting and Admins the most restrictive.

The Observers default for creating proposals means all organization members except Consumers and Billing Managers can create proposals.

The Admins default for editing proposals means only org and graph admins can edit proposals they didn't create.

Proposal authors can always edit their own proposals regardless of their role.

Valid values:

Admins, Contributors, Documentors, or Observers

Default reviewers

Default: None

The team members automatically marked as reviewers once a proposal's status becomes


Valid values:

Any member of your organization can be a default reviewer except for


Required approvals

Default: 3

The minimum number of approvals a proposal must receive for its status to become


Valid values:

1 - 6


Changing the number of required approvals may update the status of existing proposals that aren't

. This depends on whether the current number of approvals meets the new number of required approvals. For example, a previously Approved proposal may become Open for feedback if it no longer meets the number of required approvals.

Require default reviewer approval

By default, any team member's approval can contribute to the

. Once you've added
default reviewers
, you can require at least one approval to come from a default reviewer by selecting Require at least one default reviewer for all proposals on this graph.

Configure description template

When you

, you can optionally include a description that appears on the proposal's Overview tab. Proposal descriptions support Markdown.

Setting a graph's Description template prepopulates the description for every new proposal any team member creates for the graph. Templates can help ensure that all proposal descriptions follow a particular format.

Creating a description template for schema proposals in GraphOS Studio

You can edit a prepopulated description during proposal creation and throughout the proposal process.

Configure schema checks

You can configure

to include a Proposals task that verifies whether the changes a check is running on have matching and approved schema proposals.

Proposal check settings in GraphOS Studio

By default, the severity of this task is Off. You can select from the following severity levels:

  • (Default) With the severity set to Off, the proposals task isn't part of the checks that changes must pass for the schema check to succeed.
  • Setting the severity to Error means the proposals task fails when the change being checked isn't included in approved proposals.
  • Setting the severity to Warning means the proposals tasks can still pass even when the change being checked isn't included in approved proposals. However, warnings appear in the check run.

Integrating the Proposals task into strengthens schema governance when

. See the
proposals implementation
article for more information on how to use schema checks as part of your proposal workflow.


By default, all team members receive email notifications for the following:

  • If you're selected as a reviewer on a proposal, whether because you are a
    default reviewer
    , or you've been manually selected
  • Whenever you are @mentioned in a comment

Additionally, the following roles receive email notifications for the following proposal actions:

CommentsSaved RevisionsStatus ChangesReviews
Proposal author✔️✔️✔️✔️
Commenter✔️ **
Proposal editor


**Commenters only receive notifications for new comments on threads that they've commented on. They don't receive notifications for all new comments on a proposal.

Notifications are cumulative. For example, if you comment on a particular thread and review a proposal, you get notifications for both new comments on the thread and saved revisions.

Turn off notifications

Notifications are enabled by default. To turn off your notifications, go to the 's overview page and click the bell icon.

Turning off schema proposal notifications in GraphOS Studio

To re-enable them, click the same bell icon.


Notifications are enabled on a per-team member, per-graph basis.

Propose changes
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy