Amazon API Gateway Resources API

Manage resources within a REST API

Documentation

Specifications

Other Resources

OpenAPI Specification

aws-api-gateway-resources-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon API Gateway Management ApiKeys Resources 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: Resources
  description: Manage resources within a REST API
paths:
  /restapis/{restapi_id}/resources:
    parameters:
    - $ref: '#/components/parameters/RestApiId'
    get:
      operationId: getResources
      summary: Amazon API Gateway List Resources
      description: Lists the Resource resources for a RestApi.
      tags:
      - Resources
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resources'
              examples:
                getResources200Example:
                  summary: Default getResources 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    RestApiId:
      name: restapi_id
      in: path
      required: true
      description: Identifier of the RestApi resource.
      schema:
        type: string
  schemas:
    Resource:
      type: object
      properties:
        id:
          type: string
          description: Resource identifier.
          example: abc123
        parentId:
          type: string
          description: Parent resource identifier.
          example: abc123
        pathPart:
          type: string
          description: Last path segment for this resource.
          example: example-value
        path:
          type: string
          description: Full path of the resource.
          example: example-value
    Resources:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          example:
          - example-value
  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