oai

gistfile1.txt

{
  "openapi": "3.0.0",
  "info": {
    "title": "Survey API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://xu2ft52u84.execute-api.eu-central-1.amazonaws.com/dev",
      "description": "Local"
    }
  ],
  "paths": {
    "/survey-responses": {
      "post": {
        "operationId": "getUserCertificates",
        "requestBody": {
          "description": "The survey reposne data",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SurveyReponse"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "User certificates successfully returned"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "x-api-key": {
        "in": "header",
        "name": "x-api-key",
        "schema": {
          "type": "string"
        },
        "description": "The api key which can be retrieved from AWS Secretsmanager"
      }
    },
    "schemas": {
      "SurveyReponse": {
        "type": "object",
        "properties": {
          "externalId": {
            "type": "string",
            "description": "The unique survey response id in the survey tool",
            "example": "254a916d-69ed-40c4-8017-da2bca445a79"
          },
          "externalSurveyToolId": {
            "type": "string",
            "enum": [
              "netigate",
              "customer-voice"
            ],
            "description": "The key of the survey tool where the response was created",
            "example": "netigate"
          },
          "submitDate": {
            "type": "string",
            "format": "date-time"
          },
          "eventId": {
            "type": "string",
            "description": "The event id for which the survey was submitted",
            "example": 61278986
          },
          "email": {
            "type": "string",
            "description": "The participant's email address",
            "example": "mail@example.org"
          },
          "name": {
            "type": "string",
            "description": "The participant's name",
            "example": "Max Power"
          },
          "phoneNumber": {
            "type": "string",
            "description": "The participant's phone number",
            "example": "+1 555 314159265"
          },
          "company": {
            "type": "string",
            "description": "The participant's company name",
            "example": "ACME"
          },
          "answers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SurveyReponseAnswer"
            }
          }
        }
      },
      "SurveyReponseAnswer": {
        "type": "object",
        "properties": {
          "externalId": {
            "type": "string",
            "description": "The unique answer id in the survey tool",
            "example": "67fc53fe-8011-4bb5-9e29-ccdd00c79571"
          },
          "questionType": {
            "type": "string",
            "description": "The type of question",
            "enum": [
              "instructor-has-professional-expertise",
              "instructor-participants-needs",
              "instructor-quality-of-topic-communication",
              "instructor-methods-matched-topics",
              "content-relevant-for-my-work",
              "custom"
            ]
          },
          "questionText": {
            "type": "string",
            "description": "The question text",
            "example": "Die Inhalte sind für meine Arbeit relevant"
          },
          "answerValue": {
            "type": "string",
            "description": "The value of the answer",
            "example": "Trifft voll zu"
          }
        }
      }
    }
  }
}