openapi: 3.0.1
info:
  title: documents_integration API
  description: Merged OpenAPI spec for documents_integration domain
  version: 1.0.0
servers:
- url: https://api.uat.btx.fr.banqup.com/documents/integration
paths: {}
components:
  schemas:
    ApiErrorProblemDetail:
      required:
      - error
      - requestId
      - timestamp
      type: object
      properties:
        status:
          type: integer
          format: int32
        error:
          type: string
        requestId:
          type: string
        timestamp:
          type: string
          format: date-time
        type:
          type: string
          format: uri
        title:
          type: string
        detail:
          type: string
        instance:
          type: string
          format: uri
        problems:
          type: array
          items:
            $ref: '#/components/schemas/NestedProblem'
        properties:
          type: object
          additionalProperties:
            type: object
    NestedProblem:
      required:
      - detail
      - error
      - title
      type: object
      properties:
        error:
          type: string
        title:
          type: string
        detail:
          type: string
        type:
          type: string
          format: uri
    DocumentDeliveryStatusError:
      required:
      - message
      - retry
      type: object
      properties:
        message:
          type: string
        retry:
          type: boolean
    DocumentDeliveryStatusRequest:
      required:
      - documentId
      - executionId
      - spaceId
      - status
      type: object
      properties:
        executionId:
          type: string
          format: uuid
        spaceId:
          type: string
          format: uuid
        documentId:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - SHARED
          - ERROR
        error:
          $ref: '#/components/schemas/DocumentDeliveryStatusError'
    DocumentUpdatedEvent:
      required:
      - data
      - type
      type: object
      properties:
        category:
          type: string
        type:
          type: string
        resourceId:
          type: string
          format: uuid
        scope:
          type: string
        data:
          $ref: '#/components/schemas/DocumentUpdatedEventData'
    DocumentUpdatedEventData:
      required:
      - documentId
      - spaceId
      type: object
      properties:
        spaceId:
          type: string
          format: uuid
        documentId:
          type: string
          format: uuid
        folder:
          type: string
        status:
          type: object
          additionalProperties:
            type: object
    ManageExtensionRequest:
      required:
      - spaceId
      type: object
      properties:
        spaceId:
          type: string
          description: The space identifier
          format: uuid
    ExtensionStatusDto:
      required:
      - status
      type: object
      properties:
        status:
          pattern: ACTIVE|INACTIVE|PENDING|ERROR
          type: string
          description: The status of the extension
    ExtensionSettingDto:
      type: object
      properties:
        name:
          type: string
        value:
          type: object
    ConfigureExtensionRequest:
      required:
      - settings
      type: object
      properties:
        settings:
          $ref: '#/components/schemas/ConfigureExtensionSettingDto'
    ConfigureExtensionSettingDto:
      required:
      - spaceId
      type: object
      properties:
        spaceId:
          type: string
          description: The space identifier
          format: uuid
        localeCode:
          type: string
        redirectUrl:
          type: string
        settings:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionSettingDto'
    ConfigureClientExtensionRequest:
      required:
      - settings
      type: object
      properties:
        settings:
          $ref: '#/components/schemas/ConfigureClientExtensionSettingDto'
    ConfigureClientExtensionSettingDto:
      required:
      - clientId
      - spaceId
      type: object
      properties:
        spaceId:
          type: string
          description: The space identifier
          format: uuid
        localeCode:
          type: string
        redirectUrl:
          type: string
        settings:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionSettingDto'
        clientId:
          type: string
          description: The client identifier
          format: uuid
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.uat.btx.fr.banqup.com/oauth2/client_credential/gettoken
          scopes:
            info: Scopes are endpoint-specific, see each endpoint for required scope.
        authorizationCode:
          authorizationUrl: https://api.uat.btx.fr.banqup.com/oauth2/auth
          tokenUrl: https://api.uat.btx.fr.banqup.com/oauth2/token
          scopes:
            info: Scopes are endpoint-specific, see each endpoint for required scope.
tags: []
