Sonatype Developer Priorities API

openapi: 3.0.1
info:
  title: Sonatype Lifecycle Public REST Advanced Search Developer Priorities API
  version: 1.201.0-02
  description: Use the Advanced Search REST API to perform searches on Lifecycle application scan reports.
security:
- BasicAuth: []
  BearerAuth: []
tags:
- description: Use this REST API to export Sonatype Developer component priorities data, including security reachability data.
  name: Developer Priorities
paths:
  /api/v2/developer/priorities/{applicationId}/{scanId}:
    get:
      description: 'Use this method to retrieve all priorities by providing the application ID and scan ID.


        Permissions required: View IQ Elements'
      operationId: getPriorities
      parameters:
      - description: Enter the applicationId.
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      - description: Enter the scanId.
        in: path
        name: scanId
        required: true
        schema:
          type: string
      - description: Whether to include remediation type and version for the component or not
        in: query
        name: includeRemediation
        schema:
          default: false
          type: boolean
      - description: Current page number.
        in: query
        name: page
        schema:
          default: 1
          format: int32
          type: integer
      - description: Enter the no. of results that should be visible per page.
        in: query
        name: pageSize
        schema:
          default: 10
          format: int32
          type: integer
      - description: Component name to filter by
        in: query
        name: componentNameFilter
        schema:
          type: string
      - description: Whether to enable Fail/Warn policy action filter or not
        in: query
        name: filterOnPolicyActions
        schema:
          default: true
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevelopmentPrioritizationResults'
          description: 'The response field `priorities` returns prioritized components for the specified

            application ID and scan ID. Each result has relevant component information, reachability

            information, policy information, and a priority number, sorted by priority in descending order.

            Pagination is supported, and the default page size is 10.

            The parameter `includeRemediation` is required for the paginated result to

            include remediation information.'
      tags:
      - Developer Priorities
  /api/v2/developer/priorities/{applicationId}/{scanId}/export:
    get:
      description: 'Use this method to retrieve the priorities, by providing the applicationId and scanId.


        Permissions required: View IQ Elements'
      operationId: getPrioritiesExport
      parameters:
      - description: Enter the applicationId.
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      - description: Enter the scanId.
        in: path
        name: scanId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'The response is a CSV that contains all the prioritized components for the specified

            applicationId and scanId. Each line has all relevant component information, reachability

            information, policy information, and the priority assigned to it.'
      tags:
      - Developer Priorities
components:
  schemas:
    DevelopmentPrioritizationResults:
      properties:
        hasAutoWaiversConfigured:
          type: boolean
        priorities:
          $ref: '#/components/schemas/ApiPageResultPrioritizedComponent'
        scanIdFromLatestBuildStageEvaluation:
          type: string
      type: object
    ApiPageResultPrioritizedComponent:
      description: Paginated response wrapper
      properties:
        page:
          description: Current page number
          format: int32
          type: integer
        pageCount:
          description: Total number of pages
          format: int64
          type: integer
        pageSize:
          description: Number of items per page
          format: int32
          type: integer
        results:
          description: List of items for the current page
          items:
            $ref: '#/components/schemas/PrioritizedComponent'
          type: array
        total:
          description: Total number of items
          format: int64
          type: integer
      type: object
    PrioritizedComponent:
      description: List of items for the current page
      properties:
        action:
          type: string
        componentHash:
          type: string
        componentIdentifier:
          $ref: '#/components/schemas/ComponentIdentifier'
        dependencyType:
          type: string
        displayName:
          type: string
        hasAutoWaiver:
          type: boolean
        hasExpiredWaiver:
          type: boolean
        hasFailActionOnComponent:
          type: boolean
        hasSameViolationsOnMain:
          type: boolean
        hasSoonToExpireWaiver:
          type: boolean
        highestReachableThreat:
          format: int32
          type: integer
        highestThreat:
          format: int32
          type: integer
        highestThreatPolicyConstraintName:
          type: string
        highestThreatPolicyName:
          type: string
        isAllViolationsWaived:
          type: boolean
        priority:
          format: int32
          type: integer
        remediationType:
          enum:
          - next-no-violations
          - next-non-failing
          - next-no-violations-with-dependencies
          - next-non-failing-with-dependencies
          - inner-source-latest-non-breaking
          - inner-source-latest
          - recommended-non-breaking
          - recommended-non-breaking-with-dependencies
          type: string
        remediationVersion:
          type: string
        securityReachable:
          type: boolean
        waivedViolationsCount:
          format: int32
          type: integer
        waiverExpirationDetails:
          type: string
      type: object
    ComponentIdentifier:
      properties:
        coordinates:
          additionalProperties:
            type: string
          type: object
        format:
          type: string
      type: object
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http