APIs.io Engineering Platform Collections API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Collections 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: Collections
  description: The **Collections** endpoints enable you to manage your Postman [Collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/).
paths:
  /apis/{apiId}/collections:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/v10Accept'
    post:
      summary: APIs.io Engineering Platform Add a collection
      description: "Adds a collection to an API. To do this, use the following `operationType` values:\n\n- `COPY_COLLECTION` — Copies a collection from the workspace and adds it to an API.\n- `CREATE_NEW` — Creates a new collection by providing the new collection's content.\n- `GENERATE_FROM_SCHEMA` — Generates the collection from an API schema.\n    - `options` — An object that contains advanced creation options and their values. You can find a complete list of properties and their values in Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive.\n"
      operationId: addApiCollection
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/addApiCollection'
      responses:
        '200':
          $ref: '#/components/responses/addApiCollection'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema403ErrorForbidden'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/apiSchema403ErrorForbidden'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}/collections/{collectionId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/collectionIdApi'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get a collection
      description: 'Gets a collection attached to an API. You can use the `versionId` query parameter to get a collection published in a version.


        **Note:**


        - You cannot use this endpoint to get a Git-linked API collection. Collections in a Git-linked API are stored in the linked Git repository, not in the Postman cloud. This endpoint only has access to Postman servers.

        - You can get a collection published in an API version with the `versionId` query parameter.

        - The `versionId` query parameter is a required parameter for API viewers.

        '
      operationId: getApiCollection
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getApiCollection'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/api400ErrorVersionIdMissing'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Version ID Missing:
                  $ref: '#/components/examples/api400ErrorVersionIdMissing'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/apiCollection404ErrorNotFound'
        '422':
          $ref: '#/components/responses/gitLinkedApi422Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/apiVersionQuery'
  /apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/collectionIdApi'
    - $ref: '#/components/parameters/v10Accept'
    put:
      summary: APIs.io Engineering Platform Sync collection with schema
      description: 'Syncs a collection attached to an API with the API schema.


        This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. The response contains a polling link to the `/apis/{apiId}/tasks/{taskId}` endpoint in the `Location` header.


        **Note:**


        This endpoint only supports the OpenAPI 3 schema type.

        '
      operationId: syncCollectionWithSchema
      tags:
      - Collections
      responses:
        '202':
          $ref: '#/components/responses/syncCollectionWithSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiCollection400InvalidParam'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Invalid Parameter:
                  $ref: '#/components/examples/apiCollection400InvalidParam'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema403ErrorForbidden'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/apiSchema403ErrorForbidden'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/apiSchema404ErrorNotFound'
        '422':
          $ref: '#/components/responses/apiSchema422ErrorActionNotAllowed'
        '500':
          $ref: '#/components/responses/common500Error'
  /collection-access-keys:
    get:
      summary: APIs.io Engineering Platform Get collection access keys
      description: 'Gets the authenticated user''s personal and team [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key).


        **Note:**


        - The `expiresAfter` property in the response represents the date and time at which the access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days.

        - If the collection key is unused, the `lastUsedAt` property in the response returns an empty string.

        '
      operationId: getCollectionAccessKeys
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollectionAccessKeys'
        '400':
          $ref: '#/components/responses/common400ErrorInvalidCursor'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403ErrorForbidden'
        '500':
          $ref: '#/components/responses/common500ErrorSomethingWrong'
      parameters:
      - $ref: '#/components/parameters/collectionUidQuery'
      - $ref: '#/components/parameters/cursor'
  /collection-access-keys/{keyId}:
    delete:
      summary: APIs.io Engineering Platform Delete a collection access key
      description: 'Deletes a collection access key. To get a collection access key''s ID, use the GET `/collection-access-key` endpoint.


        On success, this returns an HTTP `204 No Content` response.

        '
      operationId: deleteCollectionAccessKey
      tags:
      - Collections
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403ErrorForbidden'
        '404':
          $ref: '#/components/responses/cakNotFound404Error'
        '500':
          $ref: '#/components/responses/common500ErrorSomethingWrong'
      parameters:
      - $ref: '#/components/parameters/collectionAccessKeyId'
  /collections:
    get:
      summary: APIs.io Engineering Platform Get all collections
      description: Gets all of your [collections](https://www.getpostman.com/docs/collections). The response includes all of your subscribed collections.
      operationId: getCollections
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollections'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceQuery'
      - $ref: '#/components/parameters/collectionNameQuery'
    post:
      summary: APIs.io Engineering Platform Create a collection
      description: "Creates a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\n- If you do not include the `workspace` query parameter, the system creates the collection in your \"My Workspace\" workspace.\n- For a complete list of available property values for this endpoint, use the following references available in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html):\n    - `info` object — Refer to the **Information** entry.\n    - `item` object — Refer to the **Items** entry.\n- For all other possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n"
      operationId: createCollection
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/createCollection'
      responses:
        '200':
          $ref: '#/components/responses/createCollection'
        '400':
          $ref: '#/components/responses/collection400ErrorInstanceFound'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/workspaceQuery'
  /collections/fork/{collectionId}:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    post:
      summary: APIs.io Engineering Platform Create a fork
      description: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) from an existing collection into a workspace.
      operationId: createCollectionFork
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/createCollectionFork'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionFork'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/forkWorkspaceQuery'
  /collections/merge:
    post:
      summary: APIs.io Engineering Platform Merge a fork
      description: Merges a forked collection back into its parent collection. You must have the [Editor role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) for the collection to merge a fork.
      operationId: mergeCollectionFork
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/mergeCollectionFork'
      responses:
        '200':
          $ref: '#/components/responses/mergeCollectionFork'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403ErrorForbiddenError'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /collections/{collectionId}:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a collection
      description: Gets information about a collection. For a complete list of this endpoint's possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      operationId: getCollection
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollection'
        '400':
          $ref: '#/components/responses/collection400ErrorCollectionNotFound'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/collectionAccessKeyQuery'
      - $ref: '#/components/parameters/collectionModelQuery'
    put:
      summary: APIs.io Engineering Platform Replace a collection's data
      description: 'Replaces the contents of a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). Include the collection''s ID values in the request body. If you do not, the endpoint removes the existing items and creates new items.


        > The maximum collection size this endpoint accepts cannot exceed 20 MB.


        For a complete list of available property values for this endpoint, use the following references available in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html):

        - `info` object — Refer to the **Information** entry.

        - `item` object — Refer to the **Items** entry.


        For all other possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        To copy another collection''s contents to the given collection, remove all ID values before you pass it in this endpoint. If you do not, this endpoint returns an error. These values include the `id`, `uid`, and `postman_id` values.

        '
      operationId: putCollection
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/putCollection'
      responses:
        '200':
          $ref: '#/components/responses/putCollection'
        '400':
          $ref: '#/components/responses/collection400ErrorMalformedRequest'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    patch:
      summary: APIs.io Engineering Platform Update part of a collection
      description: 'Updates specific collection information, such as its name, events, or its variables. For more information about the `auth`, `variables`, and `events` properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html):

        - For `variables`, refer to the **Variable List** entry.

        - For `auth`, refer to the **Auth** entry.

        - For `events`, refer to the **Event List** entry.

        '
      operationId: patchCollection
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/patchCollection'
      responses:
        '200':
          $ref: '#/components/responses/patchCollection'
        '400':
          $ref: '#/components/responses/collection400ErrorInvalidKeyParam'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Delete a collection
      description: Deletes a collection.
      operationId: deleteCollection
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/deleteCollection'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /collections/{collectionId}/collection-forks:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get all forked collections
      description: Gets a list of all the authenticated user's forked collections.
      operationId: getCollectionsForkedByUser
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollectionsForkedByUser'
        '400':
          $ref: '#/components/responses/fork400ErrorNoUserFound'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/createdAtSort'
  /collections/{collectionId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    get:
      summary: APIs.io Engineering Platform Get a collection's comments
      description: Gets all comments left by users in a collection.
      operationId: getCollectionComments
      tags:
      - Collections
      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 collection comment
      description: 'Creates a comment on a collection.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Collections
      operationId: createCollectionComment
      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}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a collection's comment
      description: 'Updates a comment on a collection.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateCollectionComment
      tags:
      - Collections
      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 collection's comment
      description: 'Deletes a comment from a collection. 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: deleteCollectionComment
      tags:
      - Collections
      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}/forks:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a collection's forks
      description: Gets a collection's forked collections. The response returns data for each fork, such as the fork's ID, the user who forked it, and the fork's creation date.
      operationId: getCollectionForks
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollectionForks'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorNoForks'
        '404':
          $ref: '#/components/responses/fork404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/createdAtSort'
  /collections/{collectionId}/pulls:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    put:
      summary: APIs.io Engineering Platform Pull source changes
      description: 'Pulls the changes from a parent (source) collection into the forked collection. In the endpoint''s response:


        - The `destinationId` is the ID of the forked collection.

        - The `sourceId` is the ID of the source collection.

        '
      operationId: pullCollectionChanges
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/pullCollectionChanges'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorBadId'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/pull-requests:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    get:
      summary: APIs.io Engineering Platform Get a collection's pull requests
      description: Gets information about a collection's pull requests, such as the source and destination IDs, status of the pull requests, and a URL link to the pull requests.
      operationId: getCollectionPullRequests
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollectionPullRequests'
        '403':
          $ref: '#/components/responses/pullRequest403ErrorRolePermissionsCollection'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    post:
      summary: APIs.io Engineering Platform Create a pull request
      description: Creates a pull request for a forked collection into its parent collection.
      operationId: createCollectionPullRequest
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/pullRequestCreate'
      responses:
        '200':
          $ref: '#/components/responses/pullRequestCreated'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/forkCollection400ErrorBadForkRelation'
                - $ref: '#/components/schemas/pullRequest400ErrorDuplicate'
              examples:
                Invalid Fork Source:
                  $ref: '#/components/examples/forkCollection400ErrorBadForkRelation'
                Pull Request Already Exists:
                  $ref: '#/components/examples/pullRequest400ErrorDuplicate'
        '403':
          $ref: '#/components/responses/pullRequest403ErrorNoViewerAccessCollections'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /collections/{collectionId}/roles:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a collection's roles
      description: Gets information about all roles in a collection. The response returns the IDs of all users, teams, and groups with access to view or edit the collection.
      operationId: getCollectionRoles
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getCollectionRoles'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '404':
          $ref: '#/components/responses/collection404ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
    patch:
      summary: APIs.io Engineering Platform Update a collection's roles
      description: 'Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        - Only users assigned the EDITOR [role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) in the collection can use this endpoint.

        - This endpoint does not support the external [Partner or Guest roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).

        '
      operationId: updateCollectionRoles
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/updateCollectionRoles'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/collectionRoles400ErrorMissingProperty'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/common403ErrorPermissions'
        '404':
          $ref: '#/components/responses/collection404ErrorInstanceNotFound'
        '500':
          $ref: '#/components/responses/common500ErrorInternalServer'
  /collections/{collectionId}/source-status:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get source collection's status
      description: 'Checks whether there is a change between the forked collection and its parent (source) collection.


        If the value of the `isSourceAhead` property is `true` in the response, then there is a difference between the forked collection and its source collection.


        **Note:**


        This endpoint may take a few minutes to return an updated `isSourceAhead` status.

        '
      operationId: getSourceCollectionStatus
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/getSourceCollectionStatus'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorNotForked'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/transformations:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Transform collection to OpenAPI
      description: 'Transforms an existing Postman Collection into a stringified OpenAPI definition.


        **Note:**


        This does not create an API.

        '
      operationId: transformCollectionToOpenAPI
      tags:
      - Collections
      responses:
        '200':
          $ref: '#/components/responses/transformCollectionToOpenAPI'
        '401':
          $ref: '#/components/responses/collectionToApi401Error'
        '404':
          $ref: '#/components/responses/collectionToApi404Error'
        '500':
          $ref: '#/components/responses/collectionToApi500Error'
      parameters:
      - $ref: '#/components/parameters/collectionTransformFormat'
  /collection-folders-transfers:
    post:
      summary: APIs.io Engineering Platform Transfer folders
      description: Copies or moves folders into a collection or folder.
      operationId: transferCollectionFolders
      tags:
      - Collections
      requestBody:
        $ref: '#/components/requestBodies/transferCollectionItems'
      responses:
        '200':
          $ref: '#/components/responses/transferCollectionItems200Error'
        '400':
          $ref: '#/components/responses/transferCollectionItems400Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /collectio

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