从10月8日至10日加入我们,在纽约市了解最新关于GraphQL联邦和API平台工程的技巧、趋势和新闻。加入我们参加2024年在纽约市的GraphQL峰会
文档
免费开始

模式提案配置

配置默认审阅人、审批要求和更多


此功能仅适用于 GraphOS企业版计划.
您可以通过免费注册来试用 企业试用版.

组织和图管理员可以配置以下方案提案方面:

配置描述
权限哪些角色可以创建和编辑提案
默认审阅人哪些团队成员是默认审阅人以及是否需要默认审阅人审批
所需审批提案达到已批准状态所需的最少审批数
修订后需要重新审批在修订后是否需要重新审批
描述模板用于预先填充图创建的每个新提案的可编辑描述
模式检查模式和如何检查模式融入提案
通知是否发送提案活动的电子邮件通知

配置可在图形 “设置”页面 中找到,页面地址为 GraphOS Studio

注意

配置基于每张图——不是基于组织或基于建议。这包括:通知,这些通知基于每张图、每个人队友的基础。

配置权限和审批

建议操作的权限在图级别设置,以下是默认值:

建议操作组织管理员图形管理员贡献者观察者/文档者消费者
更改建议状态
创建建议
编辑建议
添加审查者
查看建议
发表评论
批准建议

组织和图形管理员可以配置哪些角色可以创建和编辑建议。其他建议操作的权限不可配置。请参考下方的 配置参考表,获取默认值和有效值。

配置参考

Configuration/
默认值
描述/
有效值
权限

默认值

  • 创建观察者

  • 编辑: Admins

创建或编辑建议所需的最小角色


Observers是最开放设置,Admins是最限制性的设置。

创建建议的Observers默认设置意味着除了消费者和账单经理之外的所有组织成员都可以创建建议。

编辑建议的Admins默认设置意味着只有组织和管理图形管理员可以编辑他们没有创建的建议。

建议作者可以始终编辑他们自己的建议,无论其角色如何。

有效值

AdminsContributorsDocumentorsObservers

默认审阅人

默认: None

一旦建议状态变为 公开反馈,则会自动标记团队成员为审查者。

有效值

您的组织中的任何成员都可以成为默认审查者,除非是账单经理

所需审批

默认: 3

提案需要获得的最少批准数,其状态才能成为已批准

有效值

1 - 6

注意

更改所需批准的数量可能会更新现有提案的状态,这些提案尚未关闭实施。这取决于当前批准的数量是否符合新的要求批准的数量。例如,一个之前被< strong>已批准的提案可能变为不再满足所需批准的数量,因此可能变为对反馈开放

需要默认审稿人批准

默认情况下,任何团队成员的批准都可以计入所需的最少批准数量。一旦您添加了默认审稿人,您可以通过勾选为此图上的所有提案至少需要一名默认审稿人进行批准来确保至少有一名默认审稿人的批准。

需要重新批准

默认情况下,如果提案在经过一次或多次批准后被修订,则批准状态保持不变。您可以将此设置为从修订提案中撤回批准。

在您的提案设置中,点击管理批准要求,并选择在新修订中撤消之前的批准。启用此设置后,会自动从之前批准的任何人重新请求审查。

配置描述模板

当您创建提案时,您可以选择性地使用描述,该描述会显示在提案的概览选项卡上。提案描述支持Markdown。

设置图'描述模板'将自动为团队任何成员为图创建的每个新提案填写描述。模板可以帮助确保所有提案描述都遵循特定格式。

Creating a description template for schema proposals in GraphOS Studio

您可以在提案创建过程中以及整个提案过程中编辑预先填充的描述。

配置架构检查

您可以配置架构检查以包括一个提案任务,该任务验证所进行的更改是否有匹配的已批准架构提案

Proposal check settings in GraphOS Studio

默认情况下,此任务的严重性设置为关闭。您可以从以下严重性级别中进行选择:

  • (默认)将严重性设置为关闭,意味着提议任务不是必须通过更改才能使架构检查成功的检查的一部分。
  • 将严重性设置为错误意味着当检查的更改未包含在批准的提案中时,提议任务会失败。
  • 将严重性设置为警告意味着即使在检查的更改未包含在批准的提案中时,提议任务也可以通过。但是,会在检查运行中出现警告。

将"整合提案"任务纳入可以增强在发布更改时架构的治理。有关如何将架构检查作为提案工作流程的一部分使用的更多信息,请参阅提案实施文章。

通知

默认情况下,所有团队成员都会收到以下电子邮件通知:

  • 如果您被选为提案的审阅员,无论是作为默认审阅员还是您被手动选中
  • 无论何时您在评论中被@提及

此外,以下角色会因以下提案操作收到电子邮件通知:

评论已保存的修订版状态更改评审
提案作者✔️✔️✔️✔️
评论者✔️ **
审阅员✔️
提案编辑者

注意

**只有评论者会收到他们已评论的线程中新评论的通知。他们不会收到对提案的所有新评论的通知。

通知是累积的。例如,如果您在一个特定的线程中发表评论并审阅提案,您将收到对该线程的新评论和已保存修订版的通知。

关闭通知

通知默认启用。要关闭您的通知,请转到架构提案的并点击铃铛图标。

Turning off schema proposal notifications in GraphOS Studio

要重新启用,请点击同一个铃铛图标。

注意

通知基于每个团队成员、每-图启用。

上一页
概览
下一页
提出更改
评价文章评分在GitHub上编辑Edit论坛Discord

©2024Apollo Graph Inc.,商业名称为Apollo GraphQL。

隐私政策

公司