openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: .io Engineering Platform Amazon API Gateway 2014 11 13 Apis API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Apis
paths:
  /apis:
    parameters:
    - $ref: '#/components/parameters/workspaceIdQueryTrue'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get all APIs
      description: Gets information about all APIs in a workspace.
      operationId: getApis
      tags:
      - Apis
      responses:
        '200':
          $ref: '#/components/responses/getApis'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/workspaceIdQueryTrue'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/apiDescription'
      - $ref: '#/components/parameters/limit'
    post:
      summary: APIs.io Engineering Platform Create an API
      description: Creates an API.
      operationId: createApi
      tags:
      - Apis
      requestBody:
        $ref: '#/components/requestBodies/createApi'
      responses:
        '200':
          $ref: '#/components/responses/createApi'
        '400':
          $ref: '#/components/responses/workspace400ErrorParamMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/api403ErrorForbidden'
                - $ref: '#/components/schemas/api403ErrorLimitReached'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/api403ErrorForbidden'
                API Limit Reached:
                  $ref: '#/components/examples/api403ErrorLimitReached'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/workspace404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get an API
      description: 'Gets information about an API.


        **Note:**


        - Git-connected APIs will only return the `versions` and `gitInfo` query responses. This is because schema and collection information is stored in the connected Git repository. The `gitInfo` object only lists the repository and folder locations of the files.

        - API viewers can only use the `versions` option in the `include` query parameter.

        '
      operationId: getApi
      tags:
      - Apis
      responses:
        '200':
          $ref: '#/components/responses/getApi'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/apiInclude'
    put:
      summary: APIs.io Engineering Platform Update an API
      description: Updates an API.
      operationId: updateApi
      tags:
      - Apis
      requestBody:
        $ref: '#/components/requestBodies/updateApi'
      responses:
        '200':
          $ref: '#/components/responses/updateApi'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete an API
      description: Deletes an API. On success, this returns an HTTP `204 No Content` response.
      operationId: deleteApi
      tags:
      - Apis
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}/tasks/{taskId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/apiTaskId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get status of an asynchronous task
      description: Gets the status of an asynchronous task.
      operationId: getStatusOfAnAsyncTask
      tags:
      - Apis
      responses:
        '200':
          $ref: '#/components/responses/getStatusOfAnAsyncTask'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiVersion400ErrorInvalidParam'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Invalid Parameter:
                  $ref: '#/components/examples/apiVersion400ErrorInvalidParam'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/taskNotFound'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}/versions/{versionId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/apiVersionId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get a version
      description: 'Gets information about an API version.


        **Note:**


        - For API editors, this endpoint returns an HTTP `302 Found` status code when the version status is pending. It also returns the `/apis/{apiId}/tasks/{taskId}` task status response header.

        - For API viewers, this endpoint returns an HTTP `404 Not Found` when the version status is pending.

        '
      operationId: getApiVersion
      tags:
      - Apis
      responses:
        '200':
          $ref: '#/components/responses/getApiVersion'
        '302':
          description: Found
          headers:
            Location:
              $ref: '#/components/headers/Location'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/apiVersion404ErrorNotFound'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  examples:
    taskNotFound:
      value:
        detail: Parameter, taskId is in an invalid format.
        title: The specified parameter is in an invalid format
        type: invalidParamsError
    v10HeaderMissing:
      value:
        name: instanceNotFoundError
        message: API not found. For v10 and later APIs, ensure that your request sends the "application/vnd.api.v10+json" Accept header.
    apiVersion400ErrorInvalidParam:
      value:
        type: invalidParamsError
        title: The specified parameter is in an invalid format
        detail: Parameter, taskId is in an invalid format.
    apiVersion404ErrorNotFound:
      value:
        type: VersionNotFound
        title: API Version not found.
        details: We could not find the API Version you are looking for.
    api403ErrorLimitReached:
      value:
        type: limitReachedError
        title: You've reached the API limit
        message: You can create up to 3 APIs on your current plan.
        detail:
          model: api
          action: create
          message: You can create up to 3 APIs on your current plan.
    featureUnavailable403Error:
      value:
        type: https://api.postman.com/problems/forbidden
        title: Forbidden
        detail: This feature isn't available in your region.
        status: 403
    api404ErrorNotFound:
      value:
        type: instanceNotFoundError
        title: We could not find the API you are looking for
        detail: We could not find the API you are looking for.
    api403ErrorForbidden:
      value:
        title: You are not permitted to perform the action.
        detail: Please ensure that you have required permissions
        type: ForbiddenError
  responses:
    updateApi:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the API.
            required:
            - name
            properties:
              id:
                type: string
                description: The API's ID.
                example: 5360b75f-447e-467c-9299-12fd6c92450d
              name:
                type: string
                description: The API's name.
                example: Test API A
              summary:
                type: string
                description: The API's summary.
                example: Test API A Schema
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the API was created.
                example: '2022-06-29T20:46:58.000Z'
              createdBy:
                type: string
                description: The user ID of the user that created the API.
                example: '12345678'
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the API was last updated.
                example: '2022-06-29T20:46:58.000Z'
              updatedBy:
                type: string
                description: The user ID of the user that updated the API.
                example: '12345678'
              description:
                type: string
                description: The API's description. This supports Markdown formatting.
                example: This is Test API A.
          example:
            createdAt: '2022-06-29T20:46:58.000Z'
            updatedAt: '2022-06-29T20:46:58.000Z'
            id: 5360b75f-447e-467c-9299-12fd6c92450d
            name: Test API A
            summary: Test API A Schema
            description: This is Test API A.
            createdBy: '12345678'
            updatedBy: '12345678'
    workspace400ErrorParamMissing:
      description: Missing Workspace ID
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The type of error.
                example: paramMissingError
              title:
                type: string
                description: A short summary of the problem.
                example: Parameter is missing in the request.
              detail:
                type: string
                description: Information about the error.
                example: Parameter, workspaceId is missing in the request.
          example:
            type: paramMissingError
            title: Parameter is missing in the request.
            detail: Parameter, workspaceId is missing in the request.
    featureUnavailable403Error:
      description: Feature Unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/featureUnavailable403Error'
          example:
            value:
              type: https://api.postman.com/problems/forbidden
              title: Forbidden
              detail: This feature isn't available in your region.
              status: 403
    getStatusOfAnAsyncTask:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
                description: The task's ID.
                example: 10ca9f5a-c4c4-11ed-afa1-0242ac120002
              meta:
                type: object
                description: The response's non-standard meta information.
                properties:
                  url:
                    type: string
                    format: url
                    description: The endpoint URL that created the task.
                    example: https://api.getpostman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d/collections/e726de58-f1b3-4edd-a8a7-2579dc799d39/sync
                  model:
                    type: string
                    description: The model for which the task is performing the operation.
                    enum:
                    - collection
                    - api-version
                    example: collection
                  action:
                    type: string
                    description: The task's action.
                    enum:
                    - update
                    - create
                    example: update
              status:
                description: The task's current status.
                enum:
                - pending
                - failed
                - completed
                type: string
                example: completed
              details:
                anyOf:
                - type: object
                  title: Task Resources
                  description: Information about the task's resources.
                  properties:
                    resources:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            description: The ID of the assigned resource.
                            example: collectionID
                          url:
                            type: string
                            description: The task's assigned resource URL.
                            example: https://api.getpostman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d/collections/e726de58-f1b3-4edd-a8a7-2579dc799d39
                - type: object
                  title: Task Error Information
                  description: Information about the error that occurred during the task's processing.
                  properties:
                    error:
                      type: object
                      properties:
                        message:
                          type: string
                          description: The task's error message.
                          example: The API contains invalid schema
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the task was created.
                example: '2023-08-22T14:21:57.000Z'
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the task was last updated.
                example: '2023-08-22T14:21:57.000Z'
          example:
            id: 66ae9950-0869-4e65-96b0-1e0e47e771af
            meta:
              url: https://api.getpostman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d/collections/e726de58-f1b3-4edd-a8a7-2579dc799d39/sync
              model: collection
              action: update
            status: failed
            details:
              error:
                message: The API contains invalid schema
            createdAt: '2019-02-12 19:34:49'
            updatedAt: '2023-02-12 19:34:49'
    taskNotFound:
      description: Task Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/taskNotFound'
          examples:
            Task Not Found:
              $ref: '#/components/examples/taskNotFound'
    api401ErrorUnauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: An API key must be provided in the request header or query string
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
              instance:
                type: string
                description: The URI reference that identifies the specific occurrence of the problem.
                example: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: An API key must be provided in the request header or query string
            status: 401
            instance: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D
    common500Error:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/internal-server-error
              title:
                type: string
                description: A short summary of the problem.
                example: Internal Server Error
              detail:
                type: string
                description: Information about the error.
                example: Internal Server Error
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
    getApis:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the API schema.
            properties:
              apis:
                type: array
                items:
                  type: object
                  title: API Base Data Schema
                  description: The API's base data schema.
                  properties:
                    id:
                      type: string
                      description: The API's ID.
                      example: 5360b75f-447e-467c-9299-12fd6c92450d
                    name:
                      type: string
                      description: The API's name.
                      example: User Management API
                    summary:
                      type: string
                      description: The API's short summary.
                      example: An API to manager users.
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the API was created.
                      example: '2023-08-22T14:21:57.000Z'
                    createdBy:
                      type: integer
                      description: The Postman ID of the user that created the API.
                      example: 12345678
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the API was updated.
                      example: '2023-08-22T14:21:57.000Z'
                    updatedBy:
                      type: integer
                      description: The Postman ID of the user that updated the API.
                      example: 12345678
                    description:
                      type: string
                      description: The API's description.
                      example: This API includes operations to add/remove/update users.
              meta:
                type: object
                description: The response's meta information for paginated results.
                properties:
                  limit:
                    type: number
                    example: 100
                    description: The maximum number of records in the paginated response.
                  total:
                    type: number
                    example: 1000
                    description: The number of records that match the defined criteria.
                  nextCursor:
                    type: string
                    format: base64
                    description: The pagination cursor that points to the next record in the results set.
                    example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
          example:
            meta:
              nextCursor: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
              total: 4
              limit: 10
            apis:
            - updatedBy: 12345678
              createdBy: 12345678
              name: New API
              summary: ''
              description: ''
              createdAt: '2023-02-15T06:27:16.000Z'
              id: 73e15000-bc7a-4802-b80e-05fff18fd7f8
              updatedAt: '2023-02-15T06:27:24.000Z'
            - updatedBy: 12345678
              createdBy: 12345678
              name: Test API
              summary: This is a test API.
              description: This is an API for testing purposes.
              createdAt: '2023-02-15T13:07:08.000Z'
              id: fec65321-5f55-4feb-8525-be95bccae8dd
              updatedAt: '2023-02-15T13:07:08.000Z'
            - updatedBy: 12345678
              createdBy: 12345678
              name: Test API
              summary: This is a test API.
              description: This is an API for testing purposes.
              createdAt: '2023-02-16T05:52:27.000Z'
              id: b7c54faa-d119-4572-a18d-e2f5c32348ce
              updatedAt: '2023-02-16T05:52:27.000Z'
            - updatedBy: 12345678
              createdBy: 12345678
              name: Test API
              summary: This is a test API.
              description: This is an API for testing purposes.
              createdAt: '2023-02-16T07:07:16.000Z'
              id: d535a8ba-ed4b-4c6a-bf1c-13fac95485b8
              updatedAt: '2023-02-16T07:07:16.000Z'
    v10HeaderMissing:
      description: Missing v10 Accept Header
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/v10HeaderMissing'
          examples:
            Missing v10 Accept Header:
              $ref: '#/components/examples/v10HeaderMissing'
    api403ErrorAndFeatureUnavailable:
      description: Forbidden
      content:
        application/json:
          schema:
            anyOf:
            - $ref: '#/components/schemas/api403ErrorForbidden'
            - $ref: '#/components/schemas/featureUnavailable403Error'
          examples:
            Forbidden:
              $ref: '#/components/examples/api403ErrorForbidden'
            Feature Unavailable:
              $ref: '#/components/examples/featureUnavailable403Error'
    common401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: Unauthorized
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: Unauthorized
            status: 401
    getApiVersion:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            title: API Version Data Schema
            properties:
              version:
                type: object
                description: Information about the API version.
                properties:
                  id:
                    type: string
                    description: The version's ID.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                  name:
                    type: string
                    description: The version's name.
                    example: Release 1.0
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the version was created.
                    example: '2023-06-09T14:48:45.000Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the version was last updated.
                    example: '2023-06-09T14:48:45.000Z'
                  releaseNotes:
                    type: string
                    description: The version's release notes.
                    example: This is the first release.
                  schemas:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The schema's ID.
                          example: 13a441a3-6109-4f78-86eb-e0144d0ff275
                        type:
                          type: string
                          description: The schema type.
                          example: openapi:3
                  collections:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The collection's ID.
                          example: aeedb353-494b-4424-82cf-358aece2bd1c
                        type:
                          type: string
                          description: The collection's name.
                          example: collection1
          example:
            version:
              createdAt: '2022-06-09T14:48:45.000Z'
              updatedAt: '2022-06-09T19:50:49.000Z'
              id: 3563baaa-07a2-46ed-9fd2-0e8a3c5f7ec2
              name: Release 1.0
              releaseNotes: This is the first release.
              schemas:
              - id: 13a441a3-6109-4f78-86eb-e0144d0ff275
                type: openapi:3
              collections:
              - id: aeedb353-494b-4424-82cf-358aece2bd1c
                name: collection1
    createApi:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: The API's base data schema.
            title: API Base Data Schema
            properties:
              id:
                type: string
                description: The API's ID.
                example: 5360b75f-447e-467c-9299-12fd6c92450d
              name:
                type: string
                description: The API's name.
                example: User Management API
              summary:
                type: string
                description: The API's short summary.
                example: An API to manager users.
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the API was created.
                example: '2023-08-22T14:21:57.000Z'
              createdBy:
                type: integer
                description: The Postman ID of the user that created the API.
                example: 12345678
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the API was updated.
                example: '2023-08-22T14:21:57.000Z'
              updatedBy:
                type: integer
                description: The Postman ID of the user that updated the API.
                example: 12345678
              description:
                type: string
                description: The API's description.
                example: This API includes operations to add/remove/update users.
          example:
            id: 90ca9f5a-c4c4-11ed-afa1-0242ac120002
            name: Test API
            summary: Testing API
            createdAt: '2023-02-17T04:09:01.000Z'
            createdBy: 12345678
            updatedAt: '2023-02-17T04:09:13.000Z'
            updatedBy: 12345678
            description: This is a test API.
    v9Unsupported:
      description: v9 Unsupported
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The error type.
                example: unsupportedEntityError
              title:
                type: string
                description: A short summary of the problem.
                example: Unsupported API
              detail:
                type: string
                description: Details about the error.
                example: This endpoint does not support v9 APIs.
          example:
            type: unsupportedEntityError
            title: Unsupported API
            detail: This endpoint does not support v9 APIs.
    getApi:
      description: Successful Response
      content:
        application/json:
          schema:
            anyOf:
            - type: object
              title: API Base Data Schema
              description: The API's base data schema.
              properties:
                id:
                  type: string
                  description: The API's ID.
                  example: 5360b75f-447e-467c-9299-12fd6c92450d
                name:
                  type: string
                  description: The API's name.
                  example: User Management API
                summary:
                  type: string
                  description: The API's short summary.
                  example: An API to manager users.
                createdAt:
                  type: string
                  format: date-time
                  description: The date and time at which the API was created.
                  example: '2023-08-22T14:21:57.000Z'
                createdBy:
                  type: integer
                  format: int64
                  description: The Postman ID of the user that created the API.
                  example: 12345678
                updatedAt:
                  type: string
                  format: date-time
                  description: The date and time at which the API was updated.
                  example: '2023-08-22T14:21:57.000Z'
                updatedBy:
                  type: integer
                  format: int64
                  description: The Postman ID of the user that updated the API.
                  example: 12345678
                description:
                  type: string
                  description: The API's description.
                  example: This API includes operations to add/remove/update users.
            - type: object
              title: API Extended Data Schema
              description: 'The API''s extended data schema.


                **Note:**


                Git-connected APIs will only return the `versions` and `gitInfo` query responses. This is because schema and collection information is stored in the connected Git repository. The `gitInfo` object only lists the repository and folder locations of the files.

                '
              allOf:
              - type: object
                title: API Base Data Schema
                description: The API's base data schema.
                properties:
                  id:
                    type: string
                    description: The API's ID.
                    example: 5360b75f-447e-467c-9299-12fd6c92450d
                  name:
                    type: string
                    description: The API's name.
                    example: User Management API
                  summary:
                    type: string
                    description: The API's short summary.
                    example: An API to manager users.
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the API was created.
                    example: '2023-08-22T14:21:57.000Z'
                  createdBy:
                    type: integer
                    format: int64
                    description: The Postman ID of the user that created the API.
                    example: 12345678
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the API was updated.
                    example: '2023-08-22T14:21:57.000Z'
                  updatedBy:
                    type: integer
                    format: int64
                    description: The Postman ID of the user that updated the API.
                    example: 12345678
                  description:
                    type: string
                    description: The API's description.
                    example: This API includes operations to add/remove/update users.
              - type: object
                title: API Details
                description: Detailed information about the API.
                properties:
                  gitInfo:
                    type: object
                    title: Git Repo Data Schema
                    description: Information about the API's Git repository integration.
                    properties:
                      domain:
                        type: string
                        nullable: true
                        description: The domain at which the Git repository is hosted.
                        example: https://git.example.com
                      repository:
                        type: string
                        description: The repository's name.
                        example: test-api-repo
                      organization:
                        type: string
                        description: The organization that owns the repository.
                        example: test-org
                      schemaFolder:
                        type: string
                        description: The API definition's repository folder location.
                        example: test-api-schema
                      collectionFolder:
                        type: string
                        description: The API definition's collection repository folder location.
                        example: test-api-collection
                  schemas:
                    type: array
                    description: The API's schemas.
                    items:
                      type: object
                      description: Information about the schema.
                      properties:
                        id:
                          type: string
                          description: The schema's ID.
                          example: 5381f010-c4c1-11ed-afa1-0242ac120002
                  versions:
                    type: array
                    description: The API's versions.
                    items:
                      type: object
                      description: Information about the version.
                      properties:
                        id:
                          type: string
                          description: The version's ID.
                          example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                        name:
                          type: string
                          description: The version's name.
                          example: v1
                  collections:
                    type: array
                    description: The API's collections.
                    items:
                      type: object
                      description: Information about the collection.
                      properties:
                        id:
                          type: string
                          description: The collection's ID.
                          example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002
          example:
            createdBy: 12345678
            name: Test API
            updatedBy: 12345678
            updatedAt: '2022-06-09T19:50:49.000Z'
            description: This is a test API.
            id: 5360b75f-447e-467c-9299-12fd6c92450d
            collections:
            - id: 16bb367e-fafb-4ef3-933b-ee3d971866fb
            gitInfo: {}
            schemas:
            - id: ae2b9ab2-28f2-401d-912f-eca09a78e98b
            versions:
            - id: 18ccb2dc-1746-4945-ba76-8152b37cr123
              name: v1.0.0
            createdAt: '2022-06-09T14:48:45.000Z'
            summary: Test API.
    api404ErrorNotFound:
      description: API Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/api404ErrorNotFound'
          examples:
            API Not Found:
              $ref: '#/components/examples/api404ErrorNotFound'
    apiVersion404ErrorNotFound:
      description: API Version Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/apiVersion404ErrorNotFound'
          examples:
            API Version Not Found:
              $ref: '#/components/examples/apiVersion404ErrorNotFound'
    workspace404Error:
      description: Workspace Not Found
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The type of error.
                example: instanceNotFoundError
              title:
                type: string
                description: A short summary of the problem.
                example: We could not find the workspace you are looking for
              detail:
                type: string
                description: Information about the error.
                example: We could not find the workspace you are looking for.
          example:
            title: We could not find the workspace you are looking for
            detail: We could not find the workspace you are looking for.
            type: instanceNotFoundError
  schemas:
    taskNotFound:
      title: Task Not Found
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: invalidParamsError
        title:
          type: string
          description: A short summary of the problem.
          example: The specified parameter is in an invalid format
        detail:
          type: string
          description: Information about the error.
          example: Parameter, taskId is in an invalid format.
    apiVersion404ErrorNotFound:
      title: API Version Not Found
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: VersionNotFound
        title:
          type: string
          description: A short summary of the problem.
          example: API Version not found.
        detail:
          type: string
          description: Information about the error.
          example: We could not find the API Version you are looking for.
    v10HeaderMissing:
      title: Missing v10 Accept Header
      type: object
      properties:
        name:
          type: string
          description: The error name.
          example: instanceNotFoundError
        message:
          type: string
          description: The error message.
          example: API not found. For v10 and later APIs, ensure that your request sends the "application/vnd.api.v10+json" Accept header.
    apiVersion400ErrorInvalidParam:
      title: Invalid Parameter
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: invalidParamsError
        title:
          type: string
          description: A short summary of the problem.
          example: The specified parameter is in an invalid format
        detail:
          type: string
          description: Information about the error.
          example: Parameter, taskId is in an invalid format.
    apiVersionId:
      type: string
      example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
    api404ErrorNotFound:
      title: API Not Found
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: instanceNotFoundError
        title:
          type: string
          description: A short summary of the problem.
          example: We could not find the API you are looking for
        detail:
          type: string
          description: Information about the error.
          example: We could not find the API you are looking for
    workspaceId:
      type: string
      example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
    featureUnavailable403Error:
      title: Feature Unavailable
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
          example: https://api.postman.com/problems/forbidden
        title:
          type: string
          description: A short summary of the problem.
          example: Forbidden
        detail:
          type: string
          description: Information about the error.
          example: This feature isn't available in your region.
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
    limit:
      type: integer
      default: 10
      example: 10
    api403ErrorLimitReached:
      title: API Limit Reached
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: limitReachedError
        title:
          type: string
          description: A short summary of the problem.
          example: You've reached the API limit
        message:
          type: string
          description: The error message.
          example: You can create up to 3 APIs on your current plan.
        details:
          type: object
          description: Information about the error.
          properties:
            model:
              type: string
              description: The `api` model.
              enum:
              - api
              example: api
            action:
              type: string
              description: The `create` action.
              enum:
              - create
              example: create
            message:
              type: string
              description: The error message.
              example: You can create up to 3 APIs on your current plan.
    cursor:
      type: string
      example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
    api403ErrorForbidden:
      title: Forbidden
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: ForbiddenError
        title:
          type: string
          description: A short summary of the problem.
          example: You are not permitted to perform the action.
        detail:
          type: string
          description: Information about the error.
          example: Please ensure that you have required permissions
  parameters:
    v10Accept:
      name: Accept
      in: header
      required: true
      description: The `application/vnd.api.v10+json` request header required to use the endpoint.
      schema:
        type: string
        enum:
        - application/vnd.api.v10+json
        example: application/vnd.api.v10+json
    createdBy:
      name: createdBy
      in: query
      description: Return only results created by the given user ID.
      schema:
        type: integer
        example: 12345678
    apiId:
      name: apiId
      in: path
      required: true
      description: The API's ID.
      schema:
        type: string
        example: 90ca9f5a-c4c4-11ed-afa1-0242ac120002
    workspaceIdQueryTrue:
      name: workspaceId
      in: query
      required: true
      description: The workspace's ID.
      schema:
        $ref: '#/components/schemas/workspaceId'
    cursor:
      name: cursor
      in: query
      description: The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.
      schema:
        $ref: '#/components/schemas/cursor'
    apiVersionId:
      name: versionId
      in: path
      required: true
      description: The API's version ID.
      schema:
        $ref: '#/components/schemas/apiVersionId'
    limit:
      name: limit
      in: query
      description: The maximum number of rows to return in the response.
      schema:
        $ref: '#/components/schemas/limit'
    apiTaskId:
      name: taskId
      in: path
      required: true
      description: The task's ID.
      schema:
        type: string
        example: 90ca9f5a-c4c4-21ed-afa1-0242ac120002
    apiInclude:
      name: include
      in: query
      description: 'An array that contains additional resources to include in the response. Use this parameter to query for element links to the API, such as  collections and schemas:

        - `collections` — Query for linked Postman collections.

        - `versions` — Query for linked versions.

        - `schemas` — Query for linked schemas.

        - `gitInfo` — Query for information about the API''s git-linked repository. This query only returns the linked repository and folder locations of the files. It does not return `collections` or `schemas` information.


        **Note:**


        API viewers can only use the `versions` option.

        '
      schema:
        type: array
        items:
          type: string
          enum:
          - collections
          - versions
          - schemas
          - gitInfo
        example:
        - schemas
    apiDescription:
      name: description
      in: query
      description: Return only APIs whose description includes the given value. Matching is not case-sensitive.
      schema:
        type: string
        example: This is an API for testing purposes
  headers:
    Location:
      description: The URL to get or poll the status of an API version task created.
      schema:
        type: string
        example: /apis/6138195-0262634b-cdcb-4a03-a4b9-2b221eccfbaa/tasks/66ae9950-0869-4e65-96b0-1e0e47e771af
  requestBodies:
    createApi:
      content:
        application/json:
          schema:
            title: Create/Update API
            description: Information about the API.
            type: object
            required:
            - name
            properties:
              name:
                type: string
                description: The API's name.
                example: Test API
              summary:
                type: string
                description: The API's short summary.
                example: Testing API
              description:
                type: string
                description: The API's description. This supports Markdown formatting.
                example: This is a test API.
          example:
            name: Test API
            summary: Testing API
            description: This is a test API.
    updateApi:
      content:
        application/json:
          schema:
            type: object
            title: Create/Update API
            description: Information about the API.
            required:
            - name
            properties:
              name:
                type: string
                description: The API's name.
                example: Test API
              summary:
                type: string
                description: The API's short summary.
                example: Testing API
              description:
                type: string
                description: The API's description. This supports Markdown formatting.
                example: This is a test API.
          example:
            name: Test API
            summary: Testing API
            description: This is a test API.
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true