Analyzer

analyzer

Query: analyzer Fetch details of a single analyzer using the shortcode.

Arguments

Field Type Description
shortcode String! Shortcode of the analyzer you'd like to get.

Sample Request

query {
  analyzer(shortcode:"python") {
    id
    shortcode
    name
  }
}

Sample Response

{
  "data": {
    "analyzer": {
      "id": "QW5hbHl6Zdd6bGtiZXZ6",
      "shortcode": "python",
      "name": "Python"
    }
  }
}

analyzers

Query: analyzers Fetch all available analyzers on DeepSource.

Arguments

Field Type Description
offset Int
before String
after String
first Int
last Int

Sample Request

query {
  analyzers{
    edges {
      node {
        id
        name
        shortcode
      }
    }
  }
}

Sample Response

{
  "data": {
    "analyzers": {
      "edges": [
        {
          "node": {
            "id": "QW5hbHl6ZXI6bGtiZXZ6",
            "name": "Python",
            "shortcode": "python"
          }
        },
        {
          "node": {
            "id": "QW5hbHl6ZXI6cmx6b2xi",
            "name": "Go",
            "shortcode": "go"
          }
        }
      ]
    }
  }
}

Objects

Analyzer

Field Type Description
id ID! The ID of the object.
shortcode String! Unique identifier for this analyzer globally.
name String! Human-friendly name for this analyzer.
issues IssueConnection!
offset Int
before String
after String
first Int
last Int

AnalyzerConnection

Field Type Description
pageInfo PageInfo!

Pagination data for this connection.

edges [AnalyzerEdge]!

Contains the nodes in this connection.

totalCount Int

AnalyzerEdge

A Relay edge containing a Analyzer and its cursor.

Field Type Description
node Analyzer The item at the end of the edge.
cursor String! A cursor for use in pagination.

Issue

Field Type Description
shortcode String!
title String!
analyzer Analyzer!
autofixAvailable Boolean! Whether this issue is autofixable
isRecommended Boolean! Whether this is a recommended issue. Recommended issues show up at the top of the results.
id ID! The ID of the object.
category IssueCategory! Category of the issue.
shortDescription String! A short description of the issue.

IssueConnection

Field Type Description
pageInfo PageInfo! Pagination data for this connection.
edges [IssueEdge]! Contains the nodes in this connection.
totalCount Int

IssueEdge

A Relay edge containing a 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.