openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Pull 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
      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: Pull Requests
  description: These endpoints enable you to manage your [pull requests](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/creating-pull-requests/) in Postman. Pull requests allow reviewers to look at your changes. Reviewers can make comments on your changes and will decide whether to approve them and merge them into the parent element.
paths:
  /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:
      - Pull Requests
      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:
      - Pull Requests
      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'
  /pull-requests/{pullRequestId}:
    parameters:
    - $ref: '#/components/parameters/pullRequestId'
    get:
      summary: APIs.io Engineering Platform Get a pull request
      description: Gets information about a pull request, such as the source and destination details, who reviewed the pull request, the merge's current status, and whether the element is accessible.
      operationId: getPullRequest
      tags:
      - Pull Requests
      responses:
        '200':
          $ref: '#/components/responses/getPullRequest'
        '403':
          $ref: '#/components/responses/pullRequest403ErrorForbidden'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    put:
      summary: APIs.io Engineering Platform Update a pull request
      description: Updates an open pull request.
      operationId: updatePullRequest
      tags:
      - Pull Requests
      requestBody:
        $ref: '#/components/requestBodies/pullRequestUpdate'
      responses:
        '200':
          $ref: '#/components/responses/pullRequestUpdate'
        '403':
          $ref: '#/components/responses/pullRequest403ErrorForbidden'
        '409':
          $ref: '#/components/responses/pullRequest409ErrorConflict'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /pull-requests/{pullRequestId}/tasks:
    parameters:
    - $ref: '#/components/parameters/pullRequestId'
    post:
      summary: APIs.io Engineering Platform Review a pull request
      description: Updates the [review](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/reviewing-pull-requests/) status of a pull request.
      operationId: reviewPullRequest
      tags:
      - Pull Requests
      requestBody:
        $ref: '#/components/requestBodies/pullRequestReview'
      responses:
        '200':
          $ref: '#/components/responses/pullRequestReview200OK'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/pullRequestReview400ErrorActionNotAllowed'
                - $ref: '#/components/schemas/pullRequestReview400ErrorInvalidAction'
              examples:
                Action Not Allowed:
                  $ref: '#/components/examples/pullRequestReview400ErrorActionNotAllowed'
                Invalid Action:
                  $ref: '#/components/examples/pullRequestReview400ErrorInvalidAction'
        '403':
          $ref: '#/components/responses/pullRequest403ErrorForbidden'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
