Lookup a repository and associated information.
Query:repository Fetch the details of one of your repositories.
Field
Type
Description
name
String !The name of the repository to lookup.
login
String !The login or username of the account under which the repository exists.
vcsProvider
VCSProvider !
VCS Provider of the account.
GraphQL
query {
repository(
name:"demo-go",
login:"cyberdyne",
vcsProvider:GITHUB
) {
name
defaultBranch
dsn
isPrivate
analysisRuns {
edges {
node {
runUid
}
}
}
}
}
JSON
{
"data": {
"repository": {
"name": "demo-go",
"defaultBranch": "master",
"dsn": "https://[email protected] ",
"isPrivate": true,
"analysisRuns": {
"edges": [
{
"node": {
"runUid": "5d821174-04vf-4214-b56d-ced0a7ca209e"
}
},
{
"node": {
"runUid": "6ff1cdb8-9abe-4307-a177-4b9f8d3ba639"
}
},
]
}
}
}
}
Mutation:regenerateRepositoryDSN Regenerate a repository's DSN.
GraphQL
mutation ($input: RegenerateRepositoryDSNInput!) {
regenerateRepositoryDSN(input: $input) {
dsn
}
}
JavaScript
variables = {
"input": {
"repositoryId": "VHJhbnNmb3JtZXI6bGp6a3d6"
}
}
Mutation:updateRepositoryDefaultBranch Update a repository's default branch for baseline. If the repository is activated, this action will trigger a new analysis. Only available to users with WRITE permission on the repository.
GraphQL
mutation ($input: UpdateRepositoryDefaultBranchInput!) {
updateRepositoryDefaultBranch(input: $input) {
ok
repository {
defaultBranchName
}
}
}
JavaScript
variables = {
"input": {
"id": "VHJhbnNmb3JtZXI6bGp6a3d6",
"defaultBranchName": "add-awesomeness"
}
}
JSON
{
"updateRepositoryDefaultBranch": {
"ok": true,
"repository": {"defaultBranchName": "add-awesomeness"}
}
}
Mutation:updateRepositoryIssueCategorySetting Update a repository's issue configuration (also known as quality gates). Only users with WRITE permission on the repository can trigger this mutation.
Mutation
mutation ($input: UpdateRepositoryIssueCategorySettingInput!) {
updateRepositoryIssueCategorySetting(input: $input) {
ok
}
}
Variables
{
"input": {
"repositoryId": "Umwm3NpdG9yeTprZ3dyb222",
"issueCategory": "ANTI_PATTERN",
"isReported": true,
"canFailCheck": false
}
}
JSON
{
"data": {
"updateRepositoryIssueCategorySetting": {
"ok": true
}
}
}
Field Type Description id ID !The ID of the object. name String !The name of this repository. vcsProvider VCSProvider !VCS Provider of the repository. vcsUrl String !URL of the repository on the VCS. latestCommitOid String Object ID of the latest commit on the default branch.
isPrivate Boolean !Repository visibility on the VCS provider. isActivated Boolean !Repository activation status. configJson JSON The `.deepsource.toml` config of the repository represented as a JSON object. defaultBranch String The default base branch of the repository on DeepSource. dsn String The DSN value for this repository. account Account !The account under which this repository exists. analysisRuns AnalysisRunConnection Past analysis runs for the repository offset Int before String after String first Int last Int enabledAnalyzers AnalyzerConnection The analyzers enabled in this repository. offset Int before String after String first Int last Int issues RepositoryIssueConnection Get all issues raised in the default branch of this repository. Specifying a path would only return those issues whose occurrences are present in the file at path. path String Show issues for this path only. offset Int before String after String first Int last Int
ignoreRules IgnoreRuleConnection List of `IgnoreRule`s that exist for the repository.
issueShortcode
String Filter by an `Issue` shortcode.
filePath
String Filter by a specific file's path.
offset
Int
before
String
after
String
first
Int
last
Int
report Report !A report associated with this repository. key ReportKey !The key of the report to fetch. metrics [RepositoryMetric !]! List of all DeepSource metrics. shortcodeIn [MetricShortcode ] List of metric shortcodes to filter on. issueCategorySettings [IssueCategorySetting !]! Issue categories configuration for the repository.
Field Type Description id ID !The ID of the object. issue Issue !Definition of the issue that has been raised. occurrences OccurrenceConnection All occurrences of this issue in the default branch. offset Int before String after String first Int last Int repository Repository !The repository for which this issue has been raised.
A Relay edge containing a RepositoryIssue and its cursor.
Field Type Description node RepositoryIssue The item at the end of the edge. cursor String !A cursor for use in pagination.
Field Type Description pageInfo PageInfo !Pagination data for this connection. edges [RepositoryEdge ]! Contains the nodes in this connection. totalCount Int
A Relay edge containing a Repository and its cursor.
Field Type Description node Repository The item at the end of the edge. cursor String !A cursor for use in pagination.
Input for the regenerateRepositoryDSN
Field Type Description repositoryId ID !GraphQL node ID of the repository.
Payload for the regenerateRepositoryDSN
Field Type Description dsn String !The new DSN for the repository.
Input for the updateRepositoryDefaultBranch
Field Type Description id ID! GraphQL node ID of the repository. defaultBranchName String! Default branch for analysis on the repository.
Payload for the updateRepositoryDefaultBranch
Field Type Description ok Boolean! Whether the operation was successful. repository Repository! Repository type.
Input for the updateRepositoryIssueCategorySetting
Field Type Description repositoryId ID !The repository's ID. issueCategory IssueCategory !The issue category you want to update. isReported Boolean !Whether issues of a given category are enabled for reporting in the repository. canFailCheck Boolean !Whether to fail checks when occurrence(s) of issues of a given category is found in the repository, an issue category can only be marked to fail a check if it is enabled for reporting.
Paylod for the updateRepositoryIssueCategorySetting
Field Type Description ok Boolean !Whether the operation was successful.
