Mend Project Classification Evidence API

openapi: 3.2.0
info:
  title: Mend Project Classification Evidence API
  description: 'Mend''s enhanced SCA API enables automation of workflows in a REST compliant format. The API features:

    + Access for any user with Mend credentials, via a user key available in the user''s profile page in the Mend App.

    + Improved security with a JWT token per organization, which expires every 10 minutes.

    + Added scalability with support for pagination, filtering and sorting search results.

    + Broader functionality available programmatically.

    + New standard API documentation for easy navigation and search.


    **Note:** To help you get started with the Mend SCA API 2.0, we recommend reviewing our onboarding guide -> Getting Started with Mend SCA API 2.0.

    This resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend SCA API 2.0. If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.'
  version: 3.0.1
servers:
- url: https://api-saas.mend.io
  description: Generated server url
security:
- bearer-key: []
tags:
- name: Project Classification Evidence
paths:
  /api/v3.0/projects/{projectUuid}/classificationEvidence:
    get:
      tags:
      - Project Classification Evidence
      summary: Get project classification evidence
      description: Returns the classification evidence related to the project. Supports filtering by filename and evidenceItem using the search parameter, e.g. ?search=filename==MyFile.java
      operationId: getProjectClassificationEvidence
      parameters:
      - name: limit
        in: query
        description: Specifies the maximum number of items to be return in the response.
        allowEmptyValue: true
        schema:
          maximum: 10000
          type: string
          default: '50'
      - name: cursor
        in: query
        description: Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved
        allowEmptyValue: true
        schema:
          type: string
          default: '0'
      - name: search
        in: query
        description: 'Search filter in V3 MQL format. Supports: filename, evidenceItem'
        allowEmptyValue: true
        schema:
          type: string
        example: filename==MyFile.java
      - name: projectUuid
        in: path
        description: Project UUID (Administration > Projects)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponsePageableV3ListProjectRiskClassificationDTO'
components:
  schemas:
    DWRResponsePageableV3ListProjectRiskClassificationDTO:
      type: object
      properties:
        additionalData:
          title: Provides insights into endpoint-supported pagination information.
          type: object
          description: '+ **totalItems**: The total count of data points returned in an API response.

            '
          example:
            totalItems: '422'
            next: http://someUrl?cursor=3
            cursor: 3
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          type: array
          items:
            $ref: '#/components/schemas/ProjectRiskClassificationDTO'
    ProjectRiskClassificationDTO:
      type: object
      properties:
        uuid:
          type: string
        name:
          type: string
        category:
          type: string
          description: Classification category
          example: PII
        confidence:
          type: number
          description: Confidence score for the category
          format: double
          example: 0.9
        group:
          type: string
          description: Group the category belongs to
          example: Sensitive Data
        filename:
          type: string
          description: File the evidence was found in
          example: /some/filename.java
        evidenceItems:
          type: array
          description: Evidence items found in the file supporting the classification
          items:
            type: string
            description: Evidence items found in the file supporting the classification
    DWRResponseBase:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
  securitySchemes:
    bearer-key:
      type: http
      description: JWT token Bearer
      scheme: bearer
      bearerFormat: JWT