api.yaml

---
openapi: 3.0.0
info:
  description: "This is an api for getting a message that will tell the receiver information on when the next trash pickup is."
  version: "1.0.0"
  title: "Grouch Trash Message Service"
  contact:
    email: "matthew.js.porter@gmail.com"
servers:
  - url: https://d9lz2a1tq2.execute-api.us-east-1.amazonaws.com/Prod
  - url: http://localhost:3000
paths:
  /v1/message:
    get:
      tags:
        - "message"
      summary: "Get a message from grouch trash service about when trash pickup is"
      description: ""
      operationId: "getMessage"

      responses:
        200:
          description: "successful operation"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Message"
        401:
          description: "Unauthorized"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        403:
          description: "Forbidden"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        500:
          description: "Server Error"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

      security:
        - authorizer: []
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: 200
        uri:
          Fn::Join:
            - ""
            - - Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/
              - Fn::ImportValue: grouch-message-function-GrouchMessageFunction
              - /invocations
        passthroughBehavior: when_no_match
        httpMethod: POST
        type: aws_proxy

components:
  securitySchemes:
    authorizer:
      type: apiKey
      name: 'X-API-KEY'
      in: header

      x-amazon-apigateway-authtype: token
      x-amazon-apigateway-authorizer:
        type: token
        authorizerUri:
          Fn::Join:
            - ""
            -
              - Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/
              - Fn::ImportValue: grouch-auth-function-AuthFunction
              - /invocations
        authorizerCredentials:
          Fn::Sub: ${AuthRole.Arn}
  schemas:
    Message:
      type: "object"
      required:
        - "text"
      properties:
        text:
          type: "string"
    Error:
      type: "object"
      required:
        - "message"
      properties:
        message:
          type: "string"