openapi: 3.2.0
info:
  title: Hotel Operations ARA - Preview Submit Post Preview Submit API
  description: This API is used to submit a preview request for ARA room assignment.
  version: 1.0.0
tags:
- name: PostPreviewSubmit
paths:
  /v1/hotelops/ara/preview-submit:
    post:
      summary: ARA Preview Submit invocation
      description: Submits a preview request for ARA room assignment processing.
      tags:
      - PostPreviewSubmit
      parameters:
      - name: correlation-id
        in: header
        required: true
        description: 'An UUID used to correlate or connect multiple requests across a single event in a functional flow. This is useful for cross-system telemetry.

          '
        schema:
          type: string
      - name: client-id
        in: header
        description: Client ID - ARA etc.
        example: ARA
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewSubmitRequest'
            examples:
              example1:
                $ref: '#/components/examples/Example-PreviewSubmit-Request'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: string
              examples:
                example1:
                  $ref: '#/components/examples/Example-S1-PreviewSubmit-Success-Response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                example1:
                  $ref: '#/components/examples/Example-BadRequestError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                example1:
                  $ref: '#/components/examples/Example-UnprocessableEntityError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                example1:
                  $ref: '#/components/examples/Example-InternalServerError'
components:
  examples:
    Example-S1-PreviewSubmit-Success-Response:
      summary: Preview Submit Success Response
      value: Preview submit request processed successfully
    Example-PreviewSubmit-Request:
      summary: Preview Submit Request
      value:
        propertyCode: ABCDE
        araRunId: run-12345
        action: SUBMIT
    Example-UnprocessableEntityError:
      summary: Unprocessable Entity Error Returned from the API
      value:
        errors:
        - errorCode: UNPROCESSABLE_ENTITY
          errorMsg: Property not enabled for ARA
          source: hotelops-hint-room-assignment-pms-adapter
          fields:
          - key: propertyCode
            value: ABCDE
          timestamp: '2023-08-25T06:58:53.258+00:00'
          path: /v1/hotelops/ara/preview-submit
    Example-BadRequestError:
      summary: Bad Request Error Returned from the API
      value:
        errors:
        - errorCode: BAD_REQUEST
          errorMsg: Invalid request body
          source: hotelops-hint-room-assignment-pms-adapter
          fields:
          - key: propertyCode
            value: ''
          timestamp: '2023-08-25T06:58:53.258+00:00'
          path: /v1/hotelops/ara/preview-submit
    Example-InternalServerError:
      summary: Internal Server Error Returned from the API
      value:
        errors:
        - errorCode: INTERNAL_SERVER_ERROR
          errorMsg: Please try again later
          source: hotelops-hint-room-assignment-pms-adapter
          timestamp: '2023-08-25T06:58:53.258+00:00'
          path: /v1/hotelops/ara/preview-submit
  schemas:
    ErrorResponse:
      type: object
      description: The encompassing array of error(s) that can be returned when an issue occurs while processing a Resource via API.
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    PreviewSubmitRequest:
      required:
      - propertyCode
      - araRunId
      - action
      type: object
      properties:
        propertyCode:
          type: string
          description: The property code identifier
          example: ABCDE
        araRunId:
          type: string
          description: The ARA run ID
          example: run-12345
        action:
          type: string
          description: The action to perform
          example: SUBMIT
    ErrorField:
      required:
      - key
      - value
      type: object
      description: A reference to a field within an Error
      properties:
        key:
          type: string
          description: The name of the field where the error occurred.
          example: propertyCode
        value:
          type: string
          description: The value that was provided within the field.
          example: field value
        pattern:
          type:
          - string
          - 'null'
          description: If there is a pattern associated to the field, then that pattern can be provided for reference.
          example: /^[a-zA-Z]{5}$/
    Error:
      required:
      - errorCode
      - errorMsg
      - timestamp
      type: object
      description: An error occurred
      properties:
        errorCode:
          type: string
          description: The error code of this particular error that can be used to uniquely identify what went wrong with the request.
          example: ARAXXX
        errorMsg:
          type: string
          description: The message associated with the error code that was returned that provides more details describing the actual error.
          example: error message
        source:
          type:
          - string
          - 'null'
          description: The optionally provided source of the error.
          example: hotelops-hint-room-assignment-pms-adapter
        fields:
          type:
          - array
          - 'null'
          description: An optional array that can be used to distinctly identify the field(s) that caused the error.
          items:
            $ref: '#/components/schemas/ErrorField'
        timestamp:
          type: string
          description: The time at which the error occurred.
          format: date-time
          example: '2023-05-10T16:33:33Z'
        path:
          type:
          - string
          - 'null'
          description: The path associated with the generated error.
          example: /v1/hotelops/ara/preview-submit