> ## Documentation Index
> Fetch the complete documentation index at: https://docs.githits.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Review package upgrades

> Compare the versions you currently use with proposed upgrades for up to 30 packages. Each review brings together security advisories, dependency changes, compatibility information, and release notes to help you decide what to upgrade.

Reviews identify gaps in the available information so you can see where an upgrade needs further investigation.


## Selector catalogue

Use the following selectors with the `fields` query parameter to choose which fields the response includes. See [Choose what the response includes](https://docs.githits.com/api/requests-and-responses#choose-what-the-response-includes) for details.

| Selector | Data | Default |
| --- | --- | --- |
| `security.direct` | Security advisories for the current and target versions, including advisories introduced, fixed, or unchanged by the upgrade. | Yes |
| `security.transitive` | Security changes in indirect dependencies, with counts and affected package details. Each detail list includes up to 50 packages and indicates truncation. | Yes |
| `dependencies.direct` | Direct dependencies added, removed, or changed, including version constraints and resolved versions. | Yes |
| `dependencies.transitive` | Indirect dependencies added, removed, or changed. | Yes |
| `dependencies.issues` | Counts and names of newly deprecated, duplicate, conflicting, or outdated dependencies. | No |
| `compatibility` | Peer dependency changes and compatibility notes. | Yes |
| `changelog` | Release-note summaries, previews, sources, and change signals for the upgrade range. Entry and keyword-match lists each contain up to 20 items, with coverage and truncation information. | Yes |
| `changelog.body` | Full release-note text for entries and keyword matches. Also includes changelog. | Yes |
| `security.*` | Both direct and transitive security groups. | No |
| `dependencies.*` | All dependency change and issue groups. | No |
| `changelog.*` | Changelog summaries and full release-note text. | No |




## OpenAPI

````yaml https://api.githits.dev/v1/openapi.json post /v1/package-upgrade-reviews
openapi: 3.1.0
info:
  description: >-
    Explore package metadata, security advisories, dependencies, documentation
    and source code with the GitHits API.


    ## Choose an operation


    | Task | Operations |

    | --- | --- |

    | Inspect a package | Release metadata, vulnerabilities and dependencies |

    | Review releases or upgrades | Changelog and batch upgrade reviews |

    | Read documentation | List package documentation, then read a page |

    | Navigate source code | List files, read a file or search text within a
    target |

    | Compare source trees | Compare files, line statistics and patches between
    package versions or repository refs |

    | Discover relevant content | Search across packages, repositories and
    documentation sites; retrieve a search's status and retained results |

    | Resolve a target name | Find ranked package, repository and
    documentation-site targets |

    | Ask a cited question | Generate an answer grounded in a package,
    repository or documentation site, or continue a conversation |

    | Generate an example | Generate and save a code example, then submit
    feedback |

    | Find a language identifier | Search supported programming languages |


    ## Authenticate and send requests


    The production API origin is `https://api.githits.dev`; development uses
    `https://api-dev.githits.dev`. Examples target production. Replace `<token>`
    with your GitHits token. Send the token in `Authorization: Bearer <token>`.
    JSON request bodies use `Content-Type: application/json`; public JSON field
    names use `snake_case`.


    Percent-encode a package name or opaque read target as one path segment,
    including any embedded slash. For query values, encode a literal plus sign
    as `%2B`; ordinary form decoding interprets `+` as a space. Each operation
    documents its accepted parameters and encoding rules.


    ## Select the data you need


    Where supported, `fields` is a comma-separated **query parameter**,
    including on POST requests. Omit it to use the operation's defaults.
    Supplying it replaces those defaults; required identity and information
    needed to interpret the result remain present.


    A **selector** names a supported **group** of response fields. Groups are
    atomic: their members are selected together. A **wildcard bundle**, such as
    `vulnerabilities.*`, selects only the groups listed for that bundle. A bare
    group does not automatically include nested groups. Arbitrary subfields and
    undeclared wildcards are not supported.


    Each operation lists its selectors, defaults, dependencies and the data they
    return. Selection can reduce transferred data without reducing the work
    needed to produce it; consult its parameter and response field
    documentation. Small fixed responses do not offer `fields`.


    ## Interpret responses and errors


    An omitted optional field can mean unselected or unavailable data, according
    to the operation's contract. Null has an operation-specific meaning: it can
    mark unavailable or inapplicable data, or an unselected search result. Empty
    arrays, zero and false are values, not substitutes for unavailable data.
    Always retain the result's completeness and freshness information when
    displaying or processing it.


    **Requested** identity records caller intent; **resolved** identity records
    what that intent resolved to; **served** identity identifies the artifact
    that produced the response. These can differ while indexing or refresh work
    continues. Use served identity when an exact follow-up read is required,
    preserving package-relative or repository-relative path scope.


    Errors normally use `application/problem+json`. Branch on the stable `code`,
    not the human-readable `detail`. Include `X-Request-ID` when reporting a
    problem; error `instance` matches that ID. Respect `Retry-After` when
    present. If request identity cannot be created, the response is an empty
    HTTP 500 without a request ID. Responses use `Cache-Control: no-store`.


    Timeouts do not guarantee that work stopped. Read the documented timeout
    responses, especially for Ask, generated examples and append-only feedback.
    Optional `X-GitHits-*` request headers attribute client, agent and session
    usage. The OpenAPI extension `x-githits-cost` is provisional operation
    metadata, not a price or a measure of computation.


    ## Contract status


    This API is pre-production. The external v1 contract is not yet frozen.
  license:
    name: Proprietary
  title: GitHits Public API
  version: 0.1.0
servers:
  - description: Production
    url: https://api.githits.dev
security: []
tags:
  - description: >-
      Package metadata, release history, vulnerabilities, dependency graphs and
      upgrade comparisons. Each operation documents its registry, version and
      evidence scope.
    name: Packages
  - description: >-
      Discover existing documentation pages and read their content with exact
      source locators and availability information.
    name: Documentation
  - description: >-
      Enumerate files, read exact content and grep within a package or
      repository. Responses retain served identity, indexing state and
      completeness information.
    name: Code
  - description: >-
      Discover evidence across package, repository and documentation-site
      targets, then retrieve retained search results and progress.
    name: Search
  - description: >-
      Find supported programming-language names and aliases for example
      requests.
    name: Languages
  - description: >-
      Generate code examples for programming tasks, with source references and
      license attribution.
    name: Examples
  - description: Rate generated examples or sessions and provide written feedback.
    name: Feedback
  - description: >-
      Preview operations for target resolution, source comparison and cited
      questions. Routes use /v1/experimental and may later move to permanent v1
      locations under a documented migration policy.
    name: Experimental
paths:
  /v1/package-upgrade-reviews:
    post:
      tags:
        - Packages
      summary: Review package upgrades
      description: >
        Compare the versions you currently use with proposed upgrades for up to
        30 packages. Each review brings together security advisories, dependency
        changes, compatibility information, and release notes to help you decide
        what to upgrade.


        Reviews identify gaps in the available information so you can see where
        an upgrade needs further investigation.



        ## Selector catalogue


        Use the following selectors with the `fields` query parameter to choose
        which fields the response includes. See [Choose what the response
        includes](https://docs.githits.com/api/requests-and-responses#choose-what-the-response-includes)
        for details.


        | Selector | Data | Default |

        | --- | --- | --- |

        | `security.direct` | Security advisories for the current and target
        versions, including advisories introduced, fixed, or unchanged by the
        upgrade. | Yes |

        | `security.transitive` | Security changes in indirect dependencies,
        with counts and affected package details. Each detail list includes up
        to 50 packages and indicates truncation. | Yes |

        | `dependencies.direct` | Direct dependencies added, removed, or
        changed, including version constraints and resolved versions. | Yes |

        | `dependencies.transitive` | Indirect dependencies added, removed, or
        changed. | Yes |

        | `dependencies.issues` | Counts and names of newly deprecated,
        duplicate, conflicting, or outdated dependencies. | No |

        | `compatibility` | Peer dependency changes and compatibility notes. |
        Yes |

        | `changelog` | Release-note summaries, previews, sources, and change
        signals for the upgrade range. Entry and keyword-match lists each
        contain up to 20 items, with coverage and truncation information. | Yes
        |

        | `changelog.body` | Full release-note text for entries and keyword
        matches. Also includes changelog. | Yes |

        | `security.*` | Both direct and transitive security groups. | No |

        | `dependencies.*` | All dependency change and issue groups. | No |

        | `changelog.*` | Changelog summaries and full release-note text. | No |
      operationId: review_package_upgrades
      parameters:
        - description: >-
            Finite comma-separated atomic groups. Explicit selection replaces
            defaults; see catalogue.


            Use the case-sensitive selectors in the catalogue. Order and
            duplicate selectors do not affect the result. ASCII whitespace
            around selectors is ignored. The decoded value is limited to 2048
            UTF-8 bytes. Empty or unknown selectors and repeated `fields` query
            parameters return `400 VALIDATION_ERROR`. A group does not include
            nested groups unless the catalogue says so; only listed wildcard
            bundles are supported.
          in: query
          name: fields
          required: false
          schema:
            default: >-
              security.direct,security.transitive,dependencies.direct,dependencies.transitive,compatibility,changelog,changelog.body
            type: string
        - description: >-
            Optional client attribution: trimmed printable ASCII, at most 80
            bytes. Invalid optional values are dropped.
          in: header
          name: X-GitHits-Client-Name
          required: false
          schema:
            type: string
        - description: >-
            Optional client-version attribution: trimmed printable ASCII, at
            most 80 bytes. Invalid optional values are dropped.
          in: header
          name: X-GitHits-Client-Version
          required: false
          schema:
            type: string
        - description: >-
            Optional agent attribution: trimmed printable ASCII, at most 160
            bytes. Invalid optional values are dropped.
          in: header
          name: X-GitHits-Agent
          required: false
          schema:
            type: string
        - description: >-
            Optional session attribution: trimmed printable ASCII, at most 128
            bytes. Invalid optional values are dropped; no session is created.
          in: header
          name: X-GitHits-Session-ID
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              packages:
                - current_version: 1.0.0
                  name: example
                  registry: npm
                  target_version: 2.0.0
            schema:
              $ref: '#/components/schemas/UpgradeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                full:
                  value:
                    reviews:
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                    total: 1
                maximum_batch:
                  value:
                    reviews:
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - changelog:
                          breaking_signals: []
                          entries:
                            - body: Release notes
                              body_preview: Release notes
                              detail_source: releases
                              has_changelog: true
                              headline: Release
                              html_url: null
                              published_at: null
                              signals: []
                              source_version: v2.0.0
                              version: 2.0.0
                          fallback: null
                          has_release_note_bodies: true
                          keyword_entries: []
                          migration_signals: []
                          source: releases
                          total_entries: 1
                          total_entries_with_bodies: 1
                          total_keyword_entries: 0
                          truncated: false
                        compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        dependency_changes:
                          direct:
                            added: []
                            changed: []
                            removed: []
                          transitive:
                            added: []
                            changed: []
                            removed: []
                        dependency_issues:
                          current_total: 0
                          introduced_conflicts: []
                          introduced_deprecated: []
                          introduced_duplicates: []
                          introduced_outdated: []
                          target_total: 0
                        name: example
                        registry: npm
                        security:
                          current:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 1.0.0
                          fixed: []
                          introduced: []
                          target:
                            advisories: []
                            affected_count: 0
                            all_count: 0
                            deprecated: false
                            deprecation_reason: null
                            last_modified_at: null
                            non_affecting_count: 0
                            published_at: null
                            version: 2.0.0
                          transitive:
                            current_affected: 0
                            fixed_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            fixed_packages: []
                            introduced_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            introduced_packages: []
                            still_affected_package_details:
                              entries: []
                              total_count: 0
                              truncated: false
                            target_affected: 0
                          unchanged: []
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                    total: 30
                partial:
                  value:
                    reviews:
                      - compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        name: example
                        registry: npm
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                      - current_version: 1.0.0
                        name: unavailable
                        registry: npm
                        target_version: 2.0.0
                        unknown_details:
                          - code: invalid_package_input
                            message: >-
                              The package or requested version could not be
                              reviewed.
                            retryable: null
                            section: package_metadata
                        version_delta: unknown
                    total: 2
                sparse:
                  value:
                    reviews:
                      - compatibility:
                          notes: []
                          peer_dependency_changes: []
                        current_version: 1.0.0
                        name: example
                        registry: npm
                        target_version: 2.0.0
                        unknown_details: []
                        version_delta: major
                    total: 1
              schema:
                $ref: '#/components/schemas/UpgradeBatch'
          description: Ordered reviews including partially unavailable packages
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            X-Request-ID:
              schema:
                type: string
        '400':
          content:
            application/problem+json:
              example:
                code: VALIDATION_ERROR
                detail: The request could not be completed.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 400
                title: Validation error
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: >-
            VALIDATION_ERROR: invalid JSON, keys, batch, identity, versions or
            fields.
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            X-Request-ID:
              schema:
                type: string
        '401':
          content:
            application/problem+json:
              example:
                code: AUTHENTICATION_REQUIRED
                detail: The request could not be completed.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 401
                title: Authentication required
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: 'AUTHENTICATION_REQUIRED: missing or rejected bearer token.'
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            WWW-Authenticate:
              schema:
                type: string
            X-Request-ID:
              schema:
                type: string
        '403':
          content:
            application/problem+json:
              example:
                code: FORBIDDEN
                detail: The request could not be completed.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 403
                title: Forbidden
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: >-
            FORBIDDEN, ACCOUNT_INACTIVE, FEATURE_FLAG_REQUIRED or
            TERMS_ACCEPTANCE_REQUIRED; safe acceptance links may be included.
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            X-Request-ID:
              schema:
                type: string
        '404':
          content:
            application/problem+json:
              example:
                code: PACKAGE_NOT_FOUND
                detail: The request could not be completed.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 404
                title: Package not found
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: >-
            Root PACKAGE_NOT_FOUND, VERSION_NOT_FOUND or NO_RELEASED_VERSIONS;
            individual missing evidence ordinarily stays in the batch
            unknown_details.
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            X-Request-ID:
              schema:
                type: string
        '405':
          content:
            application/problem+json:
              example:
                code: METHOD_NOT_ALLOWED
                detail: The requested method is not supported for this route.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 405
                title: Method not allowed
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: 'METHOD_NOT_ALLOWED: the route does not support this HTTP method.'
          headers:
            Allow:
              description: 'Supported methods: POST.'
              schema:
                type: string
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            X-Request-ID:
              description: >-
                Request trace ID for diagnostics; matches problem.instance on
                failures.
              schema:
                type: string
        '422':
          content:
            application/problem+json:
              example:
                code: UNSUPPORTED_PACKAGE_VARIANTS
                detail: The request could not be completed.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 422
                title: Unsupported package variants
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: Root UNSUPPORTED_PACKAGE_VARIANTS.
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            X-Request-ID:
              schema:
                type: string
        '429':
          content:
            application/problem+json:
              example:
                code: RATE_LIMITED
                detail: The request could not be completed.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 429
                title: Rate limited
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: RATE_LIMITED; honor Retry-After.
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            Retry-After:
              schema:
                type: string
            X-Request-ID:
              schema:
                type: string
        '500':
          description: >-
            Request identity could not be created. Empty body without
            X-Request-ID; no problem object is available.
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
          x-githits-empty-identity-failure: true
        '502':
          content:
            application/problem+json:
              example:
                code: UPSTREAM_ERROR
                detail: The request could not be completed.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 502
                title: Upstream error
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: >-
            UPSTREAM_ERROR: transport, malformed or partial GraphQL response;
            raw upstream errors suppressed.
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            X-Request-ID:
              schema:
                type: string
        '504':
          content:
            application/problem+json:
              example:
                code: TIMEOUT
                detail: The request could not be completed.
                instance: 4bf92f3577b34da6a3ce929d0e0e4736
                status: 504
                title: Upstream timeout
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemResponse'
          description: >-
            TIMEOUT: the120-second aggregate deadline expired; upstream work may
            continue.
          headers:
            Cache-Control:
              schema:
                enum:
                  - no-store
                type: string
            X-Request-ID:
              schema:
                type: string
      security:
        - bearer_auth: []
components:
  schemas:
    UpgradeRequest:
      additionalProperties: false
      description: >-
        Ordered canonical batch; unknown/duplicate JSON keys fail validation;
        rows are never silently removed.
      properties:
        min_severity:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/VulnerabilitySeverity'
              description: >-
                Optional minimum for direct and transitive security; low=0.1,
                medium=4, high=7, critical=9. Null/omission includes unknown
                scores.
        packages:
          description: >-
            One to thirty packages; all recognized registries, no silent row
            removal.
          items:
            $ref: '#/components/schemas/UpgradePackage'
          maxItems: 30
          minItems: 1
          type: array
      required:
        - packages
      type: object
    UpgradeBatch:
      description: Atomic batch evidence; null values mean unavailable.
      properties:
        reviews:
          description: Source reviews.
          items:
            $ref: '#/components/schemas/UpgradeReview'
          type: array
        total:
          description: >-
            Validated count of ordered input reviews, including unavailable
            reviews.
          minimum: 0
          type: integer
      required:
        - total
        - reviews
      type: object
    ProblemResponse:
      description: >-
        The stable problem document returned for an unsuccessful public API
        request.
      properties:
        acceptance_url:
          description: An optional acceptance URL supplied by the upstream allow-list.
          type: string
        code:
          description: The stable uppercase API error code.
          type: string
        detail:
          description: A stable, client-safe explanation of the failure.
          type: string
        instance:
          description: The active request trace ID.
          type: string
        status:
          description: The HTTP status returned with this problem.
          format: int32
          minimum: 0
          type: integer
        terms_url:
          description: An optional terms URL supplied by the upstream allow-list.
          type: string
        title:
          description: A short, stable title for the error.
          type: string
        type:
          description: The generic RFC 9457 problem type.
          type: string
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
      type: object
    VulnerabilitySeverity:
      description: Minimum CVSS label. Any threshold excludes unknown scores upstream.
      enum:
        - low
        - medium
        - high
        - critical
      type: string
    UpgradePackage:
      additionalProperties: false
      description: >-
        Package identity and two required requested versions or supported
        constraints.
      properties:
        current_version:
          description: >-
            Required nonblank current version or upstream-supported constraint;
            shared Go/Swift tag policy.
          minLength: 1
          type: string
        name:
          description: >-
            Nonempty package name preserved exactly; maximum255 UTF-8 bytes, no
            controls. Upstream owns registry grammar and canonicalization.
          maxLength: 255
          minLength: 1
          type: string
        registry:
          description: >-
            Exact lowercase public registry spelling; whitespace and case
            variants are rejected.
          enum:
            - npm
            - pypi
            - hex
            - crates
            - vcpkg
            - zig
            - nuget
            - maven
            - packagist
            - rubygems
            - go
            - swift
          type: string
        target_version:
          description: Required nonblank target version or upstream-supported constraint.
          minLength: 1
          type: string
      required:
        - registry
        - name
        - current_version
        - target_version
      type: object
    UpgradeReview:
      description: Atomic review evidence; null values mean unavailable.
      properties:
        changelog:
          $ref: '#/components/schemas/UpgradeChangelog'
          description: Source changelog.
        compatibility:
          $ref: '#/components/schemas/UpgradeCompatibility'
          description: Source compatibility.
        current_version:
          description: >-
            Trimmed caller version or constraint, before Go wire normalization;
            inspected versions are in security.
          type: string
        dependency_changes:
          $ref: '#/components/schemas/UpgradeDependencyChanges'
          description: Source dependency changes.
        dependency_issues:
          $ref: '#/components/schemas/UpgradeDependencyIssues'
          description: Source dependency issues.
        name:
          description: >-
            Source-owned name, which can differ from the requested spelling
            after registry canonicalization.
          type: string
        registry:
          description: Source registry.
          type: string
        security:
          $ref: '#/components/schemas/UpgradeSecurity'
          description: Source security.
        target_version:
          description: >-
            Trimmed requested target version or constraint, not a claim of
            successful resolution.
          type: string
        unknown_details:
          description: >-
            Mandatory incomplete-evidence qualifications, retained even when
            optional groups are omitted.
          items:
            $ref: '#/components/schemas/UpgradeUnknownEvidence'
          type: array
        version_delta:
          $ref: '#/components/schemas/UpgradeVersionDelta'
          description: Source version delta.
      required:
        - registry
        - name
        - current_version
        - target_version
        - version_delta
        - unknown_details
      type: object
    UpgradeChangelog:
      description: Atomic changelog evidence; null values mean unavailable.
      properties:
        breaking_signals:
          description: Source breaking signals.
          items:
            type: string
          type: array
        entries:
          description: Source entries.
          items:
            $ref: '#/components/schemas/UpgradeChangelogEntry'
          type: array
        fallback:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/UpgradeChangelogFallback'
              description: Source fallback.
        has_release_note_bodies:
          description: >-
            At least one collected entry has a body; does not imply complete
            body coverage.
          type: boolean
        keyword_entries:
          description: Source keyword entries.
          items:
            $ref: '#/components/schemas/UpgradeChangelogEntry'
          type: array
        migration_signals:
          description: Source migration signals.
          items:
            type: string
          type: array
        source:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/UpgradeChangelogSource'
              description: Source source.
        total_entries:
          description: >-
            All collected range entries before either returned list is capped at
            twenty.
          format: int64
          minimum: 0
          type: integer
        total_entries_with_bodies:
          description: >-
            Collected range entries having release-note bodies, including
            entries outside the returned cap.
          format: int64
          minimum: 0
          type: integer
        total_keyword_entries:
          description: >-
            All collected range entries matching signals before the separate
            twenty-entry cap.
          format: int64
          minimum: 0
          type: integer
        truncated:
          description: Source truncated.
          type: boolean
      required:
        - source
        - fallback
        - entries
        - keyword_entries
        - total_keyword_entries
        - total_entries
        - total_entries_with_bodies
        - truncated
        - has_release_note_bodies
        - breaking_signals
        - migration_signals
      type: object
    UpgradeCompatibility:
      description: Atomic compatibility evidence; null values mean unavailable.
      properties:
        notes:
          description: Source notes.
          items:
            type: string
          type: array
        peer_dependency_changes:
          description: Source peer dependency changes.
          items:
            type: string
          type: array
      required:
        - peer_dependency_changes
        - notes
      type: object
    UpgradeDependencyChanges:
      description: Atomic dependency changes evidence; null values mean unavailable.
      properties:
        direct:
          $ref: '#/components/schemas/UpgradeChangeGroup'
          description: Source direct.
        transitive:
          $ref: '#/components/schemas/UpgradeChangeGroup'
          description: Source transitive.
      type: object
    UpgradeDependencyIssues:
      description: Atomic dependency issues evidence; null values mean unavailable.
      properties:
        current_total:
          description: Source current total.
          format: int64
          minimum: 0
          type: integer
        introduced_conflicts:
          description: Source introduced conflicts.
          items:
            type: string
          type: array
        introduced_deprecated:
          description: Source introduced deprecated.
          items:
            type: string
          type: array
        introduced_duplicates:
          description: Source introduced duplicates.
          items:
            type: string
          type: array
        introduced_outdated:
          description: Source introduced outdated.
          items:
            type: string
          type: array
        target_total:
          description: Source target total.
          format: int64
          minimum: 0
          type: integer
      required:
        - current_total
        - target_total
        - introduced_deprecated
        - introduced_duplicates
        - introduced_conflicts
        - introduced_outdated
      type: object
    UpgradeSecurity:
      description: Atomic security evidence; null values mean unavailable.
      properties:
        current:
          $ref: '#/components/schemas/UpgradeVersionSecurity'
          description: Source current.
        fixed:
          description: Source fixed.
          items:
            $ref: '#/components/schemas/UpgradeAdvisory'
          type: array
        introduced:
          description: Source introduced.
          items:
            $ref: '#/components/schemas/UpgradeAdvisory'
          type: array
        target:
          $ref: '#/components/schemas/UpgradeVersionSecurity'
          description: Source target.
        transitive:
          $ref: '#/components/schemas/UpgradeTransitiveSecurity'
          description: Source transitive.
        unchanged:
          description: Source unchanged.
          items:
            $ref: '#/components/schemas/UpgradeAdvisory'
          type: array
      type: object
    UpgradeUnknownEvidence:
      description: Typed incomplete-evidence qualification; null values mean unavailable.
      properties:
        code:
          description: >-
            Stable upstream qualification code; raw upstream failure text is
            never exposed.
          type: string
        message:
          description: Sanitized explanation; never contains upstream inspected errors.
          type: string
        retryable:
          description: Source retryable.
          type:
            - boolean
            - 'null'
        section:
          $ref: '#/components/schemas/UpgradeEvidenceSection'
          description: Source section.
      required:
        - section
        - code
        - retryable
        - message
      type: object
    UpgradeVersionDelta:
      description: Source-defined version delta values.
      enum:
        - patch
        - minor
        - major
        - prerelease
        - downgrade
        - same
        - unknown
      type: string
    UpgradeChangelogEntry:
      description: Atomic changelog entry evidence; null values mean unavailable.
      properties:
        body:
          description: Source body.
          type: string
        body_preview:
          description: Source body preview.
          type:
            - string
            - 'null'
        detail_source:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/UpgradeDetailSource'
              description: Source detail source.
        has_changelog:
          description: Source has changelog.
          type:
            - boolean
            - 'null'
        headline:
          description: Source headline.
          type:
            - string
            - 'null'
        html_url:
          description: Source html url.
          type:
            - string
            - 'null'
        published_at:
          description: Source published at.
          type:
            - string
            - 'null'
        signals:
          description: Source signals.
          items:
            type: string
          type: array
        source_version:
          description: Source source version.
          type:
            - string
            - 'null'
        version:
          description: Source version.
          type:
            - string
            - 'null'
      required:
        - version
        - published_at
        - html_url
        - body_preview
        - headline
        - signals
        - has_changelog
        - detail_source
        - source_version
      type: object
    UpgradeChangelogFallback:
      description: Source-defined changelog fallback values.
      enum:
        - package_versions
      type: string
    UpgradeChangelogSource:
      description: Source-defined changelog source values.
      enum:
        - releases
        - changelog_file
        - hexdocs
      type: string
    UpgradeChangeGroup:
      description: Atomic change group evidence; null values mean unavailable.
      properties:
        added:
          description: Source added.
          items:
            $ref: '#/components/schemas/UpgradeChange'
          type: array
        changed:
          description: Source changed.
          items:
            $ref: '#/components/schemas/UpgradeChange'
          type: array
        removed:
          description: Source removed.
          items:
            $ref: '#/components/schemas/UpgradeChange'
          type: array
      required:
        - added
        - removed
        - changed
      type: object
    UpgradeVersionSecurity:
      description: Atomic version security evidence; null values mean unavailable.
      properties:
        advisories:
          description: Source advisories.
          items:
            $ref: '#/components/schemas/UpgradeAdvisory'
          type: array
        affected_count:
          description: Source affected count.
          format: int64
          minimum: 0
          type: integer
        all_count:
          description: Source all count.
          format: int64
          minimum: 0
          type: integer
        deprecated:
          description: Source deprecated.
          type:
            - boolean
            - 'null'
        deprecation_reason:
          description: Source deprecation reason.
          type:
            - string
            - 'null'
        last_modified_at:
          description: Source last modified at.
          type:
            - string
            - 'null'
        non_affecting_count:
          description: Source non affecting count.
          format: int64
          minimum: 0
          type: integer
        published_at:
          description: Source published at.
          type:
            - string
            - 'null'
        version:
          description: Source version.
          type: string
      required:
        - version
        - published_at
        - deprecated
        - deprecation_reason
        - affected_count
        - non_affecting_count
        - all_count
        - last_modified_at
        - advisories
      type: object
    UpgradeAdvisory:
      description: Atomic advisory evidence; null values mean unavailable.
      properties:
        affected_version_ranges_count:
          description: Source affected version ranges count.
          format: int64
          minimum: 0
          type: integer
        affected_version_ranges_truncated:
          description: Source affected version ranges truncated.
          type: boolean
        affects_inspected_version:
          description: Source affects inspected version.
          type:
            - boolean
            - 'null'
        aliases:
          description: Source aliases.
          items:
            type: string
          type: array
        fixed_in:
          description: Source fixed in.
          items:
            type: string
          type: array
        id:
          description: Source id.
          type:
            - string
            - 'null'
        is_malicious:
          description: Source is malicious.
          type:
            - boolean
            - 'null'
        matched_affected_version_ranges:
          description: Source matched affected version ranges.
          items:
            type: string
          type: array
        modified_at:
          description: Source modified at.
          type:
            - string
            - 'null'
        published_at:
          description: Source published at.
          type:
            - string
            - 'null'
        severity:
          description: Source severity.
          format: double
          type:
            - number
            - 'null'
        severity_label:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/UpgradeSeverityLabel'
              description: Source severity label.
        summary:
          description: Source summary.
          type:
            - string
            - 'null'
        withdrawn_at:
          description: Source withdrawn at.
          type:
            - string
            - 'null'
      required:
        - id
        - aliases
        - summary
        - severity
        - severity_label
        - fixed_in
        - published_at
        - modified_at
        - withdrawn_at
        - is_malicious
        - affects_inspected_version
        - matched_affected_version_ranges
        - affected_version_ranges_count
        - affected_version_ranges_truncated
      type: object
    UpgradeTransitiveSecurity:
      description: Atomic transitive security evidence; null values mean unavailable.
      properties:
        current_affected:
          description: Source current affected.
          format: int64
          minimum: 0
          type: integer
        fixed_package_details:
          $ref: '#/components/schemas/UpgradeTransitivePage'
          description: Source fixed package details.
        fixed_packages:
          description: Source fixed packages.
          items:
            type: string
          type: array
        introduced_package_details:
          $ref: '#/components/schemas/UpgradeTransitivePage'
          description: Source introduced package details.
        introduced_packages:
          description: Source introduced packages.
          items:
            type: string
          type: array
        still_affected_package_details:
          $ref: '#/components/schemas/UpgradeTransitivePage'
          description: Source still affected package details.
        target_affected:
          description: Source target affected.
          format: int64
          minimum: 0
          type: integer
      required:
        - current_affected
        - target_affected
        - introduced_packages
        - fixed_packages
        - introduced_package_details
        - fixed_package_details
        - still_affected_package_details
      type: object
    UpgradeEvidenceSection:
      description: Source-defined evidence section values.
      enum:
        - package_metadata
        - current_vulnerabilities
        - target_vulnerabilities
        - changelog
        - current_dependencies
        - target_dependencies
        - transitive_security
        - dependency_issues
      type: string
    UpgradeDetailSource:
      description: Source-defined detail source values.
      enum:
        - releases
        - changelog_file
        - hexdocs
        - registry_release_notes
        - registry_link
        - generated_github_url
        - package_version
      type: string
    UpgradeChange:
      description: Atomic change evidence; null values mean unavailable.
      properties:
        constraint:
          description: Source constraint.
          type:
            - string
            - 'null'
        from_versions:
          description: Source from versions.
          items:
            type: string
          type: array
        name:
          description: Source name.
          type: string
        registry:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/UpgradeDependencyRegistry'
              description: Source registry.
        to_versions:
          description: Source to versions.
          items:
            type: string
          type: array
        type:
          description: Source type.
          type:
            - string
            - 'null'
        version:
          description: Source version.
          type:
            - string
            - 'null'
      required:
        - name
        - registry
        - version
        - from_versions
        - to_versions
        - constraint
        - type
      type: object
    UpgradeSeverityLabel:
      description: Source-defined severity label values.
      enum:
        - critical
        - high
        - medium
        - low
        - unknown
      type: string
    UpgradeTransitivePage:
      description: Atomic transitive page evidence; null values mean unavailable.
      properties:
        entries:
          description: Source entries.
          items:
            $ref: '#/components/schemas/UpgradeTransitivePackage'
          type: array
        total_count:
          description: >-
            Total affected packages before the fifty-entry cap; no continuation
            is available.
          format: int64
          minimum: 0
          type: integer
        truncated:
          description: Source truncated.
          type: boolean
      required:
        - entries
        - total_count
        - truncated
      type: object
    UpgradeDependencyRegistry:
      description: Source-defined dependency registry values.
      enum:
        - synthetic
        - npm
        - pypi
        - hex
        - crates
        - vcpkg
        - zig
        - nuget
        - maven
        - packagist
        - rubygems
        - go
        - swift
      type: string
    UpgradeTransitivePackage:
      description: Atomic transitive package evidence; null values mean unavailable.
      properties:
        advisory_ids:
          description: Source advisory ids.
          items:
            type: string
          type: array
        affected_count:
          description: Source affected count.
          format: int64
          minimum: 0
          type: integer
        id:
          description: Source id.
          type: string
        max_severity_label:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/UpgradeSeverityLabel'
              description: Source max severity label.
        max_severity_score:
          description: Source max severity score.
          format: double
          type:
            - number
            - 'null'
        name:
          description: Source name.
          type: string
        registry:
          $ref: '#/components/schemas/UpgradeDependencyRegistry'
          description: Source registry.
        versions:
          description: Source versions.
          items:
            type: string
          type: array
      required:
        - id
        - registry
        - name
        - versions
        - affected_count
        - max_severity_score
        - max_severity_label
        - advisory_ids
      type: object
  securitySchemes:
    bearer_auth:
      scheme: bearer
      type: http

````