# Diagnostics

## Get diagnostics for a build

`DiagnosticListPage builds().diagnostics().list(DiagnosticListParamsparams = DiagnosticListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/v0/builds/{buildId}/diagnostics`

Get the list of diagnostics for a given build.

If no language targets are specified, diagnostics for all languages are returned.

### Parameters

- `DiagnosticListParams params`

  - `Optional<String> buildId`

    Build ID

  - `Optional<String> cursor`

    Pagination cursor from a previous response

  - `Optional<Double> limit`

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

  - `Optional<Severity> severity`

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

    - `FATAL("fatal")`

    - `ERROR("error")`

    - `WARNING("warning")`

    - `NOTE("note")`

  - `Optional<String> targets`

    Optional comma-delimited list of language targets to filter diagnostics by

### Returns

- `class BuildDiagnostic:`

  - `String code`

    The kind of diagnostic.

  - `boolean ignored`

    Whether the diagnostic is ignored in the Stainless config.

  - `Level level`

    The severity of the diagnostic.

    - `FATAL("fatal")`

    - `ERROR("error")`

    - `WARNING("warning")`

    - `NOTE("note")`

  - `String message`

    A description of the diagnostic.

  - `Optional<BuildDiagnosticMore> more`

    - `Markdown`

      - `String markdown`

      - `JsonValue; type "markdown"constant`

        - `MARKDOWN("markdown")`

    - `Raw`

      - `String raw`

      - `JsonValue; type "raw"constant`

        - `RAW("raw")`

  - `Optional<String> configRef`

    A JSON pointer to a relevant field in the Stainless config.

  - `Optional<String> oasRef`

    A JSON pointer to a relevant field in the OpenAPI spec.

### Example

```java
package com.stainless.api.example;

import com.stainless.api.client.StainlessClient;
import com.stainless.api.client.okhttp.StainlessOkHttpClient;
import com.stainless.api.models.builds.diagnostics.DiagnosticListPage;
import com.stainless.api.models.builds.diagnostics.DiagnosticListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StainlessClient client = StainlessOkHttpClient.fromEnv();

        DiagnosticListPage page = client.builds().diagnostics().list("buildId");
    }
}
```

#### Response

```json
{
  "data": [
    {
      "code": "code",
      "ignored": true,
      "level": "fatal",
      "message": "message",
      "more": {
        "markdown": "markdown",
        "type": "markdown"
      },
      "config_ref": "config_ref",
      "oas_ref": "oas_ref"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}
```

## Domain Types

### Build Diagnostic

- `class BuildDiagnostic:`

  - `String code`

    The kind of diagnostic.

  - `boolean ignored`

    Whether the diagnostic is ignored in the Stainless config.

  - `Level level`

    The severity of the diagnostic.

    - `FATAL("fatal")`

    - `ERROR("error")`

    - `WARNING("warning")`

    - `NOTE("note")`

  - `String message`

    A description of the diagnostic.

  - `Optional<BuildDiagnosticMore> more`

    - `Markdown`

      - `String markdown`

      - `JsonValue; type "markdown"constant`

        - `MARKDOWN("markdown")`

    - `Raw`

      - `String raw`

      - `JsonValue; type "raw"constant`

        - `RAW("raw")`

  - `Optional<String> configRef`

    A JSON pointer to a relevant field in the Stainless config.

  - `Optional<String> oasRef`

    A JSON pointer to a relevant field in the OpenAPI spec.

### Build Diagnostic More

- `class BuildDiagnosticMore: A class that can be one of several variants.union`

  - `Markdown`

    - `String markdown`

    - `JsonValue; type "markdown"constant`

      - `MARKDOWN("markdown")`

  - `Raw`

    - `String raw`

    - `JsonValue; type "raw"constant`

      - `RAW("raw")`