Amazon CodeCommit Codecommit Pull Request API

openapi: 3.1.0
info:
  title: AWS CodeCommit Pull Request API
  version: '2015-04-13'
  description: Generated from AWS's published Smithy model for AWS CodeCommit. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://codecommit.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreatePullRequest:
    post:
      operationId: CreatePullRequest
      summary: Create Pull Request
      description: Creates a pull request in the specified repository.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreatePullRequestOutput'
        '400':
          description: ClientRequestTokenRequiredException; EncryptionKeyAccessDeniedException; EncryptionKeyDisabledException;
            EncryptionKeyNotFoundException; EncryptionKeyUnavailableException; IdempotencyParameterMismatchException; InvalidClientRequestTokenException;
            InvalidDescriptionException; InvalidReferenceNameException; InvalidRepositoryNameException; InvalidTargetException;
            InvalidTargetsException; InvalidTitleException; MaximumOpenPullRequestsExceededException; MultipleRepositoriesInPullRequestException;
            ReferenceDoesNotExistException; ReferenceNameRequiredException; ReferenceTypeNotSupportedException; RepositoryDoesNotExistException;
            RepositoryNameRequiredException; SourceAndDestinationAreSameException; TargetRequiredException; TargetsRequiredException;
            TitleRequiredException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClientRequestTokenRequiredException'
        '500':
          description: EncryptionIntegrityChecksFailedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EncryptionIntegrityChecksFailedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeCommit_20150413.CreatePullRequest
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreatePullRequestInput'
      tags:
      - Pull Request
  /#GetPullRequest:
    post:
      operationId: GetPullRequest
      summary: Get Pull Request
      description: Gets information about a pull request in a specified repository.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetPullRequestOutput'
        '500':
          description: EncryptionIntegrityChecksFailedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EncryptionIntegrityChecksFailedException'
        '400':
          description: EncryptionKeyAccessDeniedException; EncryptionKeyDisabledException; EncryptionKeyNotFoundException;
            EncryptionKeyUnavailableException; InvalidPullRequestIdException; PullRequestDoesNotExistException; PullRequestIdRequiredException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EncryptionKeyAccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeCommit_20150413.GetPullRequest
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetPullRequestInput'
      tags:
      - Pull Request
  /#ListPullRequests:
    post:
      operationId: ListPullRequests
      summary: List Pull Requests
      description: Returns a list of pull requests for a specified repository. The return list can be refined by pull request
        status or pull request author ARN.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListPullRequestsOutput'
        '400':
          description: AuthorDoesNotExistException; EncryptionKeyAccessDeniedException; EncryptionKeyDisabledException; EncryptionKeyNotFoundException;
            EncryptionKeyUnavailableException; InvalidAuthorArnException; InvalidContinuationTokenException; InvalidMaxResultsException;
            InvalidPullRequestStatusException; InvalidRepositoryNameException; RepositoryDoesNotExistException; RepositoryNameRequiredException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorDoesNotExistException'
        '500':
          description: EncryptionIntegrityChecksFailedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EncryptionIntegrityChecksFailedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeCommit_20150413.ListPullRequests
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListPullRequestsInput'
      tags:
      - Pull Request
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: codecommit
  schemas:
    ApprovalRule:
      type: object
      properties:
        approvalRuleId:
          type: string
          description: The system-generated ID of the approval rule.
        approvalRuleName:
          type: string
          description: The name of the approval rule.
        approvalRuleContent:
          type: string
          description: The content of the approval rule.
        ruleContentSha256:
          type: string
          description: The SHA-256 hash signature for the content of the approval rule.
        lastModifiedDate:
          type: string
          format: date-time
          description: The date the approval rule was most recently changed, in timestamp format.
        creationDate:
          type: string
          format: date-time
          description: The date the approval rule was created, in timestamp format.
        lastModifiedUser:
          type: string
          description: The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule.
        originApprovalRuleTemplate:
          $ref: '#/components/schemas/OriginApprovalRuleTemplate'
    AuthorDoesNotExistException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    ClientRequestTokenRequiredException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    CreatePullRequestInput:
      type: object
      properties:
        title:
          type: string
          description: The title of the pull request. This title is used to identify the pull request to other users in the
            repository.
        description:
          type: string
          description: A description of the pull request.
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Target'
          description: The targets for the pull request, including the source of the code to be reviewed (the source branch)
            and the destination where the creator of the pull request intends the code to be merged after the pull request
            is closed (the destination branch).
        clientRequestToken:
          type: string
          description: A unique, client-generated idempotency token that, when provided in a request, ensures the request
            cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is
            included, the request returns information about the initial request that used that token. The Amazon Web ServicesSDKs
            prepopulate client request tokens. If you are using an Amazon Web ServicesSDK, an idempotency token is created
            for you.
      required:
      - title
      - targets
    CreatePullRequestOutput:
      type: object
      properties:
        pullRequest:
          $ref: '#/components/schemas/PullRequest'
      required:
      - pullRequest
    EncryptionIntegrityChecksFailedException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    EncryptionKeyAccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    GetPullRequestInput:
      type: object
      properties:
        pullRequestId:
          type: string
          description: The system-generated ID of the pull request. To get this ID, use ListPullRequests.
      required:
      - pullRequestId
    GetPullRequestOutput:
      type: object
      properties:
        pullRequest:
          $ref: '#/components/schemas/PullRequest'
      required:
      - pullRequest
    ListPullRequestsInput:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the repository for which you want to list pull requests.
        authorArn:
          type: string
          description: Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters
            the results to pull requests created by that user.
        pullRequestStatus:
          type: string
          enum:
          - OPEN
          - CLOSED
          description: Optional. The status of the pull request. If used, this refines the results to the pull requests that
            match the specified status.
        nextToken:
          type: string
          description: An enumeration token that, when provided in a request, returns the next batch of the results.
        maxResults:
          type: integer
          description: A non-zero, non-negative integer used to limit the number of returned results.
      required:
      - repositoryName
    ListPullRequestsOutput:
      type: object
      properties:
        pullRequestIds:
          type: array
          items:
            type: string
          description: The system-generated IDs of the pull requests.
        nextToken:
          type: string
          description: An enumeration token that allows the operation to batch the next results of the operation.
      required:
      - pullRequestIds
    MergeMetadata:
      type: object
      properties:
        isMerged:
          type: boolean
          description: A Boolean value indicating whether the merge has been made.
        mergedBy:
          type: string
          description: The Amazon Resource Name (ARN) of the user who merged the branches.
        mergeCommitId:
          type: string
          description: The commit ID for the merge commit, if any.
        mergeOption:
          type: string
          enum:
          - FAST_FORWARD_MERGE
          - SQUASH_MERGE
          - THREE_WAY_MERGE
          description: The merge strategy used in the merge.
    OriginApprovalRuleTemplate:
      type: object
      properties:
        approvalRuleTemplateId:
          type: string
          description: The ID of the template that created the approval rule.
        approvalRuleTemplateName:
          type: string
          description: The name of the template that created the approval rule.
    PullRequest:
      type: object
      properties:
        pullRequestId:
          type: string
          description: The system-generated ID of the pull request.
        title:
          type: string
          description: The user-defined title of the pull request. This title is displayed in the list of pull requests to
            other repository users.
        description:
          type: string
          description: The user-defined description of the pull request. This description can be used to clarify what should
            be reviewed and other details of the request.
        lastActivityDate:
          type: string
          format: date-time
          description: The day and time of the last user or system activity on the pull request, in timestamp format.
        creationDate:
          type: string
          format: date-time
          description: The date and time the pull request was originally created, in timestamp format.
        pullRequestStatus:
          type: string
          enum:
          - OPEN
          - CLOSED
          description: The status of the pull request. Pull request status can only change from OPEN to CLOSED.
        authorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the user who created the pull request.
        pullRequestTargets:
          type: array
          items:
            $ref: '#/components/schemas/PullRequestTarget'
          description: The targets of the pull request, including the source branch and destination branch for the pull request.
        clientRequestToken:
          type: string
          description: A unique, client-generated idempotency token that, when provided in a request, ensures the request
            cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is
            included, the request returns information about the initial request that used that token.
        revisionId:
          type: string
          description: The system-generated revision ID for the pull request.
        approvalRules:
          type: array
          items:
            $ref: '#/components/schemas/ApprovalRule'
          description: The approval rules applied to the pull request.
    PullRequestTarget:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the repository that contains the pull request source and destination branches.
        sourceReference:
          type: string
          description: The branch of the repository that contains the changes for the pull request. Also known as the source
            branch.
        destinationReference:
          type: string
          description: The branch of the repository where the pull request changes are merged. Also known as the destination
            branch.
        destinationCommit:
          type: string
          description: The full commit ID that is the tip of the destination branch. This is the commit where the pull request
            was or will be merged.
        sourceCommit:
          type: string
          description: The full commit ID of the tip of the source branch used to create the pull request. If the pull request
            branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the
            branch.
        mergeBase:
          type: string
          description: The commit ID of the most recent commit that the source branch and the destination branch have in common.
        mergeMetadata:
          $ref: '#/components/schemas/MergeMetadata'
    Target:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the repository that contains the pull request.
        sourceReference:
          type: string
          description: The branch of the repository that contains the changes for the pull request. Also known as the source
            branch.
        destinationReference:
          type: string
          description: The branch of the repository where the pull request changes are merged. Also known as the destination
            branch.
      required:
      - repositoryName
      - sourceReference
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/codecommit/service/2015-04-13/codecommit-2015-04-13.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)