Skip to content
  • Auto
  • Light
  • Dark

List

Get diagnostics for a build
client.Builds.Diagnostics.List(ctx, buildID, query) (*Page[CodestringIgnoredboolLevelstringMessagestringConfigRefstringOasRefstringBuildDiagnosticListResponse], error)
get/v0/builds/{buildId}/diagnostics

Get diagnostics for a build

Parameters
buildIDstring

Build ID

queryCursorfieldLimitfieldSeverityfieldTargetsfieldBuildDiagnosticListParams
Hide ParametersShow Parameters
Cursorfield
optional
param.Field[string]

Pagination cursor from a previous response

Limitfield
optional
param.Field[float64]

Maximum number of diagnostics to return, defaults to 100 (maximum: 100)

exclusiveMinimum0
maximum100
Severityfield
optional

Includes the given severity and above (fatal > error > warning > note).

Hide ParametersShow Parameters
BuildDiagnosticListParamsSeverityFatalconst
"fatal"
BuildDiagnosticListParamsSeverityErrorconst
"error"
BuildDiagnosticListParamsSeverityWarningconst
"warning"
BuildDiagnosticListParamsSeverityNoteconst
"note"
Targetsfield
optional
param.Field[[]TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget]

Optional list of language targets to filter diagnostics by

Hide ParametersShow Parameters
TargetNodeconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"node"
TargetTypescriptconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"typescript"
TargetPythonconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"python"
TargetGoconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"go"
TargetJavaconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"java"
TargetKotlinconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"kotlin"
TargetRubyconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"ruby"
TargetTerraformconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"terraform"
TargetCliconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"cli"
TargetPhpconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"php"
TargetCsharpconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"csharp"
Returns
BuildDiagnosticListResponsestruct
Hide ParametersShow Parameters
Codestring
Ignoredbool
Levelstring
Hide ParametersShow Parameters
BuildDiagnosticListResponseLevelFatalconst
BuildDiagnosticListResponseLevelFatalBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelErrorBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelWarningBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelNoteBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevel
"fatal"
BuildDiagnosticListResponseLevelErrorconst
BuildDiagnosticListResponseLevelFatalBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelErrorBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelWarningBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelNoteBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevel
"error"
BuildDiagnosticListResponseLevelWarningconst
BuildDiagnosticListResponseLevelFatalBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelErrorBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelWarningBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelNoteBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevel
"warning"
BuildDiagnosticListResponseLevelNoteconst
BuildDiagnosticListResponseLevelFatalBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelErrorBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelWarningBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevelNoteBuildDiagnosticListResponseLevelBuildDiagnosticListResponseLevel
"note"
Messagestring
ConfigRefstring
optional
OasRefstring
optional
package main

import (
  "context"
  "fmt"

  "github.com/stainless-api/stainless-api-go"
  "github.com/stainless-api/stainless-api-go/option"
)

func main() {
  client := stainless.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Builds.Diagnostics.List(
    context.TODO(),
    "buildId",
    stainless.BuildDiagnosticListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
200 Example
{
  "data": [
    {
      "code": "code",
      "ignored": true,
      "level": "fatal",
      "message": "message",
      "config_ref": "config_ref",
      "oas_ref": "oas_ref"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}