components:
  responses:
    pullRequest403ErrorForbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/pullRequest403ErrorForbidden'
          example:
            detail: You do not have enough permissions to perform this action.
            status: 403
            title: Forbidden
            type: https://api.postman.com/problems/forbidden
    pullRequestCreated:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              createdAt:
                type: string
                description: The date and time at which the pull request was created.
                example: '2024-02-20T09:55:46.000Z'
              createdBy:
                type: string
                description: The ID of the user who created the pull request.
                example: '12345678'
              description:
                type: string
                description: The pull request's description.
                example: This is a test pull request.
              destinationId:
                type: string
                description: The pull request's merge destination ID.
                example: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4
              id:
                type: string
                description: The pull request's ID.
                example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
              sourceId:
                type: string
                description: The pull request's source (parent) ID.
                example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef
              status:
                type: string
                description: The pull request's current status.
                example: open
              title:
                type: string
                description: The pull request's title.
                example: Test PR
              updatedAt:
                type: string
                description: The date and time at which the pull request was updated.
                example: '2024-02-20T09:58:57.000Z'
          example:
            id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
            title: Test PR
            status: open
            sourceId: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef
            createdAt: '2024-02-20T09:55:46.000Z'
            createdBy: '12345678'
            updatedAt: '2024-02-20T09:58:57.000Z'
            description: This is a test pull request.
            destinationId: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4
    getCollectionPullRequests:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  type: object
                  description: Information about the pull request.
                  properties:
                    createdAt:
                      type: string
                      description: The date and time at which the pull request was created.
                      example: '2024-02-20T09:55:46.000Z'
                    createdBy:
                      type: string
                      description: The ID of the user who created the pull request.
                      example: '12345678'
                    description:
                      type: string
                      description: The pull request's description.
                      example: This is an open pull request.
                    destinationId:
                      type: string
                      description: The pull request's merge destination ID.
                      example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                    href:
                      type: string
                      description: A URL where you can view the pull request's details.
                      example: /pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8
                    id:
                      type: string
                      description: The pull request's ID.
                      example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
                    sourceId:
                      type: string
                      description: The pull request's source (parent) ID.
                      example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef
                    status:
                      type: string
                      description: The pull request's current status.
                      enum:
                      - open
                      - approved
                      - declined
                      - merged
                      example: open
                    comment:
                      type: string
                      description: If the pull request is declined, a comment about why the pull request was declined.
                      example: Missing information.
                    title:
                      type: string
                      description: The pull request's title.
                      example: Open PR
                    updatedBy:
                      type: string
                      description: The ID of the user who updated the pull request.
                      example: '12345678'
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the pull request was updated.
                      example: '2024-02-20T09:58:38.000Z'
          example:
            data:
            - createdAt: '2024-02-20T09:55:46.000Z'
              createdBy: '12345678'
              description: This is an open pull request.
              destinationId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
              href: /pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8
              id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
              sourceId: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef
              status: open
              title: Open PR
              updatedBy: '12345678'
              updatedAt: '2024-02-20T09:58:38.000Z'
            - createdAt: '2024-02-20T09:58:57.000Z'
              createdBy: '12345678'
              description: This is an approved PR.
              destinationId: 12345678-24f57217-1169-4b7c-a810-0e957c04eaa5
              href: /pull-requests/ac959187-568f-4e5e-9d17-584eb44fbed2
              id: ac959187-568f-4e5e-9d17-584eb44fbed2
              sourceId: 87654321-e50a18a3-0dcd-49cb-afa5-d3a82cdf6134
              status: approved
              title: Approved PR
              updatedBy: '12345678'
              updatedAt: '2024-02-20T09:58:57.000Z'
            - comment: Missing information.
              createdAt: '2024-02-20T09:55:46.000Z'
              createdBy: '12345678'
              description: This is a declined PR.
              destinationId: 12345678-c7f30bd9-5cc7-4569-a5fe-92270af33c6c
              href: /pull-requests/eda21e1f-8688-43aa-8660-35337dbac04b
              id: eda21e1f-8688-43aa-8660-35337dbac04b
              sourceId: 87654321-4beee503-1a7a-4925-a165-16fc29eaad22
              status: declined
              title: Declined PR
              updatedBy: '12345678'
              updatedAt: '2024-02-20T09:58:38.000Z'
    getPullRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/pullRequestGet'
          example:
            createdAt: '2024-02-20T09:55:46.000Z'
            updatedAt: '2024-02-20T09:58:38.000Z'
            id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
            title: Test PR
            description: This is a test pull request.
            createdBy: '12345678'
            updatedBy: '12345678'
            comment: Missing descriptions in requests
            forkType: collection
            source:
              id: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef
              name: test-collection
              forkName: Taylor Lee's fork
              exists: true
            destination:
              id: 123456789-24f57217-1169-4b7c-a810-0e957c04eaa5
              name: test-collection
              exists: true
            status: declined
            merge:
              status: inactive
            reviewers:
            - id: '12345678'
              status: declined
    pullRequestUpdate:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/pullRequestUpdated'
          example:
            createdAt: '2024-02-20T09:58:57.000Z'
            createdBy: '12345678'
            description: Updated description of the pull request.
            destinationId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
            forkType: collection
            id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
            sourceId: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef
            status: open
            title: Updated PR title
            updatedAt: '2024-02-20T09:58:57.000Z'
    pullRequestReview200OK:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
                description: The pull request's ID.
                example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
              reviewedBy:
                type: object
                description: Information about the user who reviewed the pull request review.
                properties:
                  id:
                    type: number
                    description: The user's ID.
                    example: 12345678
                  name:
                    type: string
                    description: The user's name.
                    example: Taylor Lee
                  username:
                    type: string
                    description: The user's username.
                    example: taylor-lee
              status:
                type: string
                description: 'The pull request''s current review status:

                  - `open` — The pull request is still open.

                  - `approved` — The pull request was approved by its reviewers.

                  - `declined` — The pull request was not approved by its reviewers.

                  '
                example: approved
              updatedAt:
                type: string
                description: The date and time at which the pull request was updated.
                example: '2024-02-21T08:19:09.000Z'
          examples:
            Approved:
              value:
                id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
                reviewedBy:
                  id: 12345678
                  name: Taylor Lee
                  username: taylor-lee
                status: approved
                updatedAt: '2024-02-21T08:19:09.000Z'
            Merged:
              value:
                id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
                reviewedBy:
                  id: 12345678
                  name: Taylor Lee
                  username: taylor-lee
                status: merged
                updatedAt: '2024-02-21T08:19:09.000Z'
            Declined:
              value:
                id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
                reviewedBy:
                  id: 12345678
                  name: Taylor Lee
                  username: taylor-lee
                status: declined
                updatedAt: '2024-02-21T08:19:09.000Z'
            Unpproved:
              value:
                id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
                reviewedBy:
                  id: 12345678
                  name: Taylor Lee
                  username: taylor-lee
                status: open
                updatedAt: '2024-02-21T08:19:09.000Z'
    pullRequest403ErrorNoViewerAccessCollections:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/pullRequest403ErrorNoViewerAccessCollections'
          example:
            detail: You and all reviewers need Viewer access on both source and destination collections.
            status: 403
            title: Forbidden
            type: https://api.postman.com/problems/forbidden
    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.
    pullRequest409ErrorConflict:
      description: Conflict
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
                description: Details about the occurrence of the error.
                example: You cannot modify a pull request which is already merged or declined.
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 409
              title:
                type: string
                description: A short summary of the error.
                example: Conflict
              type:
                type: string
                format: uri
                description: The error type.
                example: https://api.postman.com/problems/conflict
          example:
            detail: You cannot modify a pull request which is already merged or declined.
            status: 409
            title: Conflict
            type: https://api.postman.com/problems/conflict
    pullRequest403ErrorRolePermissionsCollection:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/pullRequest403ErrorRolePermissionsCollection'
          example:
            detail: You need Viewer role on both source and destination collections to view pull requests. Please contact collection editors to grant additional access to you.
            status: 403
            title: Forbidden
            type: https://api.postman.com/problems/forbidden
  schemas:
    pullRequest403ErrorNoViewerAccessCollections:
      title: No Viewer Permissions
      type: object
      properties:
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: You and all reviewers need Viewer access on both source and destination collections.
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
        title:
          type: string
          description: A short summary of the error.
          example: Forbidden
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/forbidden
    pullRequestReview400ErrorInvalidAction:
      title: Invalid Action
      type: object
      properties:
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/bad-request
        title:
          type: string
          description: A short summary of the error.
          example: Value must be one of "approve", "unapprove", "decline", "merge"
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: 'POST request body for ''/pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8/tasks'' failed to validate schema. Location: /properties/action/enum'
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 400
    forkCollection400ErrorBadForkRelation:
      title: Invalid Fork Source
      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/bad-request
        title:
          type: string
          description: A short summary of the problem.
          example: Bad Request
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 400
        detail:
          type: string
          description: Information about the error.
          example: Fork relation not found
    pullRequest400ErrorDuplicate:
      title: Pull Request Already Exists
      type: object
      properties:
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: A pull request for this source and destination already exists.
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 400
        title:
          type: string
          description: A short summary of the error.
          example: Duplicate pull request
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/bad-request
    pullRequest403ErrorForbidden:
      title: Forbidden
      type: object
      properties:
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: You do not have enough permissions to perform this action.
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
        title:
          type: string
          description: A short summary of the error.
          example: Forbidden
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/forbidden
    pullRequestUpdated:
      title: Updated Pull Request Payload
      type: object
      properties:
        createdAt:
          type: string
          description: The date and time at which the pull request was created.
          example: '2024-02-20T09:58:57.000Z'
        createdBy:
          type: string
          description: The ID of the user who created the pull request.
          example: '12345678'
        description:
          type: string
          description: The pull request's description.
          example: Updated description of the pull request.
        destinationId:
          type: string
          description: The pull request's merge destination ID.
          example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
        forkType:
          type: string
          description: The type of forked element.
          example: collection
        id:
          type: string
          description: The pull request's ID.
          example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
        sourceId:
          type: string
          description: The unique ID of the source element.
          example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef
        status:
          type: string
          description: The pull request's status.
          enum:
          - open
          - approved
          - declined
          - merged
          example: open
        title:
          type: string
          description: The pull request's title.
          example: Updated PR title
        updatedAt:
          type: string
          description: The date and time at which the pull request was updated.
          example: '2024-02-20T09:58:57.000Z'
    pullRequest403ErrorRolePermissionsCollection:
      title: No Role Permissions
      type: object
      properties:
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: You need Viewer role on both source and destination collections to view pull requests. Please contact collection editors to grant additional access to you.
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
        title:
          type: string
          description: A short summary of the error.
          example: Forbidden
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/forbidden
    pullRequestReview400ErrorActionNotAllowed:
      title: Action Not Allowed
      type: object
      properties:
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/bad-request
        title:
          type: string
          description: A short summary of the error.
          example: Bad Request
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: Given action on current pull request is not allowed
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 400
    pullRequestGet:
      title: Pull Request Payload
      type: object
      properties:
        createdAt:
          type: string
          description: The date and time at which the pull request was created.
          example: '2024-02-20T09:55:46.000Z'
        updatedAt:
          type: string
          description: The date and time at which the pull request was updated.
          example: '2024-02-20T09:58:38.000Z'
        id:
          type: string
          description: The pull request's ID.
          example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
        title:
          type: string
          description: The pull request's title.
          example: Test PR
        description:
          type: string
          description: The pull request's description.
          example: This is a test pull request.
        createdBy:
          type: string
          description: The ID of the user who created the pull request.
          example: '12345678'
        updatedBy:
          type: string
          description: The ID of the user who last updated the pull request.
          example: '12345678'
        comment:
          type: string
          description: If the pull request is a `decline` status, an optoinal comment about why the pull request was declined.
          example: Missing descriptions in requests
        fortkType:
          type: string
          description: The type of element the pull request was forked from.
          example: collection
        source:
          type: object
          description: Information about the pull request's source (parent) element.
          properties:
            id:
              type: string
              description: The pull request's source ID.
              example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef
            name:
              type: string
              description: The source element's name.
              example: test-collection
            forkName:
              type: string
              description: The name of the fork created from the source element.
              example: Taylor Lee's fork
            exists:
              type: boolean
              description: If true, whether the element is present and not deleted.
              example: true
        destination:
          description: Information about the pull request destination element.
          type: object
          properties:
            id:
              type: string
              description: The destination element's ID.
              example: 123456789-24f57217-1169-4b7c-a810-0e957c04eaa5
            name:
              type: string
              description: The destination element's name.
              example: test-collection
            exists:
              type: boolean
              description: If true, whether the element is present and not deleted.
              example: true
        status:
          type: string
          description: 'The pull request''s current review status:

            - `open` — The pull request is still open.

            - `approved` — The pull request was approved by its reviewers.

            - `declined` — The pull request was not approved by its reviewers.

            '
          example: declined
        merge:
          type: object
          description: Information about the current progress of the pull request's merge.
          properties:
            status:
              type: string
              description: 'The pull request''s current merge status:

                - `inactive` — There is no merge in progress.

                - `inprogress` — The pull request is currently merging.

                - `failed` — The pull request''s merge failed.

                '
              enum:
              - inactive
              - inprogress
              - failed
              example: inactive
        reviewers:
          type: array
          description: Information about the reviewers assigned to the pull request.
          items:
            type: object
            properties:
              id:
                type: string
                description: The reviewer's user ID.
                example: '12345678'
              status:
                type: string
                description: 'The reviewer''s review status response. One of:

                  - `approved`

                  - `declined`

                  '
                example: declined
  requestBodies:
    pullRequestCreate:
      content:
        application/json:
          schema:
            type: object
            required:
            - title
            - description
            - reviewers
            - destinationId
            description: Information about the pull request.
            properties:
              title:
                type: string
                description: The title of the pull request.
                example: Test PR
              description:
                type: string
                description: The pull request's description.
                example: This is a test pull request.
              reviewers:
                type: array
                description: A list of reviewers to assign to the pull request.
                items:
                  type: string
                  description: The reviewer's user ID.
                  example: '87654321'
              destinationId:
                type: string
                description: The collection ID to merge the pull request into.
                example: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4
          example:
            title: Test PR
            description: This is a test pull request.
            reviewers:
            - '87654321'
            - '56781234'
            destinationId: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4
    pullRequestReview:
      content:
        application/json:
          schema:
            required:
            - action
            type: object
            properties:
              action:
                type: string
                description: 'The action to perform on the pull request:

                  - `approve` — Approve the pull request for merge.

                  - `decline` — Decline the pull request.

                  - `merge` — Merge the pull request into its parent element.

                  - `unapprove` — Revokes a pull request''s `approve` status. This action does not decline the pull request.

                  '
                enum:
                - approve
                - decline
                - merge
                - unapprove
                example: decline
              comment:
                type: string
                description: If the pull request is a `decline` status, an optoinal comment about why the pull request was declined.
                example: Missing descriptions in requests
          examples:
            Approve:
              value:
                action: approve
            Merge:
              value:
                action: merge
            Decline:
              value:
                action: decline
                comment: Missing descriptions in requests
            Unapprove:
              value:
                action: unapprove
    pullRequestUpdate:
      content:
        application/json:
          schema:
            type: object
            required:
            - reviewers
            - title
            properties:
              title:
                type: string
                description: The pull request's updated title.
                example: Updated PR title
              description:
                type: string
                description: The updated pull request description.
                example: Updated description of the pull request.
              reviewers:
                type: array
                description: An updated list of the pull request's assigned reviewers. This replaces all existing users assigned to the pull request with those you pass in the request body.
                items:
                  type: string
                  description: The reviewer's user ID.
                  example: '12345678'
          example:
            description: Updated description of the pull request.
            reviewers:
            - '12345678'
            - '87654321'
            title: Updated PR title
  parameters:
    pullRequestId:
      name: pullRequestId
      in: path
      required: true
      description: The pull request's ID.
      schema:
        type: string
        example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8
    collectionUid:
      name: collectionId
      in: path
      required: true
      description: The collection's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
  examples:
    pullRequestReview400ErrorActionNotAllowed:
      value:
        type: https://api.postman.com/problems/bad-request
        title: Bad Request
        detail: Given action on current pull request is not allowed
        status: 400
    pullRequestReview400ErrorInvalidAction:
      value:
        type: https://api.postman.com/problems/bad-request
        title: Value must be one of "approve", "unapprove", "decline", "merge"
        detail: 'POST request body for ''/pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8/tasks'' failed to validate schema. Location: /properties/action/enum'
        status: 400
    forkCollection400ErrorBadForkRelation:
      value:
        type: https://api.postman.com/problems/bad-request
        title: Bad Request
        status: 400
        detail: Fork relation not found
    pullRequest400ErrorDuplicate:
      value:
        detail: A pull request for this source and destination already exists.
        status: 400
        title: Duplicate pull request
        type: https://api.postman.com/problems/bad-request
  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