/ 
WebService-BitbucketServer-0.600
River stage zero No dependents
/ WebService::BitbucketServer::JIRA::V1

NAME

WebService::BitbucketServer::JIRA::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->jira;

DESCRIPTION

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

Create a new API.

Normally you would use $webservice_bitbucketserver_obj->jira instead.

create_issue

Create a JIRA issue and associate it with a comment on a pull request.

This resource can only be used with comments on a pull request. Attempting to call this resource with a different type of comment (for example, a comment on a commit) will result in an error.

The authenticated user must have REPO_READ permission for the repository containing the comment to call this resource.

The JSON structure for the create issue format is specified by JIRA's REST v2 API.

POST jira/1.0/comments/{commentId}/issues

Parameters:

  • applicationId - string, default: none

    ID of the JIRA server

Responses:

  • 201 - data, type: application/json

    The created JIRA issue key and the associated comment ID

  • 400 - errors, type: application/json

    The specified application link ID does not match any linked JIRA instance.

  • 401 - errors, type: application/json

    Authentication with the JIRA instance is required.

get_commits

Retrieve a page of changesets associated with the given issue key.

GET jira/1.0/issues/{issueKey}/commits

Parameters:

  • issueKey - string, default: none

    the issue key to search by.

  • maxChanges - int, default: 10

    the maximum number of changes to retrieve for each changeset.

Responses:

  • 200 - page, type: application/json

    A page of detailed changesets.

get_issue_keys_for_pull_request

Retrieves JIRA issue keys that are associated with the commits in the specified pull request. The number of commits checked for issues is limited to a default of 100.

GET jira/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/issues

Parameters:

  • pullRequestId - long, default: none

Responses:

  • 200 - issueKeys, type: application/json

    A list of JIRA issues keys for the pull request

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.