openapi: 3.2.0
info:
  title: Fenergo Nebula Business Metrics Command Qa Findings API
  description: '**Business Metrics Command API**:


    Business Metrics Command API provides endpoints in order to manage and configure all related models and their versions.'
  version: 1.0.0
servers:
- url: /businessmetricscommand
security:
- Bearer: []
tags:
- name: QaFindings
paths:
  /api/qafindings:
    patch:
      tags:
      - QaFindings
      summary: Update a QA finding's status (and optionally severity) for the current tenant
      description: 'Updates a previously-ingested QA finding — status must be one of open/in review/resolved


        The finding must already exist (ingested via the Agent Value Story query) — this is update-only


        Required permissions:

        Following permissions are required: ValueStoryEdit'
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      requestBody:
        description: Update QA finding status request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateQaFindingStatusRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateQaFindingStatusRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateQaFindingStatusRequestDtoServiceRequest'
        required: true
      responses:
        '204':
          description: Success. The finding was updated
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. No finding exists with the given Id for this tenant
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      operationId: patchApiQafindings
      x-operation-id-source: derived
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    UpdateQaFindingStatusRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateQaFindingStatusRequestDto'
      additionalProperties: false
    UpdateQaFindingStatusRequestDto:
      type: object
      properties:
        findingId:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        severity:
          type:
          - string
          - 'null'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header