openapi: 3.2.0
info:
  title: Policy Agent Requirements API
  description: API to manage Policy Agent operations
  version: '1.0'
servers:
- url: /policyagent
security:
- Bearer: []
tags:
- name: Requirements
paths:
  /api/v1/extraction/{extractionId}/document/{documentId}/compare:
    get:
      tags:
      - Requirements
      summary: Compare Extracted Requirements with Policy Fields
      description: Returns a pre-computed comparison between extracted requirements and policy fields, with the reviewer's latest persisted overlay merged over each row.
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReviewedComparisonItem'
        '404':
          description: Not Found
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1ExtractionByExtractionIdDocumentByDocumentIdCompare
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/compare/export:
    post:
      tags:
      - Requirements
      summary: Export Policy Comparison to Excel
      description: Generates an Excel export of the stored comparison results and returns a presigned download URL.
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportComparisonResponse'
        '404':
          description: Not Found
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: postApiV1ExtractionByExtractionIdDocumentByDocumentIdCompareExport
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/requirements/export:
    post:
      tags:
      - Requirements
      summary: Export Extracted Requirements to Excel
      description: Generates an Excel export of the extracted policy requirements and returns a presigned download URL.
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportRequirementsResponse'
        '404':
          description: Not Found
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: postApiV1ExtractionByExtractionIdDocumentByDocumentIdRequirementsExport
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/requirements:
    get:
      tags:
      - Requirements
      summary: Get All Extracted Requirements
      description: Endpoint for getting all extracted requirements from S3 by extraction id
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExtractedRequirementsResponse'
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1ExtractionByExtractionIdRequirements
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/requirements:
    get:
      tags:
      - Requirements
      summary: Get Extracted Requirements
      description: Endpoint for getting extracted requirements from S3 by extraction id and document id
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractedRequirementsResponse'
        '404':
          description: Not Found
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1ExtractionByExtractionIdDocumentByDocumentIdRequirements
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/push-policy-draft/{businessProcessId}:
    get:
      tags:
      - Requirements
      summary: Get Push Status
      description: Returns the status and per-item outcomes of a push-to-workspace business process.
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: businessProcessId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushStatusResponse'
        '404':
          description: Not Found
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1ExtractionByExtractionIdDocumentByDocumentIdPushPolicyDraftByBusinessProcessId
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/requirements/{comparisonId}/history:
    get:
      tags:
      - Requirements
      summary: Requirement Review History
      description: Returns the full version series (audit trail) for a comparison row with computed before/after diffs.
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: comparisonId
        in: path
        required: true
        schema:
          type: string
      - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRequirementReviewHistoryResponse'
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: getApiV1ExtractionByExtractionIdDocumentByDocumentIdRequirementsByComparisonIdHistory
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/requirements/{comparisonId}/keep-fenergo-value:
    post:
      tags:
      - Requirements
      summary: Keep the Fenergo Value for a Requirement Review
      description: Appends a FenergoValueKept version so the comparison row is decided but excluded from the future push-to-workspace payload. Any prior reviewer edits are discarded — the row reads its baseline Fenergo values.
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: comparisonId
        in: path
        required: true
        schema:
          type: string
      - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeepFenergoValueResponse'
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: postApiV1ExtractionByExtractionIdDocumentByDocumentIdRequirementsByComparisonIdKeepFenergoValue
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/push-policy-draft:
    post:
      tags:
      - Requirements
      summary: Push Approved Requirements to a Policy Workspace
      description: 'Dispatches the approved/pre-accepted comparison rows for one document to a Fenergo Policy workspace. Create-only: rows that already carry a target Policy id are included as Skipped.'
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PushRequirementsApiRequest'
        required: true
      responses:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '404':
          description: Not Found
        '409':
          description: Conflict
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushRequirementsResponse'
      operationId: postApiV1ExtractionByExtractionIdDocumentByDocumentIdPushPolicyDraft
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/requirements/{comparisonId}/reset:
    post:
      tags:
      - Requirements
      summary: Reset a Requirement Review
      description: Appends a Reset tombstone so the comparison row falls back to its S3 baseline.
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: comparisonId
        in: path
        required: true
        schema:
          type: string
      - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetRequirementReviewResponse'
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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
      operationId: postApiV1ExtractionByExtractionIdDocumentByDocumentIdRequirementsByComparisonIdReset
      x-operation-id-source: derived
  /api/v1/extraction/{extractionId}/document/{documentId}/requirements/{comparisonId}/review:
    put:
      tags:
      - Requirements
      summary: Update and Approve a Requirement Review
      description: Persists a reviewer's edits to a comparison row as a new, version-numbered overlay row.
      parameters:
      - name: extractionId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: comparisonId
        in: path
        required: true
        schema:
          type: string
      - 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
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SaveRequirementReviewApiRequest'
        required: true
      responses:
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '409':
          description: Conflict
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveRequirementReviewResponse'
      operationId: putApiV1ExtractionByExtractionIdDocumentByDocumentIdRequirementsByComparisonIdReview
      x-operation-id-source: derived
