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


        You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the `requests` field and the list of request objects in the request body. For more information, see the provided example.


        **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 folder with a blank name.

        '
      operationId: createCollectionFolder
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/createCollectionFolder'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionFolder'
        '400':
          $ref: '#/components/responses/collectionFolder400Error'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/requests:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    post:
      summary: APIs.io Engineering Platform Create a request
      description: 'Creates a request in a collection. For a complete list of properties, refer to the **Request** 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 request with a blank name.

        '
      operationId: createCollectionRequest
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/createCollectionRequest'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionRequest'
        '400':
          $ref: '#/components/responses/collectionRequest400Error'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionRequestFolderIdQuery'
  /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 Items
      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}/folders/{folderId}:
    parameters:
    - $ref: '#/components/parameters/collectionFolderId'
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a folder
      description: Gets information about a folder in a collection.
      operationId: getCollectionFolder
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/getCollectionFolder'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '404':
          $ref: '#/components/responses/collectionFolder404Error'
        '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 folder
      description: 'Updates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        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: updateCollectionFolder
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/updateCollectionFolder'
      responses:
        '200':
          $ref: '#/components/responses/updateCollectionFolder'
        '400':
          $ref: '#/components/responses/collectionFolder400Error'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '404':
          $ref: '#/components/responses/collectionFolder404Error'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a folder
      description: Deletes a folder in a collection.
      operationId: deleteCollectionFolder
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionFolder'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '404':
          $ref: '#/components/responses/collectionFolder404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/requests/{requestId}:
    parameters:
    - $ref: '#/components/parameters/collectionRequestId'
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a request
      description: Gets information about a request in a collection.
      operationId: getCollectionRequest
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/getCollectionRequest'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '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 request
      description: 'Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in 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(`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

        - This endpoint does not support changing the folder of a request.

        '
      operationId: updateCollectionRequest
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/updateCollectionRequest'
      responses:
        '200':
          $ref: '#/components/responses/updateCollectionRequest'
        '400':
          $ref: '#/components/responses/collectionRequest400Error'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a request
      description: Deletes a request in a collection.
      operationId: deleteCollectionRequest
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionRequest'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /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 Items
      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 Items
      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 Items
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionResponse'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '404':
          $ref: '#/components/responses/collectionResponse404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  parameters:
    collectionFolderId:
      name: folderId
      in: path
      required: true
      description: The folder's ID.
      schema:
        $ref: '#/components/schemas/collectionFolderId'
    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'
    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
    collectionRequestId:
      name: requestId
      in: path
      required: true
      description: The request's ID.
      schema:
        $ref: '#/components/schemas/collectionRequestId'
    collectionItemsIdQuery:
      name: ids
      in: query
      description: If true, returns only properties that contain ID values in the response.
      schema:
        $ref: '#/components/schemas/booleanQuery'
    collectionRequestFolderIdQuery:
      name: folderId
      in: query
      description: The folder ID in which to create the request. By default, the system will create the request at the collection level.
      schema:
        $ref: '#/components/schemas/collectionFolderId'
    collectionItemsPopulateQuery:
      name: populate
      in: query
      description: If true, returns all of the collection item's contents.
      schema:
        $ref: '#/components/schemas/booleanQuery'
  schemas:
    collectionRequestId:
      type: string
      example: c82dd02c-4870-4907-8fcb-593a876cf05b
    collectionFolderId:
      type: string
      example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
    booleanQuery:
      type: boolean
      example: true
  responses:
    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
    collectionRequest404Error:
      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: request
                      owner:
                        type: string
                        description: The user ID of the request's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The request's ID.
                        example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  message:
                    type: string
                    description: The error message.
                    example: We could not find the request you are looking for
          example:
            error:
              name: instanceFoundError
              details:
                model: request
                owner: '12345678'
                model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
              message: We could not find the request you are looking for
    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
    updateCollectionFolder:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                additionalProperties: true
                description: The folder's updated information, including the updated properties. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
                properties:
                  id:
                    type: string
                    description: The folder's ID.
                    example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
                  name:
                    type: string
                    description: The folder's name.
                    example: Test Folder
                  description:
                    type: string
                    description: The folder's description.
                    example: This is a test collection folder.
                  createdAt:
                    type: string
                    format: date-time
                    description: The folder'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 folder was last updated.
                    example: '2022-08-29T16:49:19.964Z'
                  owner:
                    type: string
                    description: The user ID of the folder's owner.
                    example: '12345678'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the folder.
                    example: '12345678'
                  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: 24977100955
                  collection:
                    type: string
                    description: The collection ID that the folder belongs to.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                  folder:
                    type: string
                    nullable: true
                    description: Information about the folder.
                    example: null
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The folder's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              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: 24994132707
          example:
            data:
              id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              auth: null
              name: Test Folder
              order: []
              owner: '12345678'
              events: null
              folder: null
              createdAt: '2022-08-29T16:49:19.964Z'
              updatedAt: '2022-08-29T16:49:19.964Z'
              variables: null
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              description: This is a test folder.
              lastRevision: 24977100955
              folders_order: []
              lastUpdatedBy: '12345678'
            meta:
              model: folder
              action: update
            model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
            revision: 24977103385
    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
    getCollectionRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              model_id:
                type: string
                description: The request's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              data:
                type: object
                additionalProperties: true
                description: Information about the request. For a complete list of properties, refer to the **Request** 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 request's ID.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  name:
                    type: string
                    description: The request's name.
                    example: Test Folder
                  owner:
                    type: string
                    description: The user ID of the request's owner.
                    example: '12345678'
                  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 request.
                    example: '12345678'
                  createdAt:
                    type: string
                    format: date-time
                    description: The request'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 request was last updated.
                    example: '2022-08-29T16:49:19.964Z'
          example:
            model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
            meta:
              model: request
              populate: false
              changeset: false
              action: find
            data:
              owner: '12345678'
              lastUpdatedBy: '12345678'
              lastRevision: 32206434799
              folder: null
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              id: c82dd02c-4870-4907-8fcb-593a876cf05b
              name: Example GET Request
              dataMode: null
              data: null
              auth: null
              events: null
              rawModeData: null
              descriptionFormat: null
              description: This is an example GET request.
              variables: null
              headers: null
              method: GET
              pathVariables: {}
              url: https://postman-echo.com/get
              preRequestScript: null
              tests: var data = JSON.parse(responseBody);
              currentHelper: null
              helperAttributes: null
              queryParams:
              - key: id
                value: '{{id}}'
                equals: true
                description: Optional. The user's ID.
                enabled: true
              headerData: []
              pathVariableData: []
              protocolProfileBehavior:
                disableBodyPruning: true
              dataDisabled: false
              responses_order: []
              createdAt: '2023-08-22T12:52:01.000Z'
              updatedAt: '2023-08-22T12:52:11.000Z'
    updateCollectionRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                additionalProperties: true
                description: Information about the updated request. For a complete list of properties, refer to the **Request** 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 request's ID.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  name:
                    type: string
                    description: The request's name.
                    example: Example GET request
                  description:
                    type: string
                    description: The request's description.
                    example: This is an example GET request.
                  createdAt:
                    type: string
                    format: date-time
                    description: The request'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 request was last updated.
                    example: '2022-08-29T16:49:19.964Z'
                  owner:
                    type: string
                    description: The user ID of the request's owner.
                    example: '12345678'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the request.
                    example: '12345678'
                  lastRevision:
                    type: integer
                    format: int64
                    example: 24994863800
                    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.
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The request's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              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: 24994954828
          example:
            model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
            meta:
              model: request
              action: update
            data:
              id: c82dd02c-4870-4907-8fcb-593a876cf05b
              name: Example POST Request
              dataMode: raw
              data: null
              auth: noauth
              events: null
              rawModeData: "{\n    \"field\": \"Value\"\n}"
              descriptionFormat: null
              description: This is an example POST request.
              variables: null
              headers: null
              method: POST
              pathVariables: null
              url: https://postman-echo.com/post
              preRequestScript: null
              tests: null
              currentHelper: null
              helperAttributes: null
              queryParams: []
              headerData: []
              pathVariableData: []
              protocolProfileBehavior: null
              dataDisabled: false
              responses_order: []
              createdAt: '2023-09-01T07:59:25.000Z'
              updatedAt: '2023-09-08T12:30:29.000Z'
              owner: '12345678'
              lastUpdatedBy: '12345678'
              lastRevision: 32473087936
              folder: null
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              dataOptions:
                raw:
                  language: json
            revision: 32473098909
    getCollectionFolder:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              model_id:
                type: string
                description: The folder's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              data:
                type: object
                description: Information about the folder. For a complete list of properties, refer to the **Folders** 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 folder's ID.
                    example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
                  name:
                    type: string
                    description: The folder's name.
                    example: Test Folder
                  description:
                    type: string
                    description: The folder's description.
                    example: This is a test collection folder.
                  createdAt:
                    type: string
                    format: date-time
                    description: The folder'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 folder was last updated.
                    example: '2022-08-29T16:49:19.964Z'
                  owner:
                    type: string
                    description: The user ID of the folder's owner.
                    example: '12345678'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the folder.
                    example: '12345678'
                  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
                  collection:
                    type: string
                    description: The collection ID that the folder belongs to.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
          example:
            model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
            meta:
              model: folder
              populate: false
              changeset: false
              action: find
            data:
              owner: '12345678'
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              folder: null
              id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              name: Test Folder
              description: This is a test collection folder.
              variables: null
              auth:
                type: apikey
                apikey:
                - key: value
                  value: XXX
                - key: key
                  value: x-api-key
              events: null
              order:
              - 81b49e05-0b87-4ca4-ac8c-091aaedafea3
              - 929acf24-4234-45e1-59cf-dc2b27ea7603
              - 3cfc2ac8-00a9-47d2-415d-049773f23268
              folders_order:
              - 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              - 5c341de9-5751-461f-b7bd-af86bbae740c
              createdAt: '2022-08-29T16:49:19.964Z'
              updatedAt: '2022-08-29T16:49:19.964Z'
    deleteCollectionFolder:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                description: The folder's information.
                properties:
                  id:
                    type: string
                    description: The folder's ID.
                    example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
                  owner:
                    type: string
                    description: The user ID of the folder's owner.
                    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 folder's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              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: 24994562696
          example:
            model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
            meta:
              model: folder
              action: destroy
            data:
              id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              owner: '12345678'
            revision: 24994562696
    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
    collectionRequest401Error:
      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: request
                      owner:
                        type: string
                        description: The user ID of the request's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The request's ID.
                        example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  message:
                    type: string
                    description: The error message.
                    example: Unauthorized
          example:
            error:
              name: Unauthorized
              details:
                model: request
                owner: '12345678'
                model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
              message: Unauthorized
    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'
    collectionRequest400Error:
      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: request
                      owner:
                        type: string
                        description: The user ID of the request's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The request's ID.
                        example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  message:
                    type: string
                    description: The error message.
                    example: This request already exists in the database.
          example:
            error:
              name: instanceFoundError
              details:
                model: request
                owner: '12345678'
                model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
              message: This request already exists in the database.
    createCollectionFolder:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                description: Information about the collection folder. For a complete list of properties, refer to 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 folder's ID.
                    example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
                  name:
                    type: string
                    description: The folder's name.
                    example: Test Folder
                  order:
                    type: array
                    description: A list of request IDs and their order in the created folder.
                    items:
                      type: string
                    uniqueItems: true
                    example: []
                  owner:
                    type: string
                    description: The user ID of the folder's owner.
                    example: '12345678'
                  folder:
                    type: string
                    nullable: true
                    description: Information about the folder.
                    example: null
                  folders:
                    type: array
                    description: A list of folders.
                    items:
                      type: string
                    example: []
                  requests:
                    type: array
                    description: A list of requests.
                    items:
                      type: string
                  createdAt:
                    type: string
                    format: date-time
                    description: The folder'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 folder was last updated.
                    example: '2022-08-29T16:49:19.964Z'
                  collection:
                    type: string
                    description: The collection ID that the folder belongs to.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                  description:
                    type: string
                    description: The folder's description.
                    example: This is a test collection folder.
                  folders_order:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    description: A list of folder IDs and their order in the collection.
                    example: []
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the folder.
                    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 folder's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              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: 24994132707
          example:
            data:
              id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              name: Test Folder
              order: []
              owner: '12345678'
              folder: null
              folders: []
              requests: []
              createdAt: '2022-08-29T16:49:19.964Z'
              updatedAt: '2022-08-29T16:49:19.964Z'
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              description: This is a test collection folder.
              folders_order: []
              lastUpdatedBy: '12345678'
            meta:
              model: folder
              action: import
            model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
            revision: 24994132707
    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'
    collectionFolder400Error:
      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: folder
                      owner:
                        type: string
                        description: The user ID of the folder's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The folder's ID.
                        example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
                  message:
                    type: string
                    description: The error message.
                    example: This folder already exists in the database.
          example:
            error:
              name: instanceNotFoundError
              details:
                model: folder
                owner: '12345678'
                model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              message: We could not find the folder you are looking for
    deleteCollectionRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              model_id:
                type: string
                description: The request's ID.
                example: c82dd02c-4870-4907-8fcb-593a876cf05b
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              data:
                type: object
                description: The request's information.
                properties:
                  id:
                    type: string
                    description: The request's ID.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  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: 24995158577
          example:
            model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
            meta:
              model: request
              action: destroy
            data:
              id: c82dd02c-4870-4907-8fcb-593a876cf05b
              owner: '12345678'
            revision: 24995158577
    collectionFolder401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: Unauthorized
                  message:
                    type: string
                    description: The error message.
                    example: Unauthorized
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: folder
                      owner:
                        type: string
                        description: The user ID of the folder's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The folder's ID.
                        example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
          example:
            error:
              name: Unauthorized
              message: Unauthorized
              details:
                model: folder
                model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
                owner: '12345678'
    collectionFolder404Error:
      description: Not Found
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceNotFoundError
                  message:
                    type: string
                    description: The error message.
                    example: We could not find the folder you are looking for
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: folder
                      owner:
                        type: string
                        description: The user ID of the folder's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The folder's ID.
                        example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
          example:
            error:
              name: instanceNotFoundError
              message: We could not find the folder you are looking for
              details:
                model: folder
                owner: '12345678'
                model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
    createCollectionRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                additionalProperties: true
                description: Information about the created request. For a complete list of properties, refer to the **Request** 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 request's ID.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  name:
                    type: string
                    description: The request's name.
                    example: Test Request
                  owner:
                    type: string
                    description: The user ID of the request's owner.
                    example: '12345678'
                  folder:
                    type: string
                    nullable: true
                    description: Information about the request's parent folder.
                    example: null
                  responses:
                    type: array
                    description: A list of the request's responses.
                    items:
                      type: string
                    example: []
                  collection:
                    type: string
                    description: The collection ID that the request belongs to.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                  responses_order:
                    type: array
                    description: A list of response IDs and their order in the folder.
                    items:
                      type: string
                    uniqueItems: true
                    example: []
                  createdAt:
                    type: string
                    format: date-time
                    description: The requeset's creation date and time.
                    example: '2022-08-29T16:35:38.831Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the request was last updated.
                    example: '2022-08-29T16:35:38.831Z'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the folder.
                    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 request's ID.
                example: c82dd02c-4870-4907-8fcb-593a876cf05b
              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: 26531992398
          example:
            model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
            meta:
              model: request
              action: import
            data:
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              method: GET
              headers:
              - key: Host
                value: postman-echo.com
              - key: user-agent
                value: curl/7.88.1
              - key: accept
                value: '*/*'
              - key: content-type
                value: application/json
              dataMode: raw
              url: https://postman-echo.com/get?param=value
              name: Example GET Request
              description: This is an example GET request.
              owner: '12345678'
              folder: null
              responses_order: []
              id: c82dd02c-4870-4907-8fcb-593a876cf05b
              lastUpdatedBy: '12345678'
              queryParams:
              - key: id
                value: '{{id}}'
                equals: true
                description: Optional. The user's ID.
                enabled: true
              headerData: []
              createdAt: '2023-09-07T13:33:17.912Z'
              updatedAt: '2023-09-07T13:33:17.912Z'
              rawModeData: null
              dataOptions:
                raw:
                  language: json
              responses: []
            revision: 32456338071
  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
    updateCollectionRequest:
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
            description: The request properties to update. For a complete list of properties, refer to the **Request** property 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 request's name.
                example: Example GET request
              method:
                type: string
                description: The request's method.
                enum:
                - GET
                - PUT
                - POST
                - PATCH
                - DELETE
                - COPY
                - HEAD
                - OPTIONS
                - LINK
                - UNLINK
                - PURGE
                - LOCK
                - UNLOCK
                - PROPFIND
                - VIEW
                example: GET
          example:
            oauth: noauth
            currentHelper: null
            helperAttributes: null
            owner: '12345678'
            lastUpdatedBy: '12345678'
            lastRevision: 32368133476
            folder: null
            collection: c05fb60e-bb28-4e7b-9cf7-55ada6ab320c
            name: Example POST Request
            dataMode: raw
            data: null
            events: null
            rawModeData: "{\n    \"field\": \"Value\"\n}"
            descriptionFormat: null
            description: This is an example POST request.
            variables: null
            headers: null
            method: POST
            pathVariables: null
            url: https://postman-echo.com/post
            preRequestScript: null
            tests: null
            queryParams: []
            headerData: []
            pathVariableData: []
            protocolProfileBehavior: null
            dataDisabled: false
            responses_order: []
            createdAt: '2023-09-01T07:59:25.000Z'
            updatedAt: '2023-09-01T09:29:54.000Z'
            dataOptions:
              raw:
                language: json
    createCollectionFolder:
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
            description: 'Information about the collection folder. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).


              **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 folder with a blank name.

              '
            properties:
              name:
                type: string
                example: Test Folder
                description: The folder'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 folder with a blank name.
              folder:
                type: string
                format: uid
                description: The ID of a folder in which to create the folder.
                example: 12345678-65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
          example:
            name: Test Folder
            description: This is a test collection folder.
    createCollectionRequest:
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
            description: 'Information about the request. For a complete list of properties, refer to the **Request** property in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).


              **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 request with a blank name.

              '
            properties:
              name:
                type: string
                example: Test Request
                description: The request'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 request with a blank name.
          example:
            name: Example GET Request
            description: This is an example GET request.
            url: https://postman-echo.com/get?param=value
            method: GET
            headers:
            - key: Host
              value: postman-echo.com
            - key: user-agent
              value: curl/7.88.1
            - key: accept
              value: '*/*'
            - key: content-type
              value: application/json
            queryParams:
            - key: id
              value: '{{id}}'
              equals: true
              description: Optional. The user's ID.
              enabled: true
            dataMode: raw
            rawModeData: null
            dataOptions:
              raw:
                language: json
    updateCollectionFolder:
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
            description: The folder properties to update. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
            properties:
              name:
                type: string
                description: The folder's name.
                example: Test Folder
              description:
                type: string
                description: The folder's description.
                example: This is a test folder.
          example:
            name: Test Folder
            description: This is a test folder.
  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