Response Payload Structure - WunderGraph
SubgraphCheckExtensionReply
| Field |
Type |
Description |
errors |
string[] or undefined |
An optional collection of errors caught by the check extension. When one or more errors are returned, the subgraph check extension reports the result as a failure. |
lintIssues |
Record<string, LintIssue[]> or undefined |
An optional map of the lint issues by subgraph name that will be appended to the ones reported by the internal lint check. If you only want to see issues reported by your service, disable the Lint Policies. |
LintIssue
| Field |
Type |
Description |
lintRuleType |
string |
A string representing the Lint rule. This can be anything that helps you identify the applied rule. |
severity |
LintSeverity |
The severity of the issue. |
message |
string |
A message providing context for the issue. |
issueLocation |
LintIssueLocation |
The location of the issue related to the schema. This helps highlight the issue on the check results screen. |
LintSeverity
| Field |
Value |
Description |
| Warning |
0 |
Represents a lint warning. |
| Error |
1 |
Represents a lint error. |
LintIssueLocation
| Field |
Type |
Description |
line |
number |
The line number of the lint issue. |
column |
number |
The column number of the lint issue. |
endLine |
number or undefined |
The end line number of the lint issue. |
endColumn |
number or undefined |
The end column number of the lint issue. |
TypeScript Definition
interface LintIssue {
lintRuleType: string;
severity: LintSeverity;
message: string;
issueLocation: LintIssueLocation;
}
interface LintIssueLocation {
line: number;
column: number;
endLine?: number;
endColumn?: number;
}
enum LintSeverity {
Warning = 0,
Error = 1
}
interface SubgraphCheckExtensionReply {
errors?: string[];
lintIssues?: Record<string, LintIssue[]>;
}