openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Forks 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: Forks
  description: The **Forks** endpoints enable you to manage element [forks](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/). Forks are new instances of an element that you can change without making any changes to the parent element.
paths:
  /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:
      - Forks
      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:
      - Forks
      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}/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:
      - Forks
      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}/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:
      - Forks
      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:
      - Forks
      responses:
        '200':
          $ref: '#/components/responses/pullCollectionChanges'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorBadId'
        '404':
          $ref: '#/components/responses/instanceNotFoundCollection'
        '500':
          $ref: '#/components/responses/common500Error'
  /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:
      - Forks
      responses:
        '200':
          $ref: '#/components/responses/getSourceCollectionStatus'
        '400':
          $ref: '#/components/responses/forkCollection400ErrorNotForked'
        '500':
          $ref: '#/components/responses/common500Error'
  /environments/{environmentId}/forks:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Create a fork
      description: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/) of an existing environment.
      operationId: forkEnvironment
      tags:
      - Forks
      requestBody:
        $ref: '#/components/requestBodies/forkEnvironment'
      responses:
        '200':
          $ref: '#/components/responses/forkEnvironment'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/workspaceIdQueryTrue'
    get:
      summary: APIs.io Engineering Platform Get an environment's forks
      description: Gets all of an environment's forked environments.
      operationId: getEnvironmentForks
      tags:
      - Forks
      responses:
        '200':
          $ref: '#/components/responses/getEnvironmentForks'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/directionQuery'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/sortByCreatedAt'
  /environments/{environmentId}/merges:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Merge a fork
      description: '[Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked environment back into its parent environment.

        '
      operationId: mergeEnvironmentFork
      tags:
      - Forks
      requestBody:
        $ref: '#/components/requestBodies/mergeEnvironmentFork'
      responses:
        '200':
          $ref: '#/components/responses/mergeEnvironmentFork'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /environments/{environmentId}/pulls:
    parameters:
    - $ref: '#/components/parameters/environmentUid'
    post:
      summary: APIs.io Engineering Platform Pull source changes
      description: '[Pulls](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#pull-updates-from-a-parent-element) the changes from a parent (source) environment into the forked environment.

        '
      operationId: pullEnvironment
      tags:
      - Forks
      requestBody:
        $ref: '#/components/requestBodies/pullEnvironment'
      responses:
        '200':
          $ref: '#/components/responses/pullEnvironment'
        '400':
          $ref: '#/components/responses/environmentForks400Error'
        '401':
          $ref: '#/components/responses/common401Error'
        '404':
          $ref: '#/components/responses/environmentForks404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  responses:
    forkCollection400ErrorBadId:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: badRequest
                  message:
                    type: string
                    description: The error message.
                    example: The collection Id is not a forked collection.
          example:
            collection:
              name: badRequest
              message: The collection Id is not a forked collection.
    environmentForks404Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              title:
                type: string
                description: A short summary of the error.
                example: Not Found
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 404
              detail:
                type: string
                description: Details about the occurrence of the error.
                example: We could not find the environment you are looking for
              type:
                type: string
                format: uri
                description: The error type.
                example: https://api.postman.com/problems/notFound
          example:
            title: We could not find the environment you are looking for
            status: 404
            detail: We could not find the environment you are looking for
            type: https://api.postman.com/problems/notFound
    pullEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                description: Information about the merged environment.
                properties:
                  uid:
                    type: string
                    format: uid
                    description: The merged environment's unique ID.
                    example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
          example:
            environment:
              uid: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
    environmentForks400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The type of error.
                example: https://api.postman.com/problems/bad-request
              title:
                type: string
                description: The title of the error message.
                example: The environment Id is not a forked environment.
              detail:
                type: object
                description: Details about the error message.
                example: {}
          examples:
            environmentNotForked:
              value:
                type: https://api.postman.com/problems/bad-request
                title: The environment Id is not a forked environment.
                detail: {}
    forkCollection400ErrorNoForks:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: badRequest
                  message:
                    type: string
                    description: The error message.
                    example: This collection id has no forks.
          example:
            collection:
              name: badRequest
              message: This collection id has no forks.
    getSourceCollectionStatus:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              collection:
                type: object
                properties:
                  collectionUid:
                    type: object
                    description: Information about the forked collection. The object's name is the forked collection's UID (`userId`-`collectionId`).
                    properties:
                      isSourceAhead:
                        type: boolean
                        description: If true, there is a difference between the forked collection and its source collection.
                        example: false
          example:
            collection:
              12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2:
                isSourceAhead: false
    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
    common403ErrorForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: forbiddenError
                  message:
                    type: string
                    description: The error message.
                    example: You do not have enough permissions to perform this action.
          example:
            error:
              name: forbiddenError
              message: You do not have enough permissions to perform this action.
    getCollectionsForkedByUser:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                description: A list of the user's forked collections.
                items:
                  type: object
                  description: Information about the forked collection.
                  properties:
                    forkName:
                      type: string
                      description: The forked collection's label.
                      example: Collection Fork
                    forkId:
                      type: string
                      format: uid
                      description: The forked collection's ID.
                      example: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f
                    sourceId:
                      type: string
                      description: The ID of the forked collection's source collection.
                      example: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the fork was created.
                      example: '2023-11-16T09:18:17.000Z'
              meta:
                type: object
                description: The response's meta information for paginated results.
                properties:
                  total:
                    type: number
                    description: The total number of forked collections.
                    example: 2
                  nextCursor:
                    type: string
                    nullable: true
                    format: base64
                    description: The pagination cursor that points to the next record in the results set.
                    example: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ==
                  inaccessibleFork:
                    type: number
                    description: The total number of forked collections that the user cannot access.
                    example: 0
          example:
            data:
            - forkName: Collection Fork
              forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f
              sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d
              createdAt: '2023-11-16T09:18:17.000Z'
            - forkName: Test Fork
              forkId: 12345678-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f
              sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d
              createdAt: '2023-11-16T09:16:15.000Z'
            meta:
              total: 2
              nextCursor: null
              inaccessibleFork: 0
    mergeEnvironmentFork:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                description: Information about the merged environment.
                properties:
                  uid:
                    type: string
                    format: uid
                    description: The merged environment's ID.
                    example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
          example:
            environment:
              uid: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
    createCollectionFork:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              collection:
                type: object
                description: Information about the forked collection.
                properties:
                  id:
                    type: string
                    description: The forked collection's ID.
                    example: 09547fef-a9a5-4e00-998b-aa563e8db69a
                  name:
                    type: string
                    description: The collection's name.
                    example: Test Collection
                  fork:
                    type: object
                    description: Information about the collection's fork.
                    properties:
                      label:
                        type: string
                        description: The fork's label.
                        example: Test Fork
                      createdAt:
                        type: string
                        format: date-time
                        description: The fork's creation date and time.
                        example: '2022-06-16T19:51:44.069Z'
                      from:
                        type: string
                        format: uid
                        description: The unique ID of fork's source collection.
                        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                  uid:
                    type: string
                    format: uid
                    description: The forked collection's unique ID.
                    example: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a
          example:
            collection:
              id: 09547fef-a9a5-4e00-998b-aa563e8db69a
              name: Test Collection
              fork:
                label: Test Fork
                createdAt: '2022-06-16T19:51:44.069Z'
                from: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              uid: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a
    pullCollectionChanges:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              collection:
                type: object
                description: Information about the updated collection fork.
                properties:
                  destinationId:
                    type: string
                    format: uid
                    description: The ID of the forked collection the changes were pulled into.
                    example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                  sourceId:
                    type: string
                    format: uid
                    description: The ID of the source collection the changes were pulled from.
                    example: 12345678-45499451-e894-41b8-8c66-8191ab64932a
          example:
            collection:
              destinationId: 112345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              sourceId: 12345678-45499451-e894-41b8-8c66-8191ab64932a
    forkCollection400ErrorNotForked:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: badRequest
                  message:
                    type: string
                    description: The error message.
                    example: The collection is not a forked collection.
          example:
            collection:
              name: badRequest
              message: The collection is not a forked collection.
    getCollectionForks:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                description: A list of the collection's forks.
                items:
                  type: object
                  description: Information about the forked collection.
                  properties:
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the fork was created.
                      example: '2023-11-16T09:18:17.000Z'
                    createdBy:
                      type: string
                      description: The user who created the collection fork.
                      example: Taylor Lee
                    forkId:
                      type: string
                      format: uid
                      description: The forked collection's ID.
                      example: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f
                    forkName:
                      type: string
                      description: The forked collection's label.
                      example: Collection Fork
              meta:
                type: object
                description: The response's meta information for paginated results.
                properties:
                  nextCursor:
                    type: string
                    nullable: true
                    format: base64
                    description: The pagination cursor that points to the next record in the results set.
                    example: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ==
                  total:
                    type: number
                    description: The total number of forked collections.
                    example: 2
          example:
            data:
            - forkName: Collection Fork
              forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f
              createdBy: Taylor Lee
              createdAt: '2023-11-16T09:18:17.000Z'
            - forkName: Test Fork
              forkId: 87654321-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f
              createdBy: Alex Cruz
              createdAt: '2023-11-16T09:16:15.000Z'
            meta:
              total: 2
              nextCursor: null
    common401Error:
      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
    mergeCollectionFork:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              collection:
                type: object
                properties:
                  id:
                    type: string
                    description: The source collection's ID.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                  uid:
                    type: string
                    format: uid
                    description: The source collection's unique ID.
                    example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
          example:
            collection:
              id: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
    common500ErrorServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: serverError
                  message:
                    type: string
                    description: The error message.
                    example: An error has occurred on the server.
          example:
            error:
              name: serverError
              message: An error has occurred on the server.
    forkEnvironment:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              environment:
                type: object
                description: Information about the forked environment.
                properties:
                  uid:
                    type: string
                    format: uid
                    description: The forked environment's ID.
                    example: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25
                  name:
                    type: string
                    description: The name of the forked environment.
                    example: Testing Environment
                  forkName:
                    type: string
                    description: The forked environment's label.
                    example: Test Fork
          example:
            environment:
              uid: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25
              name: Testing Environment
              forkName: Test Fork
    fork404Error:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: notFoundError
                  message:
                    type: string
                    description: The error message.
                    example: Fork not found.
          example:
            collection:
              name: notFoundError
              message: Fork not found.
    instanceNotFoundCollection:
      description: Instance Not Found
      content:
        application/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: The specified item does not exist.
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      item:
                        type: string
                        description: The instance item.
                        example: collection
                      id:
                        type: string
                        description: The collection ID.
                        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
          example:
            error:
              name: instanceNotFoundError
              message: The specified item does not exist.
              details:
                item: collection
                id: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
    getEnvironmentForks:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                description: A list of the environment's forks.
                items:
                  type: object
                  description: Information about the forked environment.
                  properties:
                    forkId:
                      type: string
                      format: uid
                      description: The forked environment's unique ID.
                      example: 12345678-2fgh78uj-2ee3-8ugc-b678-7742d82e2e1f
                    forkName:
                      type: string
                      description: The forked environment's label.
                      example: my fork
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the fork was created.
                      example: '2023-11-16T09:18:17.000Z'
                    createdBy:
                      type: string
                      description: The user who created the environment fork.
                      example: Taylor Lee
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the fork was last updated.
                      example: '2023-11-16T09:18:17.000Z'
              meta:
                type: object
                description: The response's meta information for paginated results.
                properties:
                  total:
                    type: number
                    description: The total number of forked environments.
                    example: 6
                  nextCursor:
                    type: string
                    nullable: true
                    description: The pagination cursor that points to the next record in the results set.
                    example: null
          example:
            data:
            - forkId: 12345678-2fgh78uj-2ee3-8ugc-b678-7742d82e2e1f
              forkName: my fork
              createdAt: '2023-11-16T09:18:17.000Z'
              createdBy: Taylor Lee
              updatedAt: '2023-11-16T09:18:17.000Z'
            - forkId: 12345678-667df1ad-2ee3-6yhn-b678-7742d82e2e1f
              forkName: fork2
              createdAt: '2023-11-16T09:16:15.000Z'
              createdBy: Taylor Lee
              updatedAt: '2023-11-16T09:16:15.000Z'
            meta:
              total: 6
              nextCursor: null
    fork400ErrorNoUserFound:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: badRequest
                  message:
                    type: string
                    description: The error message.
                    example: No Postman User found for given filters
          example:
            collection:
              name: badRequest
              message: No Postman User found for given filters
  requestBodies:
    mergeCollectionFork:
      content:
        application/json:
          schema:
            required:
            - source
            - destination
            type: object
            properties:
              destination:
                type: string
                format: uid
                description: The destination (parent) collection's unique ID.
                example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              source:
                type: string
                format: uid
                description: The source collection's unique ID.
                example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              strategy:
                type: string
                description: 'The fork''s merge strategy:

                  - `deleteSource` — Merge the changes into the parent collection. After the merge process is complete, Postman deletes the fork. You must have Editor access to both the parent and forked collections.

                  - `updateSourceWithDestination` — Merge the changes into the parent collection. Any differences in the parent collection are also made to the fork.

                  '
                enum:
                - deleteSource
                - updateSourceWithDestination
                default: updateSourceWithDestination
                example: deleteSource
          example:
            strategy: deleteSource
            source: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
            destination: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a
    createCollectionFork:
      content:
        application/json:
          schema:
            type: object
            required:
            - label
            properties:
              label:
                type: string
                description: The fork's label.
                example: Test Fork
          example:
            label: Test Fork
    pullEnvironment:
      content:
        application/json:
          schema:
            type: object
            properties:
              source:
                type: string
                format: uid
                description: The source environment's unique ID to pull data from.
                example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
          example:
            source: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
    forkEnvironment:
      content:
        application/json:
          schema:
            type: object
            required:
            - forkName
            properties:
              forkName:
                type: string
                description: The forked environment's label.
                example: My fork
          examples:
            fork:
              value:
                forkName: My fork
    mergeEnvironmentFork:
      content:
        application/json:
          schema:
            required:
            - source
            type: object
            properties:
              source:
                type: string
                format: uid
                description: The source environment's unique ID to merge data from.
                example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
              deleteSource:
                type: boolean
                default: false
                description: If true, the forked environment will be deleted.
                example: false
          example:
            source: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957
            deleteSource: false
  parameters:
    directionQuery:
      name: direction
      in: query
      description: Sort results in ascending (`asc`) or descending (`desc`) order.
      schema:
        $ref: '#/components/schemas/ascDesc'
    collectionId:
      name: collectionId
      in: path
      required: true
      description: The collection's ID.
      schema:
        type: string
        example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
    environmentUid:
      name: environmentId
      in: path
      required: true
      description: The environment's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
    workspaceIdQueryTrue:
      name: workspaceId
      in: query
      required: true
      description: The workspace's ID.
      schema:
        $ref: '#/components/schemas/workspaceId'
    cursor:
      name: cursor
      in: query
      description: The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.
      schema:
        $ref: '#/components/schemas/cursor'
    limit:
      name: limit
      in: query
      description: The maximum number of rows to return in the response.
      schema:
        $ref: '#/components/schemas/limit'
    sortByCreatedAt:
      name: sort
      in: query
      description: Sort the results by the date and time of creation.
      schema:
        type: string
        enum:
        - createdAt
        example: createdAt
    createdAtSort:
      name: direction
      in: query
      description: Sort the results by creation date in ascending (`asc`) or descending (`desc`) order.
      schema:
        $ref: '#/components/schemas/ascDesc'
    forkWorkspaceQuery:
      name: workspace
      in: query
      required: true
      description: The workspace ID in which to create the fork.
      schema:
        $ref: '#/components/schemas/workspaceId'
  schemas:
    workspaceId:
      type: string
      example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9
    limit:
      type: integer
      default: 10
      example: 10
    ascDesc:
      type: string
      enum:
      - asc
      - desc
      example: asc
    cursor:
      type: string
      example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
  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