openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Collection Responses 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: Collection Responses
  description: The **Collection Responses** endpoints enable you to manage collection responses.
paths:
  /collections/{collectionId}/responses:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    post:
      summary: APIs.io Engineering Platform Create a response
      description: 'Creates a request response in a collection. For a complete list of request body properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.

        '
      operationId: createCollectionResponse
      tags:
      - Collection Responses
      requestBody:
        $ref: '#/components/requestBodies/createCollectionResponse'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionResponse'
        '400':
          $ref: '#/components/responses/collectionResponse400Error'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionResponseParentRequestId'
  /collections/{collectionId}/responses/{responseId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionResponseUid'
    get:
      summary: APIs.io Engineering Platform Get a response's comments
      description: Gets all comments left by users in a response.
      operationId: getResponseComments
      tags:
      - Collection Responses
      responses:
        '200':
          $ref: '#/components/responses/commentGet'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    post:
      summary: APIs.io Engineering Platform Create a response comment
      description: 'Creates a comment on a response.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Collection Responses
      operationId: createResponseComment
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '201':
          $ref: '#/components/responses/commentCreated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/responses/{responseId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionResponseUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a response's comment
      description: 'Updates a comment on a response.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateResponseComment
      tags:
      - Collection Responses
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '200':
          $ref: '#/components/responses/commentUpdated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a response's comment
      description: 'Deletes a comment from a response. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        Deleting the first comment of a thread deletes all the comments in the thread.

        '
      operationId: deleteResponseComment
      tags:
      - Collection Responses
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/responses/{responseId}:
    parameters:
    - $ref: '#/components/parameters/collectionResponseId'
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a response
      description: Gets information about a response in a collection.
      operationId: getCollectionResponse
      tags:
      - Collection Responses
      responses:
        '200':
          $ref: '#/components/responses/getCollectionResponse'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '404':
          $ref: '#/components/responses/collectionResponse404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionItemsIdQuery'
      - $ref: '#/components/parameters/collectionItemsUidFormatQuery'
      - $ref: '#/components/parameters/collectionItemsPopulateQuery'
    put:
      summary: APIs.io Engineering Platform Update a response
      description: 'Updates a response in a collection. For a complete list of properties, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection UID (`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

        - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does not update the entire resource.

        '
      operationId: updateCollectionResponse
      tags:
      - Collection Responses
      requestBody:
        $ref: '#/components/requestBodies/updateCollectionResponse'
      responses:
        '200':
          $ref: '#/components/responses/updateCollectionResponse'
        '400':
          $ref: '#/components/responses/collectionResponse400Error'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '404':
          $ref: '#/components/responses/collectionResponse404Error'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a response
      description: Deletes a response in a collection.
      operationId: deleteCollectionResponse
      tags:
      - Collection Responses
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionResponse'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '404':
          $ref: '#/components/responses/collectionResponse404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  schemas:
    collectionRequestId:
      type: string
      example: c82dd02c-4870-4907-8fcb-593a876cf05b
    commentCreateUpdate:
      title: Comment Payload Object
      type: object
      description: Information about the comment.
      required:
      - body
      properties:
        body:
          type: string
          description: The contents of the comment.
          example: This is an example.
        tags:
          type: object
          description: Information about users tagged in the `body` comment.
          properties:
            userName:
              type: object
              required:
              - type
              - id
              description: An object that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`.
              properties:
                type:
                  type: string
                  description: The `user` value.
                  enum:
                  - user
                  example: user
                id:
                  type: integer
                  description: The user's ID.
                  example: 87654321
    commentResponse:
      title: Comment Response Object
      type: object
      properties:
        data:
          type: array
          required:
          - id
          - threadId
          - createdBy
          - createdAt
          - updatedAt
          - body
          items:
            type: object
            description: Information about the comment.
            properties:
              id:
                type: integer
                description: The comment's ID.
                example: 46814
              threadId:
                type: integer
                description: The comment's thread ID.
                example: 12345
              createdBy:
                type: integer
                description: The user ID of the user who created the comment.
                example: 12345678
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the comment was created.
                example: '2024-01-18T11:30:40.000Z'
              updatedAt:
                type: string
                format: date-time
                description: The date and time when the comment was last updated.
                example: '2024-01-18T11:30:40.000Z'
              body:
                type: string
                description: The contents of the comment.
                example: This is an example.
    comment403Error:
      title: Forbidden
      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: Forbidden
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
    commentCreatedUpdated:
      title: Comment Updated/Created Object
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: integer
              description: The comment's ID.
              example: 46814
            threadId:
              type: integer
              description: The comment's thread ID.
              example: 12345
            createdBy:
              type: integer
              description: The user ID of the user who created the comment.
              example: 12345678
            createdAt:
              type: string
              format: date-time
              description: The date and time at which the comment was created.
              example: '2024-01-18T11:30:40.000Z'
            updatedAt:
              type: string
              format: date-time
              description: The date and time when the comment was last updated.
              example: '2024-01-18T11:30:40.000Z'
            body:
              type: string
              description: The contents of the comment.
              example: This is an example.
    booleanQuery:
      type: boolean
      example: true
  responses:
    comment403Error:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/comment403Error'
          example:
            type: https://api.postman.com/problems/forbidden
            title: Forbidden
            detail: Forbidden
            status: 403
    commentUpdated:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentCreatedUpdated'
          example:
            data:
              id: 46814
              threadId: 12345
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an updated example.
    commentGet:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentResponse'
          example:
            data:
            - id: 46818
              threadId: 12345
              createdBy: 12345678
              createdAt: '2024-01-18T12:00:54.000Z'
              updatedAt: '2024-01-18T12:00:54.000Z'
              body: This is also an example.
            - id: 46817
              threadId: 67890
              createdBy: 87654321
              createdAt: '2024-01-18T11:48:01.000Z'
              updatedAt: '2024-01-18T11:48:01.000Z'
              body: Another example.
            - id: 46814
              threadId: 23456
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an example.
    deleteCollectionResponse:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              model_id:
                type: string
                description: The response's ID.
                example: cc364734-7dfd-4bfc-897d-be763dcdbb07
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              data:
                type: object
                description: The response's information.
                properties:
                  id:
                    type: string
                    description: The response's ID.
                    example: cc364734-7dfd-4bfc-897d-be763dcdbb07
                  owner:
                    type: string
                    description: The user ID of the request's owner.
                    example: '12345678'
              revision:
                type: number
                description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                example: 24997417224
          example:
            model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07
            meta:
              model: response
              action: destroy
            data:
              id: cc364734-7dfd-4bfc-897d-be763dcdbb07
              owner: '12345678'
            revision: 24997417224
    collectionResponse401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: Unauthorized
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: response
                      owner:
                        type: string
                        description: The user ID of the response's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The response's ID.
                        example: 7978bfb8-fb89-42ac-8d48-cd547d96463e
                  message:
                    type: string
                    description: The error message.
                    example: Unauthorized
          example:
            error:
              name: Unauthorized
              details:
                model: response
                owner: '12345678'
                model_id: 7978bfb8-fb89-42ac-8d48-cd547d96463e
              message: Unauthorized
    collectionResponse400Error:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceFoundError
                  details:
                    type: object
                    description: Information about the error.
                    additionalProperties: true
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: response
                      owner:
                        type: string
                        description: The user ID of the response's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The response's ID.
                        example: 7978bfb8-fb89-42ac-8d48-cd547d96463e
                  message:
                    type: string
                    description: The error message.
                    example: This response already exists in the database.
          example:
            error:
              name: instanceFoundError
              message: This response already exists in the database.
              details:
                model: response
                model_id: 7978bfb8-fb89-42ac-8d48-cd547d96463e
                owner: '12345678'
    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
    comment500Error:
      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
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 500
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
            status: 500
    comment401Error:
      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
    createCollectionResponse:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                additionalProperties: true
                description: Information about the response. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
                properties:
                  id:
                    type: string
                    description: The response's ID.
                    example: 43e1277f-6079-4feb-9316-c8ec24605092
                  owner:
                    type: string
                    description: The user ID of the response's owner.
                    example: '12345678'
                  request:
                    type: string
                    description: The request ID of the response's associated request.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the response was created.
                    example: '2022-08-19T15:06:18.940Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the response was last updated.
                    example: '2022-08-19T15:06:18.940Z'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user who last updated the response.
                    example: '12345678'
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The response's ID.
                example: 43e1277f-6079-4feb-9316-c8ec24605092
              revision:
                type: number
                description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                example: 26532286083
          example:
            data:
              id: 43e1277f-6079-4feb-9316-c8ec24605092
              owner: '12345678'
              request: c82dd02c-4870-4907-8fcb-593a876cf05b
              createdAt: '2022-08-29T16:58:15.523Z'
              updatedAt: '2022-08-29T16:58:15.523Z'
              lastUpdatedBy: '12345678'
            meta:
              model: response
              action: create
            model_id: 43e1277f-6079-4feb-9316-c8ec24605092
            revision: 26532286083
    updateCollectionResponse:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                description: Information about the updated response. For a complete list of response properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
                additionalProperties: true
                properties:
                  id:
                    type: string
                    description: The response's ID.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  name:
                    type: string
                    description: The response's name.
                    example: Test Folder
                  owner:
                    type: string
                    description: The user ID of the response's owner.
                    example: '12345678'
                  createdAt:
                    type: string
                    format: date-time
                    description: The response's creation date and time.
                    example: '2022-08-29T16:49:19.964Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the response was last updated.
                    example: '2022-08-29T16:49:19.964Z'
                  lastRevision:
                    type: integer
                    format: int64
                    description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                    example: 24994132707
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the response.
                    example: '12345678'
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The response's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
          example:
            model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
            meta:
              model: response
              action: update
            data:
              id: c82dd02c-4870-4907-8fcb-593a876cf05b
              name: Example Response
              status: null
              responseCode:
                name: OK
                code: 200
              time: '50'
              headers:
              - value: Fri, 01 Sep 2023 07:36:18 GMT
                key: Date
              - value: application/json; charset=utf-8
                key: Content-Type
              - value: '607'
                key: Content-Length
              - value: keep-alive
                key: Connection
              cookies: null
              mime: null
              text: "{\n    \"args\": {},\n    \"data\": {\n        \"field\": \"Value\"\n    },\n    \"files\": {},\n    \"form\": {},\n    \"headers\": {\n        \"x-forwarded-proto\": \"https\",\n        \"x-forwarded-port\": \"443\",\n        \"host\": \"postman-echo.com\",\n        \"x-amzn-trace-id\": \"Root=1-64f9cd12-62f18f3a048796d345508073\",\n        \"content-length\": \"24\",\n        \"content-type\": \"application/json\",\n        \"x-api-key\": \"xxx\",\n        \"user-agent\": \"PostmanRuntime/7.32.3\",\n        \"accept\": \"*/*\",\n        \"postman-token\": \"XXX\",\n        \"accept-encoding\": \"gzip, deflate, br\"\n    },\n    \"json\": {\n        \"field\": \"Value\"\n    },\n    \"url\": \"https://postman-echo.com/post\"\n}"
              language: json
              rawDataType: null
              requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[],"method":"POST","pathVariableData":[],"queryParams":[],"url":"https://postman-echo.com/post","headers":"","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"{\n    \"field\": \"Value\"\n}","graphqlModeData":{}}'
              createdAt: '2023-09-01T09:29:54.000Z'
              updatedAt: '2023-09-08T12:37:33.000Z'
              owner: '12345678'
              lastUpdatedBy: '12345678'
              lastRevision: 32368133468
              request: c82dd02c-4870-4907-8fcb-593a876cf05b
            revision: 32473225008
    collectionResponse404Error:
      description: Not Found
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceNotFoundError
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: response
                      owner:
                        type: string
                        description: The user ID of the response's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The response's ID.
                        example: 7978bfb8-fb89-42ac-8d48-cd547d96463e
                  message:
                    type: string
                    description: The error message.
                    example: We could not find the response you are looking for
          example:
            error:
              name: instanceNotFoundError
              message: We could not find the response you are looking for
              details:
                model: response
                model_id: 7978bfb8-fb89-42ac-8d48-cd547d96463e
                owner: '12345678'
    getCollectionResponse:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                description: Information about the response. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
                additionalProperties: true
                properties:
                  id:
                    type: string
                    description: The response's ID.
                    example: cc364734-7dfd-4bfc-897d-be763dcdbb07
                  request:
                    type: string
                    description: The ID of the request that the response belongs to.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  name:
                    type: string
                    description: The response's name.
                    example: Test Folder
                  owner:
                    type: string
                    description: The user ID of the response's owner.
                    example: '12345678'
                  createdAt:
                    type: string
                    format: date-time
                    description: The response's creation date and time.
                    example: '2022-08-29T16:49:19.964Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the response was last updated.
                    example: '2022-08-29T16:49:19.964Z'
                  lastRevision:
                    type: integer
                    format: int64
                    description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                    example: 24994132707
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the response.
                    example: '12345678'
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The response's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
          example:
            model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07
            meta:
              model: response
              populate: false
              changeset: false
              action: find
            data:
              owner: '12345678'
              lastUpdatedBy: '12345678'
              lastRevision: 32457792182
              request: c82dd02c-4870-4907-8fcb-593a876cf05b
              id: cc364734-7dfd-4bfc-897d-be763dcdbb07
              name: Successful GET Response
              status: null
              responseCode:
                code: 200
                name: OK
              time: null
              headers:
              - key: Content-Type
                name: Content-Type
                value: application/json
                description: ''
                type: text
              cookies: null
              mime: null
              text: "{\n    \"title\": \"Not Found\",\n    \"detail\": \"Requested API does not exist\",\n    \"type\": \"about:blank\"\n}"
              language: json
              rawDataType: null
              requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[{"key":"Accept","value":"application/vnd.example.v1+json","description":"","type":"text","enabled":true}],"method":"GET","pathVariableData":[],"queryParams":[{"key":"id","value":"test-api","equals":true,"description":null,"enabled":true}],"url":"http://api.getpostman.com/v1/request?id=test-api","headers":"Accept: application/vnd.example.v1+json\n","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"","graphqlModeData":{}}'
              createdAt: '2023-09-07T14:39:52.000Z'
              updatedAt: '2023-09-07T14:41:08.000Z'
    comment404Error:
      description: Not Found
      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/not-found
              title:
                type: string
                description: A short summary of the problem.
                example: Not Found
              detail:
                type: string
                description: Information about the error.
                example: Not Found
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 404
          example:
            type: https://api.postman.com/problems/not-found
            title: Not Found
            detail: Not Found
            status: 404
    commentCreated:
      description: Created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentCreatedUpdated'
          example:
            data:
              id: 46814
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an example.
  parameters:
    collectionResponseUid:
      name: responseId
      in: path
      required: true
      description: The response's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-cc364734-7dfd-4bfc-897d-be763dcdbb07
    collectionId:
      name: collectionId
      in: path
      required: true
      description: The collection's ID.
      schema:
        type: string
        example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
    collectionItemsUidFormatQuery:
      name: uid
      in: query
      description: If true, returns all IDs in UID format (`userId`-`id`).
      schema:
        $ref: '#/components/schemas/booleanQuery'
    commentId:
      name: commentId
      in: path
      required: true
      description: The comment's ID.
      schema:
        type: integer
        example: 46814
    collectionUid:
      name: collectionId
      in: path
      required: true
      description: The collection's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
    collectionResponseParentRequestId:
      name: requestId
      in: query
      required: true
      description: The parent request's ID.
      schema:
        $ref: '#/components/schemas/collectionRequestId'
    collectionResponseId:
      name: responseId
      in: path
      required: true
      description: The response's ID.
      schema:
        type: string
        example: cc364734-7dfd-4bfc-897d-be763dcdbb07
    collectionItemsIdQuery:
      name: ids
      in: query
      description: If true, returns only properties that contain ID values in the response.
      schema:
        $ref: '#/components/schemas/booleanQuery'
    collectionItemsPopulateQuery:
      name: populate
      in: query
      description: If true, returns all of the collection item's contents.
      schema:
        $ref: '#/components/schemas/booleanQuery'
  requestBodies:
    updateCollectionResponse:
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
            description: The response properties to update. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
            properties:
              name:
                type: string
                description: The response's name.
                example: Bad Request
              responseCode:
                type: object
                description: The response's HTTP response code information.
                properties:
                  code:
                    type: number
                    description: The response's HTTP response status code.
                    example: 400
                  name:
                    type: string
                    description: The name of the status code.
                    example: Bad Request
          example:
            owner: '12345678'
            lastUpdatedBy: '12345678'
            lastRevision: 32368133468
            request: c82dd02c-4870-4907-8fcb-593a876cf05b
            name: Example Response
            status: null
            responseCode:
              code: 200
              name: OK
            time: '50'
            headers:
            - key: Date
              value: Fri, 01 Sep 2023 07:36:18 GMT
            - key: Content-Type
              value: application/json; charset=utf-8
            - key: Content-Length
              value: '607'
            - key: Connection
              value: keep-alive
            cookies: null
            mime: null
            text: "{\n    \"args\": {},\n    \"data\": {\n        \"field\": \"Value\"\n    },\n    \"files\": {},\n    \"form\": {},\n    \"headers\": {\n        \"x-forwarded-proto\": \"https\",\n        \"x-forwarded-port\": \"443\",\n        \"host\": \"postman-echo.com\",\n        \"x-amzn-trace-id\": \"Root=1-64f9cd12-62f18f3a048796d345508073\",\n        \"content-length\": \"24\",\n        \"content-type\": \"application/json\",\n        \"x-api-key\": \"xxx\",\n        \"user-agent\": \"PostmanRuntime/7.32.3\",\n        \"accept\": \"*/*\",\n        \"postman-token\": \"XXX\",\n        \"accept-encoding\": \"gzip, deflate, br\"\n    },\n    \"json\": {\n        \"field\": \"Value\"\n    },\n    \"url\": \"https://postman-echo.com/post\"\n}"
            language: json
            rawDataType: null
            requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[],"method":"POST","pathVariableData":[],"queryParams":[],"url":"https://postman-echo.com/post","headers":"","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"{\n    \"field\": \"Value\"\n}","graphqlModeData":{}}'
            createdAt: '2023-09-01T09:29:54.000Z'
            updatedAt: '2023-09-01T09:29:54.000Z'
    createCollectionResponse:
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
            description: 'Information about the response. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


              **Note:**


              It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.

              '
            properties:
              name:
                type: string
                example: Example POST Response
                description: The response's name. It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.
          example:
            name: Example POST Response
            description: This is an example POST response.
            url: https://postman-echo.com/post
            method: POST
            headers:
            - key: Host
              value: postman-echo.com
            - key: user-agent
              value: curl/7.88.1
            - key: accept
              value: '*/*'
            - key: content-type
              value: application/json
            - key: content-length
              value: '22'
            dataMode: raw
            rawModeData: "{\n    \"field\": \"Value\"\n}"
            dataOptions:
              raw:
                language: json
    commentCreateUpdate:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentCreateUpdate'
          examples:
            Create Comment:
              value:
                body: This is an example.
            Tag User in Comment:
              value:
                body: This is an example. @alex-cruz
                tags:
                  '@alex-cruz':
                    type: user
                    id: 12345678
  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