Issue
Issue type definitions, categories, priorities, and ignore rules.
The Issue type represents a rule definition (e.g., PYL-E0712). To get issue occurrences in your code, query through repository { issues { ... } } or check { occurrences { ... } }.
| Field | Type | Description |
|---|
| id | ID! | The ID of the object. |
| shortcode | String! | Unique identifier for this issue (e.g., PYL-E0712). |
| title | String! | Title of the issue. |
| analyzer | Analyzer! | The analyzer that detects this issue. |
| autofixAvailable | Boolean! | Whether Autofix™ is available for this issue. |
| isRecommended | Boolean! | Whether this issue is recommended to be fixed first. |
| category | IssueCategory! | Category of the issue. |
| severity | IssueSeverity! | Severity of the issue. |
| shortDescription | String! | A short description of the issue. |
| description | String | A detailed description of the issue. |
| tags | [String]! | A list of tags associated with the issue. |
| autofixAiAvailable | Boolean! | Whether AI-powered autofix is available for this issue. |
| Field | Type | Description |
|---|
| pageInfo | PageInfo! | Pagination data for this connection. |
| edges | [IssueEdge]! | Contains the nodes in this connection. |
| totalCount | Int | Total number of items in the connection. |
A Relay edge containing an Issue and its cursor.
| Field | Type | Description |
|---|
| node | Issue | The item at the end of the edge. |
| cursor | String! | A cursor for use in pagination. |
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. |
Configuration for an IssuePriorityType in a Repository.
| Field | Type | Description |
|---|
| priorityType | IssuePriorityType! | An IssuePriorityType. |
| 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. |
An IgnoreRule defines the condition on which to suppress an Issue's Occurrences in a Repository.
| Field | Type | Description |
|---|
| id | ID! | The ID of the object. |
| createdAt | DateTime! | Time when the ignore rule was created. |
| 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. |
| Field | Type | Description |
|---|
| pageInfo | PageInfo! | Pagination data for this connection. |
| edges | [IgnoreRuleEdge]! | Contains the nodes in this connection. |
| totalCount | Int | Total number of items in the connection. |
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. |
