openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Collection Folders 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 Folders
  description: The **Collection Folders** endpoints enable you to manage collection folders.
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 Folders
      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}/folders/{folderId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionFolderUid'
    get:
      summary: APIs.io Engineering Platform Get a folder's comments
      description: Gets all comments left by users in a folder.
      operationId: getFolderComments
      tags:
      - Collection Folders
      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 folder comment
      description: 'Creates a comment on a folder.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Collection Folders
      operationId: createFolderComment
      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}/folders/{folderId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionFolderUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a folder's comment
      description: 'Updates a comment on a folder.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateFolderComment
      tags:
      - Collection Folders
      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 folder's comment
      description: 'Deletes a comment from a folder. 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: deleteFolderComment
      tags:
      - Collection Folders
      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}/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 Folders
      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 Folders
      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 Folders
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionFolder'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '404':
          $ref: '#/components/responses/collectionFolder404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  parameters:
    collectionFolderId:
      name: folderId
      in: path
      required: true
      description: The folder's ID.
      schema:
        $ref: '#/components/schemas/collectionFolderId'
    collectionFolderUid:
      name: folderId
      in: path
      required: true
      description: The folder's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
    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
    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'
  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.
    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
    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
    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
    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
    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
    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
    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
    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.
  schemas:
    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
    collectionFolderId:
      type: string
      example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
    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
  requestBodies:
    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.
    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.
    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