NAME

WebService::BitbucketServer::CommentLikes::V1 - Bindings for a Bitbucket Server REST API

VERSION

version 0.600

SYNOPSIS

    my $stash = WebService::BitbucketServer->new(
        base_url    => 'https://stash.example.com/',
        username    => 'bob',
        password    => 'secret',
    );
    my $api = $stash->comment_likes;

DESCRIPTION

This is a Bitbucket Server REST API for CommentLikes::V1.

Original API documentation created by and copyright Atlassian.

ATTRIBUTES

context

Get the instance of WebService::BitbucketServer passed to "new".

METHODS

new

    $api = WebService::BitbucketServer::CommentLikes::V1->new(context => $webservice_bitbucketserver_obj);

Create a new API.

Normally you would use $webservice_bitbucketserver_obj->comment_likes instead.

unlike_commit

Unlike a commit comment in the specified repository, identified by commitId and commentId.

The authenticated user must have the REPO_READ (or higher) permission for the specified repository to access this resource.

    DELETE comment-likes/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}/likes

Parameters:

  • commentId - long, default: none

  • commitId - string, default: none

Responses:

  • 400 - errors, type: application/json

    The currently authenticated user is the comment author

  • 401 - errors, type: application/json

    The currently authenticated user does not have sufficient permission (REPO_READ)

  • 204 - data, type: unknown

    No content response indicating that the request succeeded

  • 404 - errors, type: application/json

    The specified repository, commit or comment does not exist

get_commit_likers

Get a page of users who liked a commit comment in the specified repository, identified by commitId and commentId.

The authenticated user must have the REPO_READ (or higher) permission for the specified repository to access this resource.

    GET comment-likes/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}/likes

Parameters:

  • commentId - long, default: none

  • commitId - string, default: none

Responses:

  • 200 - data, type: application/json

    Page of users who liked the specified comment

  • 401 - errors, type: application/json

    The currently authenticated user does not have sufficient permission (REPO_READ) to query the comment likes

  • 404 - errors, type: application/json

    The specified repository, commit or comment does not exist

like_commit

Like a commit comment in the specified repository, identified by commitId and commentId.

The authenticated user must have the REPO_READ (or higher) permission for the specified repository to access this resource.

    POST comment-likes/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}/likes

Parameters:

  • commentId - long, default: none

  • commitId - string, default: none

Responses:

  • 400 - errors, type: application/json

    The currently authenticated user is the comment author

  • 401 - errors, type: application/json

    The currently authenticated user does not have sufficient permission (REPO_READ).

  • 204 - data, type: unknown

    No content response indicating that the request succeeded

  • 404 - errors, type: application/json

    The specified repository, commit or comment does not exist

unlike_pull_request

Unlike a pull request comment in the specified repository, identified by pullRequestId and commentId.

The authenticated user must have the REPO_READ (or higher) permission for the specified repository to access this resource.

    DELETE comment-likes/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/likes

Parameters:

  • commentId - long, default: none

  • pullRequestId - long, default: none

Responses:

  • 400 - errors, type: application/json

    The currently authenticated user is the comment author

  • 401 - errors, type: application/json

    The currently authenticated user does not have sufficient permission (REPO_READ)

  • 204 - data, type: unknown

    No content response indicating that the request succeeded

  • 404 - errors, type: application/json

    The specified repository, pull request or comment does not exist

get_pull_request_likers

Get a page of users who liked a pull request comment in the specified repository, identified by pullRequestId and commentId.

The authenticated user must have the REPO_READ (or higher) permission for the specified repository to access this resource.

    GET comment-likes/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/likes

Parameters:

  • commentId - long, default: none

  • pullRequestId - long, default: none

Responses:

  • 200 - data, type: application/json

    Page of users who liked the specified comment

  • 401 - errors, type: application/json

    The currently authenticated user does not have sufficient permission (REPO_READ) to query the comment likes

  • 404 - errors, type: application/json

    The specified repository, pull request or comment does not exist

like_pull_request

Like a pull request comment in the specified repository, identified by pullRequestId and commentId. The like will be recorded against the requesting user.

The authenticated user must have the REPO_READ (or higher) permission for the specified repository to access this resource.

    POST comment-likes/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/likes

Parameters:

  • commentId - long, default: none

  • pullRequestId - long, default: none

Responses:

  • 400 - errors, type: application/json

    The currently authenticated user is the comment author

  • 401 - errors, type: application/json

    The currently authenticated user does not have sufficient permission (REPO_READ).

  • 204 - data, type: unknown

    No content response indicating that the request succeeded

  • 404 - errors, type: application/json

    The specified repository, pull request or comment does not exist

SEE ALSO

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/chazmcgarvey/WebService-BitbucketServer/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Charles McGarvey <ccm@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Charles McGarvey.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.