Structure of

Validate schema changes before deploying them to production on your own premises.

SubgraphCheckExtensionPayload

Field	Description
actorId	The unique identifier of the actor that triggered the check.
checkId	The unique identifier of the check.
organization	Information about the organization that triggered the check.
namespace	Information about the associated namespace.
vcsContext	Details about the Version Control System (VCS) that triggered the check. This field is only included when the check is initiated from a VCS.
affectedGraphs	A list of all graphs affected by the check.
subgraph	The subgraph that triggered the check. This field is only included when the check is for an existing subgraph.
url	The URL from which the file containing bulk data can be downloaded.

OrganizationContext

Field	Description
id	The unique identifier of the organization.
slug	The slug of the organization.

NamespaceContext

Field	Description
id	The unique identifier of the namespace.
name	The display name of the namespace.

VCSContext

Field	Description
author	The email address of the commit author.
commitSha	The SHA hash of the commit that triggered the check.
branch	The name of the branch associated with the commit.

AffectedGraphInfo

Field	Description
id	The unique identifier of the graph.
name	The name of the graph.

SubgraphContext

Field	Description
id	The unique identifier of the subgraph.
name	The name of the subgraph.
isDeleted	Indicates whether the check was triggered by a subgraph deletion.

TypeScript definition

interface OrganizationInfo {
  id: string;
  slug: string;
}

interface NamespaceInfo {
  id: string;
  name: string;
}

interface VCSContext {
  author: string;
  commitSha: string;
  branch: string;
}

interface AffectedGraphInfo {
  id: string;
  name: string;
  namespace: NamespaceInfo;
}

interface SubgraphInfo {
  id: string;
  name: string;
  isDeleted: boolean;
}

interface SubgraphCheckExtensionPayload {
  organization: OrganizationInfo;
  namespace: NamespaceInfo;
  vcsContext: VCSContext | undefined;
  affectedGraphs: AffectedGraphInfo[];
  url: string;
  subgraph: SubgraphInfo | undefined;
}