openapi: 3.0.1
info:
  title: Network Api
  version: 4.17.0-9-SNAPSHOT
servers:
- description: Generated server url
  url: https://api.uat.btx.fr.banqup.com/network
- description: Generated server url
  url: https://api.uat.btx.eu.banqup.com/network
tags:
- name: Connect (Internal)
  description: Resource to manage connectors
- name: Intake Api (Internal)
  description: Resource to handle file manipulations.
- name: Peppol Connector
  description: Resource to manage peppol connectors
- name: File Connector (Internal)
  description: Resource to manage file operations.
paths:
  /connect/v1/connectors/peppol/search:
    post:
      tags:
      - Peppol Connector
      summary: Search
      description: "<div class='my-preview'><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Lookup the 'entity' referrenced by the given 'connectionId' in the Peppol
        Network. It uses global identifiers from the connection. <br/> Scope: []"
      operationId: search
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
        required: true
      responses:
        '200':
          description: Found peppol participant ids
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
components:
  schemas:
    IntakeResponse:
      type: object
      properties:
        uploadId:
          type: integer
          format: int64
    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
    AddConnectorRequest:
      required:
      - entityId
      - spaceId
      type: object
      properties:
        spaceId:
          type: string
          description: Space Id
          format: uuid
          example: 12edcc6b-adec-4bf3-bdb6-dfc9f53f24c7
        entityId:
          type: string
          description: Entity Id
          format: uuid
          example: b168f25b-af6a-4c5e-bf8d-20f2de73b903
        extensionId:
          type: string
          description: Extension Id
          format: uuid
          example: 13b94df9-40ae-4a1c-bcea-8eb90e345853
    SearchRequest:
      required:
      - connectionId
      - spaceId
      type: object
      properties:
        spaceId:
          title: Space Identifier
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          description: A unique identifier for the space. This is typically a UUID
            used to specify the space where the search is conducted.
          format: uuid
          example: 12edcc6b-adec-4bf3-bdb6-dfc9f53f24c7
        connectionId:
          title: Connection Identifier
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          description: A unique identifier for the connection. This UUID is used to
            identify the specific connection for which the search is performed.
          format: uuid
          example: b168f25b-af6a-4c5e-bf8d-20f2de73b903
    SearchResponse:
      type: object
      properties:
        peppolParticipantIds:
          title: Peppol Participant Identifiers
          type: array
          description: A list of Peppol participant identifiers of the connection
            within Peppol Network
          example:
          - 0088:123456789
          - 0088:987654321
          items:
            title: Peppol Participant Identifiers
            type: string
            description: A list of Peppol participant identifiers of the connection
              within Peppol Network
            example: '["0088:123456789","0088:987654321"]'
    ProcessFileRequest:
      required:
      - fileId
      - spaceId
      type: object
      properties:
        spaceId:
          title: Space Identifier
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          description: Unique identifier for the space. This is typically a UUID that
            is used to specify the space in which the file is located.
          format: uuid
          example: 12edcc6b-adec-4bf3-bdb6-dfc9f53f24c7
        fileId:
          title: Space File Identifier
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          description: Unique identifier for the file. This is typically a UUID that
            represents the specific file being processed.
          format: uuid
          example: b168f25b-af6a-4c5e-bf8d-20f2de73b903
