Amazon CodeCommit Codecommit Merge Conflict API

openapi: 3.1.0
info:
  title: AWS CodeCommit Merge Conflict 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:
  /#BatchDescribeMergeConflicts:
    post:
      operationId: BatchDescribeMergeConflicts
      summary: Batch Describe Merge Conflicts
      description: Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using
        the squash or three-way merge strategy.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchDescribeMergeConflictsOutput'
        '400':
          description: CommitDoesNotExistException; CommitRequiredException; EncryptionKeyAccessDeniedException; EncryptionKeyDisabledException;
            EncryptionKeyNotFoundException; EncryptionKeyUnavailableException; InvalidCommitException; InvalidConflictDetailLevelException;
            InvalidConflictResolutionStrategyException; InvalidContinuationTokenException; InvalidMaxConflictFilesException;
            InvalidMaxMergeHunksException; InvalidMergeOptionException; InvalidRepositoryNameException; MaximumFileContentToLoadExceededException;
            MaximumItemsToCompareExceededException; MergeOptionRequiredException; RepositoryDoesNotExistException; RepositoryNameRequiredException;
            TipsDivergenceExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CommitDoesNotExistException'
        '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.BatchDescribeMergeConflicts
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchDescribeMergeConflictsInput'
      tags:
      - Merge Conflict
  /#DescribeMergeConflicts:
    post:
      operationId: DescribeMergeConflicts
      summary: Describe Merge Conflicts
      description: Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using
        the squash or three-way merge strategy. If the merge option for the attempted merge is specified as FAST_FORWARD_MERGE,
        an exception is thrown.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeMergeConflictsOutput'
        '400':
          description: CommitDoesNotExistException; CommitRequiredException; EncryptionKeyAccessDeniedException; EncryptionKeyDisabledException;
            EncryptionKeyNotFoundException; EncryptionKeyUnavailableException; FileDoesNotExistException; InvalidCommitException;
            InvalidConflictDetailLevelException; InvalidConflictResolutionStrategyException; InvalidContinuationTokenException;
            InvalidMaxMergeHunksException; InvalidMergeOptionException; InvalidPathException; InvalidRepositoryNameException;
            MaximumFileContentToLoadExceededException; MaximumItemsToCompareExceededException; MergeOptionRequiredException;
            PathRequiredException; RepositoryDoesNotExistException; RepositoryNameRequiredException; TipsDivergenceExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CommitDoesNotExistException'
        '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.DescribeMergeConflicts
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeMergeConflictsInput'
      tags:
      - Merge Conflict
  /#GetMergeConflicts:
    post:
      operationId: GetMergeConflicts
      summary: Get Merge Conflicts
      description: Returns information about merge conflicts between the before and after commit IDs for a pull request in
        a repository.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetMergeConflictsOutput'
        '400':
          description: CommitDoesNotExistException; CommitRequiredException; EncryptionKeyAccessDeniedException; EncryptionKeyDisabledException;
            EncryptionKeyNotFoundException; EncryptionKeyUnavailableException; InvalidCommitException; InvalidConflictDetailLevelException;
            InvalidConflictResolutionStrategyException; InvalidContinuationTokenException; InvalidDestinationCommitSpecifierException;
            InvalidMaxConflictFilesException; InvalidMergeOptionException; InvalidRepositoryNameException; InvalidSourceCommitSpecifierException;
            MaximumFileContentToLoadExceededException; MaximumItemsToCompareExceededException; MergeOptionRequiredException;
            RepositoryDoesNotExistException; RepositoryNameRequiredException; TipsDivergenceExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CommitDoesNotExistException'
        '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.GetMergeConflicts
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetMergeConflictsInput'
      tags:
      - Merge Conflict
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:
    BatchDescribeMergeConflictsError:
      type: object
      properties:
        filePath:
          type: string
          description: The path to the file.
        exceptionName:
          type: string
          description: The name of the exception.
        message:
          type: string
          description: The message provided by the exception.
      required:
      - filePath
      - exceptionName
      - message
    BatchDescribeMergeConflictsInput:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the repository that contains the merge conflicts you want to review.
        destinationCommitSpecifier:
          type: string
          description: The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a
            branch name or a full commit ID).
        sourceCommitSpecifier:
          type: string
          description: The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a
            branch name or a full commit ID).
        mergeOption:
          type: string
          enum:
          - FAST_FORWARD_MERGE
          - SQUASH_MERGE
          - THREE_WAY_MERGE
          description: The merge option or strategy you want to use to merge the code.
        maxMergeHunks:
          type: integer
          description: The maximum number of merge hunks to include in the output.
        maxConflictFiles:
          type: integer
          description: The maximum number of files to include in the output.
        filePaths:
          type: array
          items:
            type: string
          description: The path of the target files used to describe the conflicts. If not specified, the default is all conflict
            files.
        conflictDetailLevel:
          type: string
          enum:
          - FILE_LEVEL
          - LINE_LEVEL
          description: The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns
            a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict
            is considered not mergeable if the same file in both branches has differences on the same line.
        conflictResolutionStrategy:
          type: string
          enum:
          - NONE
          - ACCEPT_SOURCE
          - ACCEPT_DESTINATION
          - AUTOMERGE
          description: Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging
            two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge
            operation is successful.
        nextToken:
          type: string
          description: An enumeration token that, when provided in a request, returns the next batch of the results.
      required:
      - repositoryName
      - destinationCommitSpecifier
      - sourceCommitSpecifier
      - mergeOption
    BatchDescribeMergeConflictsOutput:
      type: object
      properties:
        conflicts:
          type: array
          items:
            $ref: '#/components/schemas/Conflict'
          description: A list of conflicts for each file, including the conflict metadata and the hunks of the differences
            between the files.
        nextToken:
          type: string
          description: An enumeration token that can be used in a request to return the next batch of the results.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchDescribeMergeConflictsError'
          description: A list of any errors returned while describing the merge conflicts for each file.
        destinationCommitId:
          type: string
          description: The commit ID of the destination commit specifier that was used in the merge evaluation.
        sourceCommitId:
          type: string
          description: The commit ID of the source commit specifier that was used in the merge evaluation.
        baseCommitId:
          type: string
          description: The commit ID of the merge base.
      required:
      - conflicts
      - destinationCommitId
      - sourceCommitId
    CommitDoesNotExistException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    Conflict:
      type: object
      properties:
        conflictMetadata:
          $ref: '#/components/schemas/ConflictMetadata'
        mergeHunks:
          type: array
          items:
            $ref: '#/components/schemas/MergeHunk'
          description: A list of hunks that contain the differences between files or lines causing the conflict.
    ConflictMetadata:
      type: object
      properties:
        filePath:
          type: string
          description: The path of the file that contains conflicts.
        fileSizes:
          $ref: '#/components/schemas/FileSizes'
        fileModes:
          $ref: '#/components/schemas/FileModes'
        objectTypes:
          $ref: '#/components/schemas/ObjectTypes'
        numberOfConflicts:
          type: integer
          description: The number of conflicts, including both hunk conflicts and metadata conflicts.
        isBinaryFile:
          $ref: '#/components/schemas/IsBinaryFile'
        contentConflict:
          type: boolean
          description: A boolean value indicating whether there are conflicts in the content of a file.
        fileModeConflict:
          type: boolean
          description: A boolean value indicating whether there are conflicts in the file mode of a file.
        objectTypeConflict:
          type: boolean
          description: A boolean value (true or false) indicating whether there are conflicts between the branches in the
            object type of a file, folder, or submodule.
        mergeOperations:
          $ref: '#/components/schemas/MergeOperations'
    DescribeMergeConflictsInput:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the repository where you want to get information about a merge conflict.
        destinationCommitSpecifier:
          type: string
          description: The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a
            branch name or a full commit ID).
        sourceCommitSpecifier:
          type: string
          description: The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a
            branch name or a full commit ID).
        mergeOption:
          type: string
          enum:
          - FAST_FORWARD_MERGE
          - SQUASH_MERGE
          - THREE_WAY_MERGE
          description: The merge option or strategy you want to use to merge the code.
        maxMergeHunks:
          type: integer
          description: The maximum number of merge hunks to include in the output.
        filePath:
          type: string
          description: The path of the target files used to describe the conflicts.
        conflictDetailLevel:
          type: string
          enum:
          - FILE_LEVEL
          - LINE_LEVEL
          description: The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns
            a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict
            is considered not mergeable if the same file in both branches has differences on the same line.
        conflictResolutionStrategy:
          type: string
          enum:
          - NONE
          - ACCEPT_SOURCE
          - ACCEPT_DESTINATION
          - AUTOMERGE
          description: Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging
            two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge
            operation is successful.
        nextToken:
          type: string
          description: An enumeration token that, when provided in a request, returns the next batch of the results.
      required:
      - repositoryName
      - destinationCommitSpecifier
      - sourceCommitSpecifier
      - mergeOption
      - filePath
    DescribeMergeConflictsOutput:
      type: object
      properties:
        conflictMetadata:
          $ref: '#/components/schemas/ConflictMetadata'
        mergeHunks:
          type: array
          items:
            $ref: '#/components/schemas/MergeHunk'
          description: A list of merge hunks of the differences between the files or lines.
        nextToken:
          type: string
          description: An enumeration token that can be used in a request to return the next batch of the results.
        destinationCommitId:
          type: string
          description: The commit ID of the destination commit specifier that was used in the merge evaluation.
        sourceCommitId:
          type: string
          description: The commit ID of the source commit specifier that was used in the merge evaluation.
        baseCommitId:
          type: string
          description: The commit ID of the merge base.
      required:
      - conflictMetadata
      - mergeHunks
      - destinationCommitId
      - sourceCommitId
    EncryptionIntegrityChecksFailedException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    FileModes:
      type: object
      properties:
        source:
          type: string
          enum:
          - EXECUTABLE
          - NORMAL
          - SYMLINK
          description: The file mode of a file in the source of a merge or pull request.
        destination:
          type: string
          enum:
          - EXECUTABLE
          - NORMAL
          - SYMLINK
          description: The file mode of a file in the destination of a merge or pull request.
        base:
          type: string
          enum:
          - EXECUTABLE
          - NORMAL
          - SYMLINK
          description: The file mode of a file in the base of a merge or pull request.
    FileSizes:
      type: object
      properties:
        source:
          type: integer
          description: The size of a file in the source of a merge or pull request.
        destination:
          type: integer
          description: The size of a file in the destination of a merge or pull request.
        base:
          type: integer
          description: The size of a file in the base of a merge or pull request.
    GetMergeConflictsInput:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the repository where the pull request was created.
        destinationCommitSpecifier:
          type: string
          description: The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a
            branch name or a full commit ID).
        sourceCommitSpecifier:
          type: string
          description: The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a
            branch name or a full commit ID).
        mergeOption:
          type: string
          enum:
          - FAST_FORWARD_MERGE
          - SQUASH_MERGE
          - THREE_WAY_MERGE
          description: The merge option or strategy you want to use to merge the code.
        conflictDetailLevel:
          type: string
          enum:
          - FILE_LEVEL
          - LINE_LEVEL
          description: The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns
            a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict
            is considered not mergeable if the same file in both branches has differences on the same line.
        maxConflictFiles:
          type: integer
          description: The maximum number of files to include in the output.
        conflictResolutionStrategy:
          type: string
          enum:
          - NONE
          - ACCEPT_SOURCE
          - ACCEPT_DESTINATION
          - AUTOMERGE
          description: Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging
            two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge
            operation is successful.
        nextToken:
          type: string
          description: An enumeration token that, when provided in a request, returns the next batch of the results.
      required:
      - repositoryName
      - destinationCommitSpecifier
      - sourceCommitSpecifier
      - mergeOption
    GetMergeConflictsOutput:
      type: object
      properties:
        mergeable:
          type: boolean
          description: A Boolean value that indicates whether the code is mergeable by the specified merge option.
        destinationCommitId:
          type: string
          description: The commit ID of the destination commit specifier that was used in the merge evaluation.
        sourceCommitId:
          type: string
          description: The commit ID of the source commit specifier that was used in the merge evaluation.
        baseCommitId:
          type: string
          description: The commit ID of the merge base.
        conflictMetadataList:
          type: array
          items:
            $ref: '#/components/schemas/ConflictMetadata'
          description: A list of metadata for any conflicting files. If the specified merge strategy is FAST_FORWARD_MERGE,
            this list is always empty.
        nextToken:
          type: string
          description: An enumeration token that can be used in a request to return the next batch of the results.
      required:
      - mergeable
      - destinationCommitId
      - sourceCommitId
      - conflictMetadataList
    IsBinaryFile:
      type: object
      properties:
        source:
          type: boolean
          description: The binary or non-binary status of file in the source of a merge or pull request.
        destination:
          type: boolean
          description: The binary or non-binary status of a file in the destination of a merge or pull request.
        base:
          type: boolean
          description: The binary or non-binary status of a file in the base of a merge or pull request.
    MergeHunk:
      type: object
      properties:
        isConflict:
          type: boolean
          description: A Boolean value indicating whether a combination of hunks contains a conflict. Conflicts occur when
            the same file or the same lines in a file were modified in both the source and destination of a merge or pull
            request. Valid values include true, false, and null. True when the hunk represents a conflict and one or more
            files contains a line conflict. File mode conflicts in a merge do not set this to true.
        source:
          $ref: '#/components/schemas/MergeHunkDetail'
        destination:
          $ref: '#/components/schemas/MergeHunkDetail'
        base:
          $ref: '#/components/schemas/MergeHunkDetail'
    MergeHunkDetail:
      type: object
      properties:
        startLine:
          type: integer
          description: The start position of the hunk in the merge result.
        endLine:
          type: integer
          description: The end position of the hunk in the merge result.
        hunkContent:
          type: string
          description: The base-64 encoded content of the hunk merged region that might contain a conflict.
    MergeOperations:
      type: object
      properties:
        source:
          type: string
          enum:
          - A
          - M
          - D
          description: The operation (add, modify, or delete) on a file in the source of a merge or pull request.
        destination:
          type: string
          enum:
          - A
          - M
          - D
          description: The operation on a file in the destination of a merge or pull request.
    ObjectTypes:
      type: object
      properties:
        source:
          type: string
          enum:
          - FILE
          - DIRECTORY
          - GIT_LINK
          - SYMBOLIC_LINK
          description: The type of the object in the source branch.
        destination:
          type: string
          enum:
          - FILE
          - DIRECTORY
          - GIT_LINK
          - SYMBOLIC_LINK
          description: The type of the object in the destination branch.
        base:
          type: string
          enum:
          - FILE
          - DIRECTORY
          - GIT_LINK
          - SYMBOLIC_LINK
          description: The type of the object in the base commit of the merge.
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)