Amazon CodeCommit Codecommit Comment API

openapi: 3.1.0
info:
  title: AWS CodeCommit Comment API
  version: '2015-04-13'
  description: Generated from AWS's published Smithy model for AWS CodeCommit. 4 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:
  /#GetComment:
    post:
      operationId: GetComment
      summary: Get Comment
      description: Returns the content of a comment made on a change, file, or commit in a repository. Reaction counts might
        include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active
        identities, use GetCommentReactions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetCommentOutput'
        '400':
          description: CommentDeletedException; CommentDoesNotExistException; CommentIdRequiredException; EncryptionKeyAccessDeniedException;
            EncryptionKeyDisabledException; EncryptionKeyNotFoundException; EncryptionKeyUnavailableException; InvalidCommentIdException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CommentDeletedException'
        '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.GetComment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetCommentInput'
      tags:
      - Comment
  /#GetCommentsForComparedCommit:
    post:
      operationId: GetCommentsForComparedCommit
      summary: Get Comments For Compared Commit
      description: Returns information about comments made on the comparison between two commits. Reaction counts might include
        numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities,
        use GetCommentReactions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetCommentsForComparedCommitOutput'
        '400':
          description: CommitDoesNotExistException; CommitIdRequiredException; EncryptionKeyAccessDeniedException; EncryptionKeyDisabledException;
            EncryptionKeyNotFoundException; EncryptionKeyUnavailableException; InvalidCommitIdException; InvalidContinuationTokenException;
            InvalidMaxResultsException; InvalidRepositoryNameException; RepositoryDoesNotExistException; RepositoryNameRequiredException
          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.GetCommentsForComparedCommit
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetCommentsForComparedCommitInput'
      tags:
      - Comment
  /#GetCommentsForPullRequest:
    post:
      operationId: GetCommentsForPullRequest
      summary: Get Comments For Pull Request
      description: Returns comments made on a pull request. Reaction counts might include numbers from user identities who
        were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetCommentsForPullRequestOutput'
        '400':
          description: CommitDoesNotExistException; CommitIdRequiredException; EncryptionKeyAccessDeniedException; EncryptionKeyDisabledException;
            EncryptionKeyNotFoundException; EncryptionKeyUnavailableException; InvalidCommitIdException; InvalidContinuationTokenException;
            InvalidMaxResultsException; InvalidPullRequestIdException; InvalidRepositoryNameException; PullRequestDoesNotExistException;
            PullRequestIdRequiredException; RepositoryDoesNotExistException; RepositoryNameRequiredException; RepositoryNotAssociatedWithPullRequestException
          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.GetCommentsForPullRequest
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetCommentsForPullRequestInput'
      tags:
      - Comment
  /#UpdateComment:
    post:
      operationId: UpdateComment
      summary: Update Comment
      description: Replaces the contents of a comment.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateCommentOutput'
        '400':
          description: CommentContentRequiredException; CommentContentSizeLimitExceededException; CommentDeletedException;
            CommentDoesNotExistException; CommentIdRequiredException; CommentNotCreatedByCallerException; InvalidCommentIdException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CommentContentRequiredException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeCommit_20150413.UpdateComment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateCommentInput'
      tags:
      - Comment
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:
    Comment:
      type: object
      properties:
        commentId:
          type: string
          description: The system-generated comment ID.
        content:
          type: string
          description: The content of the comment.
        inReplyTo:
          type: string
          description: The ID of the comment for which this comment is a reply, if any.
        creationDate:
          type: string
          format: date-time
          description: The date and time the comment was created, in timestamp format.
        lastModifiedDate:
          type: string
          format: date-time
          description: The date and time the comment was most recently modified, in timestamp format.
        authorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the person who posted the comment.
        deleted:
          type: boolean
          description: A Boolean value indicating whether the comment has been deleted.
        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.
        callerReactions:
          type: array
          items:
            type: string
          description: The emoji reactions to a comment, if any, submitted by the user whose credentials are associated with
            the call to the API.
        reactionCounts:
          type: object
          additionalProperties:
            type: integer
          description: A string to integer map that represents the number of individual users who have responded to a comment
            with the specified reactions.
    CommentContentRequiredException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    CommentDeletedException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    CommentsForComparedCommit:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the repository that contains the compared commits.
        beforeCommitId:
          type: string
          description: The full commit ID of the commit used to establish the before of the comparison.
        afterCommitId:
          type: string
          description: The full commit ID of the commit used to establish the after of the comparison.
        beforeBlobId:
          type: string
          description: The full blob ID of the commit used to establish the before of the comparison.
        afterBlobId:
          type: string
          description: The full blob ID of the commit used to establish the after of the comparison.
        location:
          $ref: '#/components/schemas/Location'
        comments:
          type: array
          items:
            $ref: '#/components/schemas/Comment'
          description: An array of comment objects. Each comment object contains information about a comment on the comparison
            between commits.
    CommentsForPullRequest:
      type: object
      properties:
        pullRequestId:
          type: string
          description: The system-generated ID of the pull request.
        repositoryName:
          type: string
          description: The name of the repository that contains the pull request.
        beforeCommitId:
          type: string
          description: The full commit ID of the commit that was the tip of the destination branch when the pull request was
            created. This commit is superceded by the after commit in the source branch when and if you merge the source branch
            into the destination branch.
        afterCommitId:
          type: string
          description: The full commit ID of the commit that was the tip of the source branch at the time the comment was
            made.
        beforeBlobId:
          type: string
          description: The full blob ID of the file on which you want to comment on the destination commit.
        afterBlobId:
          type: string
          description: The full blob ID of the file on which you want to comment on the source commit.
        location:
          $ref: '#/components/schemas/Location'
        comments:
          type: array
          items:
            $ref: '#/components/schemas/Comment'
          description: An array of comment objects. Each comment object contains information about a comment on the pull request.
    CommitDoesNotExistException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    EncryptionIntegrityChecksFailedException:
      type: object
      properties:
        message:
          type: string
          description: Any message associated with the exception.
    GetCommentInput:
      type: object
      properties:
        commentId:
          type: string
          description: The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or
            GetCommentsForPullRequest.
      required:
      - commentId
    GetCommentOutput:
      type: object
      properties:
        comment:
          $ref: '#/components/schemas/Comment'
    GetCommentsForComparedCommitInput:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the repository where you want to compare commits.
        beforeCommitId:
          type: string
          description: To establish the directionality of the comparison, the full commit ID of the before commit.
        afterCommitId:
          type: string
          description: To establish the directionality of the comparison, the full commit ID of the after commit.
        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. The default is 100 comments,
            but you can configure up to 500.
      required:
      - repositoryName
      - afterCommitId
    GetCommentsForComparedCommitOutput:
      type: object
      properties:
        commentsForComparedCommitData:
          type: array
          items:
            $ref: '#/components/schemas/CommentsForComparedCommit'
          description: A list of comment objects on the compared commit.
        nextToken:
          type: string
          description: An enumeration token that can be used in a request to return the next batch of the results.
    GetCommentsForPullRequestInput:
      type: object
      properties:
        pullRequestId:
          type: string
          description: The system-generated ID of the pull request. To get this ID, use ListPullRequests.
        repositoryName:
          type: string
          description: 'The name of the repository that contains the pull request. Requirement is conditional: repositoryName
            must be specified when beforeCommitId and afterCommitId are included.'
        beforeCommitId:
          type: string
          description: 'The full commit ID of the commit in the destination branch that was the tip of the branch at the time
            the pull request was created. Requirement is conditional: beforeCommitId must be specified when repositoryName
            is included.'
        afterCommitId:
          type: string
          description: 'The full commit ID of the commit in the source branch that was the tip of the branch at the time the
            comment was made. Requirement is conditional: afterCommitId must be specified when repositoryName is included.'
        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. The default is 100 comments.
            You can return up to 500 comments with a single request.
      required:
      - pullRequestId
    GetCommentsForPullRequestOutput:
      type: object
      properties:
        commentsForPullRequestData:
          type: array
          items:
            $ref: '#/components/schemas/CommentsForPullRequest'
          description: An array of comment objects on the pull request.
        nextToken:
          type: string
          description: An enumeration token that can be used in a request to return the next batch of the results.
    Location:
      type: object
      properties:
        filePath:
          type: string
          description: The name of the file being compared, including its extension and subdirectory, if any.
        filePosition:
          type: integer
          description: The position of a change in a compared file, in line number format.
        relativeFileVersion:
          type: string
          enum:
          - BEFORE
          - AFTER
          description: In a comparison of commits or a pull request, whether the change is in the before or after of that
            comparison.
    UpdateCommentInput:
      type: object
      properties:
        commentId:
          type: string
          description: The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit
            or GetCommentsForPullRequest.
        content:
          type: string
          description: The updated content to replace the existing content of the comment.
      required:
      - commentId
      - content
    UpdateCommentOutput:
      type: object
      properties:
        comment:
          $ref: '#/components/schemas/Comment'
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)