AlayaCare form submission outbox API

openapi: 3.2.0
info:
  title: Alayacare form submission outbox API
  version: '1.0'
servers:
- url: https://api.{env}.alayamarket.{region}/offers
  variables:
    env:
      description: The server environment.
      enum:
      - staging
      - sandbox
      - prod
      default: prod
    region:
      description: The server top-level domain indicating the region.
      enum:
      - ca
      - com
      - com.au
      default: ca
security:
- CognitoAuthorizer: []
tags:
- name: form submission outbox
paths:
  /v1/outbox/form_submissions/{form_submission_id}:
    parameters:
    - $ref: '#/components/parameters/FormSubmissionIdPathParam'
    get:
      tags:
      - form submission outbox
      description: "# Authorization\nRequired role: demand `org_admin` assigned to the referral \nassociated to the form submission.\n\n# Description\nRead a form submission.\n"
      responses:
        200:
          description: Successfully retrieved the form submission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboxFormSubmissionDetailResponse'
      x-amazon-apigateway-integration:
        uri:
          Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
        httpMethod: POST
        passthroughBehavior: when_no_match
        type: aws_proxy
  /v1/outbox/form_submissions/fields/{form_submission_field_id}/attachment/presigned:
    parameters:
    - $ref: '#/components/parameters/FormSubmissionFieldIdPathParam'
    get:
      tags:
      - form submission outbox
      description: "# Authorization\nRequired role: demand `org_admin` assigned to the referral \nassociated to the form submission.\n\n# Description\nGet the pre-signed URL for the file attached to a form submission field as\na demand organization.\n"
      responses:
        200:
          description: Successfully got the pre-signed URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgAdminFilePresignedDetailResponse'
      x-amazon-apigateway-integration:
        uri:
          Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
        httpMethod: POST
        passthroughBehavior: when_no_match
        type: aws_proxy
components:
  schemas:
    OutboxFormSubmissionDetailResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        form_template_id:
          type: string
          format: uuid
        form_template_outbox_id:
          type: string
          description: ID of the form template provided by the demand organization.
        client_id:
          type: string
          format: uuid
          description: ID of the client of the form submission.
        client_outbox_id:
          type: string
          description: ID of the client provided by the demand organization.
        service_id:
          type: string
          format: uuid
          description: ID of the service of the form submission.
        service_outbox_id:
          type: string
          description: ID of the service provided by the demand organization.
        visit_id:
          type: string
          format: uuid
          description: ID of the visit of the form submission.
        work_session_id:
          type: string
          format: uuid
          description: ID of the work session linked to the form submission.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/OutboxFormSubmissionFieldCore'
          minItems: 1
        hidden_fields:
          type: array
          items:
            $ref: '#/components/schemas/OutboxFormSubmissionHiddenFieldCore'
      required:
      - id
      - form_template_id
      - form_template_outbox_id
      - client_id
      - client_outbox_id
      - fields
    OrgAdminFilePresignedDetailResponse:
      properties:
        url:
          type: string
      required:
      - url
    OutboxFormSubmissionFieldCore:
      type: object
      properties:
        id:
          type: string
          format: uuid
        field_outbox_id:
          type: string
          description: ID of the form template field provided by the demand organization.
        value_type:
          type: string
          enum:
          - attachment
          - boolean
          - decimal
          - json
          - string
        value:
          type: string
      required:
      - id
      - field_outbox_id
      - value_type
      - value
    OutboxFormSubmissionHiddenFieldCore:
      type: object
      properties:
        id:
          type: string
          format: uuid
        field_outbox_id:
          type: string
          description: ID of the form template field provided by the demand organization.
      required:
      - id
      - field_outbox_id
  parameters:
    FormSubmissionFieldIdPathParam:
      in: path
      name: form_submission_field_id
      schema:
        type: string
        format: uuid
      required: true
      description: ID of a form submission field.
    FormSubmissionIdPathParam:
      in: path
      name: form_submission_id
      schema:
        type: string
        format: uuid
      required: true
      description: ID of a form submission.
  securitySchemes:
    CognitoAuthorizer:
      type: apiKey
      name: Authorization
      in: header
      x-amazon-apigateway-authtype: cognito_user_pools
      x-amazon-apigateway-authorizer:
        type: cognito_user_pools
        providerARNs:
        - Fn::Sub: '{{resolve:ssm:/${StackName}/${UserPoolArnSSMParameterName}}}'
x-amazon-apigateway-request-validators:
  body:
    validateRequestBody: true
    validateRequestParameters: false
  params:
    validateRequestBody: false
    validateRequestParameters: true
  params-and-body:
    validateRequestBody: true
    validateRequestParameters: true
x-amazon-apigateway-request-validator: params
x-amazon-apigateway-gateway-responses:
  BAD_REQUEST_BODY:
    statusCode: 400
    responseTemplates:
      application/json: '{"message": $context.error.messageString, "description": "$context.error.validationErrorString"}'