components:
  schemas:
    ExportComparisonResponse:
      type: object
      properties:
        presignedUrl:
          type:
          - string
          - 'null'
      additionalProperties: false
    PushItemStatus:
      enum:
      - Pending
      - InProgress
      - Done
      - Error
      - Skipped
      type: string
    RequirementReviewDto:
      type: object
      properties:
        version:
          type: integer
          format: int32
        changeType:
          allOf:
          - $ref: '#/components/schemas/ReviewChangeType'
        mapping:
          allOf:
          - $ref: '#/components/schemas/RequirementMapping'
        mandatory:
          type:
          - boolean
          - 'null'
        requirementName:
          type:
          - string
          - 'null'
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            type: string
        notes:
          type:
          - string
          - 'null'
        fenergoTargetFieldId:
          type:
          - string
          - 'null'
        reviewedBy:
          type:
          - string
          - 'null'
        reviewedDate:
          type: string
          format: date-time
      additionalProperties: false
    RequirementFieldChange:
      type: object
      properties:
        field:
          type:
          - string
          - 'null'
        before:
          type:
          - string
          - 'null'
        after:
          type:
          - string
          - 'null'
      additionalProperties: false
    SaveRequirementReviewResponse:
      type: object
      properties:
        comparisonId:
          type:
          - string
          - 'null'
        version:
          type: integer
          format: int32
        review:
          allOf:
          - $ref: '#/components/schemas/RequirementReviewDto'
      additionalProperties: false
    ComparisonExtractedData:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
        fieldType:
          allOf:
          - $ref: '#/components/schemas/FieldTypeInfo'
        validationRules: {}
        documentRequirementName:
          type:
          - string
          - 'null'
        documentRequirementDescription:
          type:
          - string
          - 'null'
        relatedPartyName:
          type:
          - string
          - 'null'
        partyTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        relatedPartyEntityTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        uboThreshold:
          type:
          - number
          - 'null'
          format: double
        idvOn:
          type:
          - boolean
          - 'null'
        idvName:
          type:
          - string
          - 'null'
        idvTooltip:
          type:
          - string
          - 'null'
        idvValidationRules: {}
        targetEntities:
          type:
          - array
          - 'null'
          items:
            type: string
        description:
          type:
          - string
          - 'null'
        references:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ComparisonReference'
        jurisdictionNames:
          type:
          - array
          - 'null'
          items:
            type: string
        tooltipDescription:
          type:
          - string
          - 'null'
      additionalProperties: false
    PushItemDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        comparisonId:
          type:
          - string
          - 'null'
        requirementName:
          type:
          - string
          - 'null'
        commandName:
          type:
          - string
          - 'null'
        status:
          allOf:
          - $ref: '#/components/schemas/PushItemStatus'
        policyResourceId:
          type:
          - string
          - 'null'
          format: uuid
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    PushStatusResponse:
      type: object
      properties:
        businessProcessId:
          type: string
          format: uuid
        status:
          type:
          - string
          - 'null'
        totalCount:
          type: integer
          format: int32
        doneCount:
          type: integer
          format: int32
        errorCount:
          type: integer
          format: int32
        skippedCount:
          type: integer
          format: int32
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PushItemDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PushMessageDto'
      additionalProperties: false
    ExportRequirementsResponse:
      type: object
      properties:
        presignedUrl:
          type:
          - string
          - 'null'
      additionalProperties: false
    PageReferenceDto:
      type: object
      properties:
        visualPageNumber:
          type: integer
          format: int32
        physicalPageNumber:
          type: integer
          format: int32
      additionalProperties: false
    HttpValidationProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
        errors:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              type: string
      additionalProperties: {}
    KeepFenergoValueResponse:
      type: object
      properties:
        comparisonId:
          type:
          - string
          - 'null'
        version:
          type: integer
          format: int32
        review:
          allOf:
          - $ref: '#/components/schemas/RequirementReviewDto'
      additionalProperties: false
    SaveRequirementReviewApiRequest:
      type: object
      properties:
        mapping:
          allOf:
          - $ref: '#/components/schemas/RequirementMapping'
        mandatory:
          type: boolean
        requirementName:
          type:
          - string
          - 'null'
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            type: string
        notes:
          type:
          - string
          - 'null'
        fenergoTargetFieldId:
          type:
          - string
          - 'null'
      additionalProperties: false
    PolicyFieldClassification:
      enum:
      - PolicyField
      - DocumentRequirement
      - RelatedPartyRequirement
      type: string
    RequirementReviewHistoryEntry:
      type: object
      properties:
        version:
          type: integer
          format: int32
        changeType:
          allOf:
          - $ref: '#/components/schemas/ReviewChangeType'
        snapshot:
          allOf:
          - $ref: '#/components/schemas/RequirementReviewDto'
        reviewedBy:
          type:
          - string
          - 'null'
        reviewedDate:
          type: string
          format: date-time
        changes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RequirementFieldChange'
      additionalProperties: false
    ReviewChangeType:
      enum:
      - Approved
      - Reset
      - FenergoValueKept
      type: string
    PushMessageDto:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        messageType:
          type:
          - string
          - 'null'
      additionalProperties: false
    ConfidenceLevel:
      enum:
      - High
      - Medium
      - Low
      type: string
    ResetRequirementReviewResponse:
      type: object
      properties:
        comparisonId:
          type:
          - string
          - 'null'
        version:
          type:
          - integer
          - 'null'
          format: int32
        wasReset:
          type: boolean
      additionalProperties: false
    ComparisonItem:
      type: object
      properties:
        requirementType:
          allOf:
          - $ref: '#/components/schemas/RequirementType'
        comparisonId:
          type:
          - string
          - 'null'
        entityType:
          allOf:
          - $ref: '#/components/schemas/EntityType'
        pageReferences:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PageReferenceDto'
        policyExtractionId:
          type:
          - string
          - 'null'
        policyExtractionRequirementIds:
          type:
          - array
          - 'null'
          items:
            type: string
        policyAgentData:
          allOf:
          - $ref: '#/components/schemas/ComparisonAgentOutput'
        extractedData:
          allOf:
          - $ref: '#/components/schemas/ComparisonExtractedData'
        policyConfigData:
          allOf:
          - $ref: '#/components/schemas/ComparisonConfigData'
      additionalProperties: false
    EntityType:
      enum:
      - Individual
      - Company
      - Trust
      - Other
      - EntityGroup
      type: string
    ComparisonAgentOutput:
      type: object
      properties:
        comparisonSummary:
          type:
          - string
          - 'null'
        matchType:
          allOf:
          - $ref: '#/components/schemas/ComparisonMatchType'
        policyFieldClassification:
          allOf:
          - $ref: '#/components/schemas/PolicyFieldClassification'
      additionalProperties: false
    PushRequirementsApiRequest:
      type: object
      properties:
        entityType:
          type:
          - string
          - 'null'
        entityPolicyId:
          type: string
          format: uuid
        workspaceId:
          type: string
          format: uuid
      additionalProperties: false
    ComparisonMatchType:
      enum:
      - Exact
      - Equivalent
      - Different
      - FenergoPolicy
      - New
      type: string
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    FieldTypeInfo:
      type: object
      properties:
        fieldType:
          type:
          - string
          - 'null'
        fieldTypeId:
          type:
          - string
          - 'null'
      additionalProperties: false
    ReviewedComparisonItem:
      type: object
      properties:
        comparison:
          allOf:
          - $ref: '#/components/schemas/ComparisonItem'
        review:
          allOf:
          - $ref: '#/components/schemas/RequirementReviewDto'
      additionalProperties: false
    RequirementMapping:
      enum:
      - ClientSpecific
      - Equivalent
      type: string
    SimplifiedRequirement:
      type: object
      properties:
        requirementId:
          type:
          - string
          - 'null'
        requirementName:
          type:
          - string
          - 'null'
        requirementType:
          allOf:
          - $ref: '#/components/schemas/RequirementType'
        fieldType:
          type:
          - string
          - 'null'
        entityType:
          allOf:
          - $ref: '#/components/schemas/EntityType'
        confidenceLevel:
          allOf:
          - $ref: '#/components/schemas/ConfidenceLevel'
        confidenceExplanation:
          type:
          - string
          - 'null'
        applicableSubtypes:
          type:
          - array
          - 'null'
          items:
            type: string
        pageReferences:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PageReferenceDto'
        targetEntities:
          type:
          - array
          - 'null'
          items:
            type: string
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    ExtractedRequirementsResponse:
      type: object
      properties:
        documentId:
          type:
          - string
          - 'null'
        documentName:
          type:
          - string
          - 'null'
        version:
          type:
          - string
          - 'null'
        requirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SimplifiedRequirement'
      additionalProperties: false
    ComparisonReference:
      type: object
      properties:
        note:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
      additionalProperties: false
    RequirementType:
      enum:
      - PolicyField
      - Document
      - RelatedParty
      type: string
    ComparisonConfigData:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
        fieldType:
          allOf:
          - $ref: '#/components/schemas/FieldTypeInfo'
        validationRules: {}
        jurisdictionIds:
          type:
          - array
          - 'null'
          items:
            type: string
        entityPolicyId:
          type:
          - string
          - 'null'
        fieldId:
          type:
          - string
          - 'null'
        dataKey:
          type:
          - string
          - 'null'
        defaultValue:
          type:
          - string
          - 'null'
        order:
          type:
          - integer
          - 'null'
          format: int32
        lockDetails: {}
        documentRequirementName:
          type:
          - string
          - 'null'
        documentRequirementDescription:
          type:
          - string
          - 'null'
        acceptableDocumentTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        documentRequirementId:
          type:
          - string
          - 'null'
        documentRequirementVersion:
          type:
          - integer
          - 'null'
          format: int32
        relatedPartyName:
          type:
          - string
          - 'null'
        partyTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        relatedPartyEntityTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        uboThreshold:
          type:
          - number
          - 'null'
          format: double
        idvOn:
          type:
          - boolean
          - 'null'
        idvName:
          type:
          - string
          - 'null'
        idvTooltip:
          type:
          - string
          - 'null'
        idvValidationRules: {}
        relatedPartyRequirementId:
          type:
          - string
          - 'null'
        relatedPartyRequirementVersion:
          type:
          - integer
          - 'null'
          format: int32
        targetEntities:
          type:
          - array
          - 'null'
          items:
            type: string
        description:
          type:
          - string
          - 'null'
        references:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ComparisonReference'
        jurisdictionNames:
          type:
          - array
          - 'null'
          items:
            type: string
        tooltipDescription:
          type:
          - string
          - 'null'
        entityPolicyName:
          type:
          - string
          - 'null'
        categories:
          type:
          - array
          - 'null'
          items:
            type: string
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
    GetRequirementReviewHistoryResponse:
      type: object
      properties:
        comparisonId:
          type:
          - string
          - 'null'
        versions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RequirementReviewHistoryEntry'
      additionalProperties: false
    PushRequirementsResponse:
      type: object
      properties:
        businessProcessId:
          type: string
          format: uuid
        requirementCount:
          type: integer
          format: int32
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header