APIs
Issue
Objects
Issue
Field | Type | Description |
---|---|---|
id | ID! | The ID of the object. |
shortcode | String! | |
title | String! | |
analyzer | Analyzer! | |
autofixAvailable | Boolean! | |
isRecommended | Boolean! | |
category | IssueCategory! | |
severity | IssueSeverity! | |
shortDescription | String! | |
tags | [String]! |
IssueCategorySetting
Configuration for an IssueCategory
in a Repository
.
Field | Type | Description |
---|---|---|
category | IssueCategory! | An `IssueCategory`. |
isReported | Boolean! | Whether issues of given category are enabled for reporting in the repository. |
canFailCheck | Boolean! | Whether to fail checks when occurrence(s) of issues of given category are found in the repository. |
IssuePrioritySetting
Configuration for an IssuePriorityType
in a Repository
.
Field | Type | Description |
---|---|---|
priorityType | IssuePriorityType! | An `IssueCategory`. |
isReported | Boolean! | Whether issues of given priority are enabled for reporting in the repository. |
canFailCheck | Boolean! | Whether to fail checks when occurrence(s) of issues of given priority are found in the repository. |
IgnoreRule
An IgnoreRule
defines the condition on which to suppress an Issue
’s Occurrence
s in a Repository
.
Field | Type | Description |
---|---|---|
level | IgnoreRuleLevel! | Ignore level of the rule. |
type | IgnoreRuleType! | Ignore type of the rule. |
issue | Issue! | The `Issue` to ignore in the rule. |
filePath | String! | File path if rule is on FILE level. |
globPattern | String! | Glob pattern if rule is of PATTERN type. |
IgnoreRuleConnection
Field | Type | Description |
---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [IgnoreRuleEdge]! | Contains the nodes in this connection. |
totalCount | Int |
IgnoreRuleEdge
A Relay edge containing a IgnoreRule
and its cursor.
Field | Type | Description |
---|---|---|
node | IgnoreRule | The item at the end of the edge. |
cursor | String! | A cursor for use in pagination. |
Was this page helpful?