openapi: 3.0.3
info:
  version: v1.0.3
  title: LE-KO User interations on BE API
  license:
    name: private
    url: https:/le-ko.deggex.com
  contact:
    email: denis@deggex.awsapps.com
  description: LE-KO User interations API
servers:
  - url: https://booking-{env}.le-ko.deggex.com/{basePath}
    description: User interations API
    variables:
      basePath:
        default: v1
      env:
        default: dev
security:
  - bearerHttpAuthentication: []
tags:
  - name: interactions
    description: User interations API.
paths:
  /interactions:
    post:
      operationId: createInteraction
      summary: Create new User Interaction
      description: ✨ Create new User Interaction
      tags:
        - interactions
      parameters:
        - $ref: '#/components/parameters/TraceparentHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InteractionInput'
      responses:
        '200':
          description: User Interaction has been created
          content:
            application/json:
              schema:
                type: object
                required:
                  - interactionId
                properties:
                  interactionId:
                    $ref: '#/components/schemas/InteractionId'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  securitySchemes:
    bearerHttpAuthentication:
      description: Bearer token using a JWT
      type: http
      scheme: bearer
      bearerFormat: JWT
  parameters:
    TraceparentHeader:
      name: traceparent
      in: header
      required: false
      description: W3C Trace Context traceparent header for request tracing
      schema:
        type: string
        pattern: ^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$
        example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
  schemas:
    UserId:
      type: string
      example: 00000000-0000-1000-9000-55f01dda9dd0
      description: User ID
      format: uuid
    InteractionInput:
      type: object
      required:
        - userId
        - eventName
        - details
      properties:
        userId:
          $ref: '#/components/schemas/UserId'
        eventName:
          type: string
        details:
          type: object
          additionalProperties: true
    InteractionId:
      type: string
      example: 4b72d209-debd-45e1-93cc-7640bf7d39bf
      description: User Interaction UUID
      format: uuid
      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}$
    Error:
      type: object
      required:
        - code
        - message
        - endpoint
        - requestId
      properties:
        code:
          type: string
          description: Error unique code
          enum:
            - validation
            - internal
            - oops
            - unexpected
            - tooManyRequests
            - notFound
            - unauthorized
            - forbidden
        message:
          type: string
          description: Error message
        endpoint:
          type: string
        requestId:
          type: string
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'