Request Payload Structure - WunderGraph

Subgraph Check Extension Payload

Field Type Description
actorId string The unique identifier of the actor that triggered the check.
checkId string The unique identifier of the check.
labels LabelInfo[] Contains the labels used to trigger the check. This field will not be present when subgraphs is defined.
organization OrganizationContext Information about the organization that triggered the check.
namespace NamespaceContext Information about the associated namespace.
vcsContext 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 AffectedGraphInfo[] A list of all graphs affected by the check.
subgraphs SubgraphContext[] A list of all subgraphs that triggered the check. This field is only included when the check is for an existing subgraph.
url string or undefined The URL from which the bulk data file can be downloaded.

LabelInfo

Provides information about the labels used to trigger the check.

Field Type Description
key string The key of the label.
name string The name of the label.

OrganizationContext

Provides information about the organization that triggered the check.

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

NamespaceContext

Provides information about the associated namespace.

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

VCSContext

Provides details about the Version Control System (VCS) that triggered the check. This field is only included when the check is initiated from a VCS.

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

AffectedGraphInfo

Provides information about the graphs affected by the check.

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

SubgraphContext

Provides information about the subgraphs that triggered the check. This field is only included when the check is for an existing subgraph.

Field Type Description
id string The unique identifier of the subgraph.
labels LabelInfo[] The list of labels the subgraph is associated with.
name string The name of the subgraph.
isDeleted boolean Indicates whether the check was triggered by a deleted subgraph.