The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

 / 
WebService-BitbucketServer-0.605
River stage zero No dependents
/ WebService::BitbucketServer::DefaultReviewers::V1

NAME

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

VERSION

version 0.605

SYNOPSIS


            

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

DESCRIPTION

This is a Bitbucket Server REST API for DefaultReviewers::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::DefaultReviewers::V1->new(context => $webservice_bitbucketserver_obj);

Create a new API.

Normally you would use $webservice_bitbucketserver_obj->default_reviewers instead.

create_pull_request_condition

Create a default reviewer pull request condition for the given project.


            

              
              
POST default-reviewers/1.0/projects/{projectKey}/condition

Responses:

  • 200 - data, type: application/json

    The default reviewer pull request condition that was created.

  • 400 - data, type: application/json

    The request was malformed

delete_pull_request_condition

Delete the default reviewer pull request condition associated with the given ID.


            

              
              
DELETE default-reviewers/1.0/projects/{projectKey}/condition/{id}

Parameters:

  • id - int, default: none

    The ID of the pull request condition

Responses:

  • 204 - data, type: unknown

    An empty response indicating that the pull request condition was deleted

  • 404 - data, type: unknown

    An empty response indicating a pull request condition with the given ID could not be found

update_pull_request_condition

Update the default reviewer pull request condition for the given ID.


            

              
              
PUT default-reviewers/1.0/projects/{projectKey}/condition/{id}

Parameters:

  • id - int, default: none

    The ID of the pull request condition

Responses:

  • 200 - data, type: application/json

    The updated default reviewer pull request condition.

  • 400 - data, type: application/json

    The request was malformed

get_pull_request_conditions

Return a page of default reviewer pull request conditions that have been configured for this project.


            

              
              
GET default-reviewers/1.0/projects/{projectKey}/conditions

Responses:

  • 200 - data, type: application/json

    The default reviewer pull request conditions associated with the given project

create_pull_request_condition_for_repository

Create a default reviewer pull request condition for the given repository.


            

              
              
POST default-reviewers/1.0/projects/{projectKey}/repos/{repositorySlug}/condition

Responses:

  • 200 - data, type: application/json

    The default reviewer pull request condition that was created.

  • 400 - data, type: application/json

    The request was malformed

delete_pull_request_condition_for_repository

Delete the default reviewer pull request condition associated with the given ID.


            

              
              
DELETE default-reviewers/1.0/projects/{projectKey}/repos/{repositorySlug}/condition/{id}

Parameters:

  • id - int, default: none

    The ID of the pull request condition

Responses:

  • 204 - data, type: unknown

    An empty response indicating that the pull request condition was deleted

  • 404 - data, type: unknown

    An empty response indicating a pull request condition with the given ID could not be found

update_pull_request_condition_for_repository

Update the default reviewer pull request condition for the given ID.


            

              
              
PUT default-reviewers/1.0/projects/{projectKey}/repos/{repositorySlug}/condition/{id}

Parameters:

  • id - int, default: none

    The ID of the pull request condition

Responses:

  • 200 - data, type: application/json

    The updated default reviewer pull request condition.

  • 400 - data, type: application/json

    The request was malformed

get_pull_request_conditions_for_repository

Return a page of default reviewer pull request conditions that have been configured for this repository.


            

              
              
GET default-reviewers/1.0/projects/{projectKey}/repos/{repositorySlug}/conditions

Responses:

  • 200 - data, type: application/json

    The default reviewer pull request conditions associated with the given repository

get_reviewers_for_repository

Return a set of users who are required reviewers for pull requests created from the given source repository and ref to the given target ref in this repository.


            

              
              
GET default-reviewers/1.0/projects/{projectKey}/repos/{repositorySlug}/reviewers

Parameters:

  • sourceRepoId - int, default: none

    The ID of the repository in which the source ref exists

  • targetRepoId - int, default: none

    The ID of the repository in which the target ref exists

  • sourceRefId - string, default: none

    The ID of the source ref

  • targetRefId - string, default: none

    The ID of the target ref

Responses:

  • 200 - data, type: application/json

    The default reviewer pull request conditions associated with the given repository and refs

  • 400 - data, type: application/json

    The request was malformed

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 <chazmcgarvey@brokenzipper.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 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.