openapi: 3.0.1
info:
  title: HAL API Service
  description: |
    # The HAL API services provides the following features
    - Gets organization account information
    - Gets payer and unit information per acccount
    ### Release Notes
    v1.0.0
    - Initial API doc release
  version: 1.0.0
  contact:
    email: io-hal-support@pearson.com
  license:
    name: Pearson Proprietary
    url: 'https://pearsoneducationinc.sharepoint.com/sites/GRPTechOpsPearsonCloudServices/_layouts/15/stream.aspx?id=%2Fsites%2FGRPTechOpsPearsonCloudServices%2FShared%20Documents%2FPCM%20Portal%2FHAL%20Widget%20Tutorial%2Emp4'
servers:
  - url: 'https://api.pearsoncloudmanagement.com/hal'
    description: Production HAL API
  - url: 'https://api-dev.pearsoncloudmanagement.com/hal'
    description: Development HAL API
  - url: 'https://localhost:3000'
    description: Development HAL API
tags:
  - name: accounts
    description: Information about accounts and organizations
    externalDocs:
      description: Accounts Documentation
      url: 'https://pearsoneducationinc.sharepoint.com/sites/GRPTechOpsPearsonCloudServices/_layouts/15/stream.aspx?id=%2Fsites%2FGRPTechOpsPearsonCloudServices%2FShared%20Documents%2FPCM%20Portal%2FHAL%20Widget%20Tutorial%2Emp4'
  - name: payers
    description: Information about payers for accounts and organizations
    externalDocs:
      description: Payers Documentation
      url: 'https://pearsoneducationinc.sharepoint.com/sites/GRPTechOpsPearsonCloudServices/_layouts/15/stream.aspx?id=%2Fsites%2FGRPTechOpsPearsonCloudServices%2FShared%20Documents%2FPCM%20Portal%2FHAL%20Widget%20Tutorial%2Emp4'
paths:
  /:
    get:
      summary: API landing page
      operationId: APILandingPage
      responses:
        '200':
          description: Default 200 response for CORS method
          headers:
            Content-Type:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Headers:
              schema:
                type: string
          content: {}
        '404':
          description: API landing page not found
          headers:
            Content-Type:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Headers:
              schema:
                type: string
          content: {}
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: '200'
            responseParameters:
              method.response.header.Content-Type: '''text/html'''
              method.response.header.Access-Control-Allow-Headers: '''Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token,Api-Auth-Token'''
              method.response.header.Access-Control-Allow-Methods: '''DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'''
              method.response.header.Access-Control-Allow-Origin: '''http://localhost:3000'''
            responseTemplates:
              text/html: |
                <!DOCTYPE html> <html lang="en">
                  <head>
                    <meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 charecters -->
                    <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
                  </head>
                  <body>
                    <!-- Swagger build propagates info.version. Change the version in openapi.yaml, not here. v0.0.0 is a placeholder. -->
                    <rapi-doc spec-url = "https://downloads.pearsoncloudmanagement.com/hal/$context.stage/api/openapi_bundled_v1.0.0.yaml"> </rapi-doc>
                  </body>
                </html>
        requestTemplates:
          application/json: '{"statusCode": 200}'
        passthroughBehavior: when_no_match
        type: mock
components: {}
