APIs.io Engineering Platform Collection Requests API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Collection Requests 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
    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 Requests
  description: The **Collection Requests** endpoints enable you to manage collection requests.
paths:
  /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 Requests
      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}/requests/{requestId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionRequestUid'
    get:
      summary: APIs.io Engineering Platform Get a request's comments
      description: Gets all comments left by users in a request.
      operationId: getRequestComments
      tags:
      - Collection Requests
      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 request comment
      description: 'Creates a comment on a request.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Collection Requests
      operationId: createRequestComment
      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}/requests/{requestId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionRequestUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a request's comment
      description: 'Updates a comment on a request.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateRequestComment
      tags:
      - Collection Requests
      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 request's comment
      description: 'Deletes a comment from a request. 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: deleteRequestComment
      tags:
      - Collection Requests
      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}/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 Requests
      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 Requests
      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 Requests
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionRequest'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  schemas:
    collectionRequestId:
      type: string
      example: c82dd02c-4870-4907-8fcb-593a876cf05b
    commentCreateUpdate:
      title: Comment Payload Object
      type: object
      description: Information about the comment.
      required:
      - body
      properties:
        body:
          type: string
          description: The contents of the comment.
          example: This is an example.
        tags:
          type: object
          description: Information about users tagged in the `body` comment.
          properties:
            userName:
              type: object
              required:
              - type
              - id
              description: An object that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`.
              properties:
                type:
                  type: string
                  description: The `user` value.
                  enum:
                  - user
                  example: user
                id:
                  type: integer
                  description: The user's ID.
                  example: 87654321
    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
  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.
    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
    common500Error:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/internal-server-error
              title:
                type: string
                description: A short summary of the problem.
                example: Internal Server Error
              detail:
                type: string
                description: Information about the error.
                example: Internal Server Error
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
    comment500Error:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/internal-server-error
              title:
                type: string
                description: A short summary of the problem.
                example: Internal Server Error
              detail:
                type: string
                description: Information about the error.
                example: Internal Server Error
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 500
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
            status: 500
    comment401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: Unauthorized
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: Unauthorized
            status: 401
    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
    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
    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

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-collection-requests-api-openapi.yml