Amazon API Gateway Routes API

openapi: 3.1.0
info:
  title: Amazon API Gateway Management ApiKeys Routes API
  description: The API Gateway Management API allows backend services to send messages to connected clients of a deployed WebSocket API and to disconnect clients. Requests are made against the deployed stage's callback URL.
  version: '2018-11-29'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  termsOfService: https://aws.amazon.com/service-terms/
servers:
- url: https://{api_id}.execute-api.{region}.amazonaws.com/{stage}
  description: WebSocket API callback endpoint
  variables:
    api_id:
      default: example
      description: WebSocket API identifier
    region:
      default: us-east-1
      description: AWS region
    stage:
      default: prod
      description: Deployment stage name
security:
- sigv4: []
tags:
- name: Routes
  description: Manage routes within an API
paths:
  /v2/apis/{api_id}/routes:
    parameters:
    - $ref: '#/components/parameters/ApiId'
    get:
      operationId: getRoutes
      summary: Amazon API Gateway List Routes
      description: Gets a collection of routes for an API.
      tags:
      - Routes
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Routes'
              examples:
                getRoutes200Example:
                  summary: Default getRoutes 200 response
                  x-microcks-default: true
                  value:
                    Items:
                    - example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createRoute
      summary: Amazon API Gateway Create a Route
      description: Creates a route for an API.
      tags:
      - Routes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRouteRequest'
            examples:
              createRouteRequestExample:
                summary: Default createRoute request
                x-microcks-default: true
                value:
                  RouteKey: example-value
                  Target: example-value
                  AuthorizationType: example-value
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
              examples:
                createRoute201Example:
                  summary: Default createRoute 201 response
                  x-microcks-default: true
                  value:
                    RouteId: abc123
                    RouteKey: example-value
                    Target: example-value
                    AuthorizationType: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateRouteRequest:
      type: object
      required:
      - RouteKey
      properties:
        RouteKey:
          type: string
          description: Route key for the new route.
          example: example-value
        Target:
          type: string
          description: Integration target reference.
          example: example-value
        AuthorizationType:
          type: string
          description: Authorization type for the route.
          example: example-value
    Routes:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/Route'
          example:
          - example-value
    Route:
      type: object
      properties:
        RouteId:
          type: string
          description: Route identifier.
          example: abc123
        RouteKey:
          type: string
          description: Route key (e.g. "GET /items" or "$connect").
          example: example-value
        Target:
          type: string
          description: Integration target reference.
          example: example-value
        AuthorizationType:
          type: string
          description: Authorization type for the route.
          example: example-value
  parameters:
    ApiId:
      name: api_id
      in: path
      required: true
      description: API identifier.
      schema:
        type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed request.
externalDocs:
  description: Amazon API Gateway Management API Reference
  url: https://docs.aws.amazon.com/apigatewaymanagementapi/latest/reference/Welcome.html