Skip to content

Latest commit

 

History

History
936 lines (580 loc) · 51 KB

IssueTrackerApi.md

File metadata and controls

936 lines (580 loc) · 51 KB

\IssueTrackerApi

All URIs are relative to https://api.bitbucket.org/2.0

Method HTTP request Description
RepositoriesUsernameRepoSlugComponentsComponentIdGet Get /repositories/{username}/{repo_slug}/components/{component_id}
RepositoriesUsernameRepoSlugComponentsGet Get /repositories/{username}/{repo_slug}/components
RepositoriesUsernameRepoSlugIssuesGet Get /repositories/{username}/{repo_slug}/issues
RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}/attachments
RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPathDelete Delete /repositories/{username}/{repo_slug}/issues/{issue_id}/attachments/{path}
RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPathGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}/attachments/{path}
RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPost Post /repositories/{username}/{repo_slug}/issues/{issue_id}/attachments
RepositoriesUsernameRepoSlugIssuesIssueIdChangesChangeIdGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}/changes/{change_id}
RepositoriesUsernameRepoSlugIssuesIssueIdChangesGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}/changes
RepositoriesUsernameRepoSlugIssuesIssueIdChangesPost Post /repositories/{username}/{repo_slug}/issues/{issue_id}/changes
RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdDelete Delete /repositories/{username}/{repo_slug}/issues/{issue_id}/comments/{comment_id}
RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}/comments/{comment_id}
RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdPut Put /repositories/{username}/{repo_slug}/issues/{issue_id}/comments/{comment_id}
RepositoriesUsernameRepoSlugIssuesIssueIdCommentsGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}/comments
RepositoriesUsernameRepoSlugIssuesIssueIdCommentsPost Post /repositories/{username}/{repo_slug}/issues/{issue_id}/comments
RepositoriesUsernameRepoSlugIssuesIssueIdDelete Delete /repositories/{username}/{repo_slug}/issues/{issue_id}
RepositoriesUsernameRepoSlugIssuesIssueIdGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}
RepositoriesUsernameRepoSlugIssuesIssueIdPut Put /repositories/{username}/{repo_slug}/issues/{issue_id}
RepositoriesUsernameRepoSlugIssuesIssueIdVoteDelete Delete /repositories/{username}/{repo_slug}/issues/{issue_id}/vote
RepositoriesUsernameRepoSlugIssuesIssueIdVoteGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}/vote
RepositoriesUsernameRepoSlugIssuesIssueIdVotePut Put /repositories/{username}/{repo_slug}/issues/{issue_id}/vote
RepositoriesUsernameRepoSlugIssuesIssueIdWatchDelete Delete /repositories/{username}/{repo_slug}/issues/{issue_id}/watch
RepositoriesUsernameRepoSlugIssuesIssueIdWatchGet Get /repositories/{username}/{repo_slug}/issues/{issue_id}/watch
RepositoriesUsernameRepoSlugIssuesIssueIdWatchPut Put /repositories/{username}/{repo_slug}/issues/{issue_id}/watch
RepositoriesUsernameRepoSlugIssuesPost Post /repositories/{username}/{repo_slug}/issues
RepositoriesUsernameRepoSlugMilestonesGet Get /repositories/{username}/{repo_slug}/milestones
RepositoriesUsernameRepoSlugMilestonesMilestoneIdGet Get /repositories/{username}/{repo_slug}/milestones/{milestone_id}
RepositoriesUsernameRepoSlugVersionsGet Get /repositories/{username}/{repo_slug}/versions
RepositoriesUsernameRepoSlugVersionsVersionIdGet Get /repositories/{username}/{repo_slug}/versions/{version_id}

RepositoriesUsernameRepoSlugComponentsComponentIdGet

Component RepositoriesUsernameRepoSlugComponentsComponentIdGet(ctx, username, componentId, repoSlug)

Returns the specified issue tracker component object.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
componentId int32 The component's id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

Component

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugComponentsGet

PaginatedComponents RepositoriesUsernameRepoSlugComponentsGet(ctx, username, repoSlug)

Returns the components that have been defined in the issue tracker. This resource is only available on repositories that have the issue tracker enabled.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

PaginatedComponents

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesGet

PaginatedIssues RepositoriesUsernameRepoSlugIssuesGet(ctx, username, repoSlug)

Returns the issues in the issue tracker.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

PaginatedIssues

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsGet

PaginatedIssueAttachments RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsGet(ctx, username, repoSlug, issueId)

Returns all attachments for this issue. This returns the files' meta data. This does not return the files' actual contents. The files are always ordered by their upload date.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
repoSlug string
issueId int32 The issue's id

Return type

PaginatedIssueAttachments

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPathDelete

RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPathDelete(ctx, username, path, issueId, repoSlug)

Deletes an attachment.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
path string
issueId string
repoSlug string

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPathGet

RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPathGet(ctx, username, path, issueId, repoSlug)

Returns the contents of the specified file attachment. Note that this endpoint does not return a JSON response, but instead returns a redirect pointing to the actual file that in turn will return the raw contents. The redirect URL contains a one-time token that has a limited lifetime. As a result, the link should not be persisted, stored, or shared.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
path string
issueId string
repoSlug string

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPost

RepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPost(ctx, username, repoSlug, issueId)

Upload new issue attachments. To upload files, perform a multipart/form-data POST containing one or more file fields. When a file is uploaded with the same name as an existing attachment, then the existing file will be replaced.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
repoSlug string
issueId int32 The issue's id

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdChangesChangeIdGet

IssueChange RepositoriesUsernameRepoSlugIssuesIssueIdChangesChangeIdGet(ctx, username, changeId, issueId, repoSlug)

Returns the specified issue change object. This resource is only available on repositories that have the issue tracker enabled.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
changeId string The issue change id
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

IssueChange

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdChangesGet

PaginatedLogEntries RepositoriesUsernameRepoSlugIssuesIssueIdChangesGet(ctx, username, issueId, repoSlug, optional)

Returns the list of all changes that have been made to the specified issue. Changes are returned in chronological order with the oldest change first. Each time an issue is edited in the UI or through the API, an immutable change record is created under the /issues/123/changes endpoint. It also has a comment associated with the change. Note that this operation is changing significantly, due to privacy changes. See the announcement for details. $ curl -s https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes - | jq . { \"pagelen\": 20, \"values\": [ { \"changes\": { \"priority\": { \"new\": \"trivial\", \"old\": \"major\" }, \"assignee\": { \"new\": \"\", \"old\": \"evzijst\" }, \"assignee_account_id\": { \"new\": \"\", \"old\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\" }, \"kind\": { \"new\": \"enhancement\", \"old\": \"bug\" } }, \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes/2\" }, \"html\": { \"href\": \"https://bitbucket.org/evzijst/dogslow/issues/1#comment-2\" } }, \"issue\": { \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1\" } }, \"type\": \"issue\", \"id\": 1, \"repository\": { \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow\" }, \"html\": { \"href\": \"https://bitbucket.org/evzijst/dogslow\" }, \"avatar\": { \"href\": \"https://bitbucket.org/evzijst/dogslow/avatar/32/\" } }, \"type\": \"repository\", \"name\": \"dogslow\", \"full_name\": \"evzijst/dogslow\", \"uuid\": \"{988b17c6-1a47-4e70-84ee-854d5f012bf6}\" }, \"title\": \"Updated title\" }, \"created_on\": \"2018-03-03T00:35:28.353630+00:00\", \"user\": { \"username\": \"evzijst\", \"nickname\": \"evzijst\", \"display_name\": \"evzijst\", \"type\": \"user\", \"uuid\": \"{aaa7972b-38af-4fb1-802d-6e3854c95778}\", \"links\": { \"self\": { \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\" }, \"html\": { \"href\": \"https://bitbucket.org/evzijst/\" }, \"avatar\": { \"href\": \"https://bitbucket.org/account/evzijst/avatar/32/\" } } }, \"message\": { \"raw\": \"Removed assignee, changed kind and priority.\", \"markup\": \"markdown\", \"html\": \"<p>Removed assignee, changed kind and priority.</p>\", \"type\": \"rendered\" }, \"type\": \"issue_change\", \"id\": 2 } ], \"page\": 1 } Changes support filtering and sorting that can be used to search for specific changes. For instance, to see when an issue transitioned to "resolved": $ curl -s https://api.bitbucket.org/2.0/repositories/site/master/issues/1/changes \\ -G --data-urlencode='q=changes.state.new = \"resolved\"' This resource is only available on repositories that have the issue tracker enabled. N.B. The changes.assignee and changes.assignee_account_id fields are not a user object. Instead, they contain the raw username and account_id of the user. This is to protect the integrity of the audit log even after a user account gets deleted. The changes.assignee field is deprecated will disappear in the future. Use changes.assignee_account_id instead.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
q string Query string to narrow down the response. See filtering and sorting for details.
sort string Name of a response property to sort results. See filtering and sorting for details.

Return type

PaginatedLogEntries

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdChangesPost

IssueChange RepositoriesUsernameRepoSlugIssuesIssueIdChangesPost(ctx, username, issueId, repoSlug, body)

Makes a change to the specified issue. For example, to change an issue's state and assignee, create a new change object that modifies these fields: curl https://api.bitbucket.org/2.0/site/master/issues/1234/changes \\ -s -u evzijst -X POST -H \"Content-Type: application/json\" \\ -d '{ \"changes\": { \"assignee_account_id\": { \"new\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\" }, \"state\": { \"new\": 'resolved\" } } \"message\": { \"raw\": \"This is now resolved.\" } }' The above example also includes a custom comment to go alongside the change. This comment will also be visible on the issue page in the UI. The fields of the changes object are strings, not objects. This allows for immutable change log records, even after user accounts, milestones, or other objects recorded in a change entry, get renamed or deleted. The assignee_account_id field stores the account id. When POSTing a new change and changing the assignee, the client should therefore use the user's account_id in the changes.assignee_account_id.new field. This call requires authentication. Private repositories or private issue trackers require the caller to authenticate with an account that has appropriate authorization.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
body IssueChange The new issue state change. The only required elements are `changes.[].new`. All other elements can be omitted from the body.

Return type

IssueChange

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdDelete

RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdDelete(ctx, commentId, username, repoSlug, issueId, body)

Deletes the specified comment.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
commentId string
username string This can either be the username or the UUID of the user, surrounded by curly-braces, for example: `{user UUID}`.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
issueId string The ID of the issue that is being queried.
body IssueComment The updated comment.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdGet

IssueComment RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdGet(ctx, commentId, username, repoSlug, issueId)

Returns the specified issue comment object.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
commentId string
username string This can either be the username or the UUID of the user, surrounded by curly-braces, for example: `{user UUID}`.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
issueId string The ID of the issue that is being queried.

Return type

IssueComment

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdPut

IssueComment RepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentIdPut(ctx, commentId, username, repoSlug, issueId, body)

Updates the content of the specified issue comment. Note that only the content.raw field can be modified. $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/5728901 \\ -X PUT -u evzijst \\ -H 'Content-Type: application/json' \\ -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
commentId string
username string This can either be the username or the UUID of the user, surrounded by curly-braces, for example: `{user UUID}`.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
issueId string The ID of the issue that is being queried.
body IssueComment The updated comment.

Return type

IssueComment

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdCommentsGet

PaginatedIssueComments RepositoriesUsernameRepoSlugIssuesIssueIdCommentsGet(ctx, issueId, username, repoSlug, optional)

Returns a paginated list of all comments that were made on the specified issue. The default sorting is oldest to newest and can be overridden with the sort query parameter. This endpoint also supports filtering and sorting of the results. See filtering and sorting for more details.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
issueId string
username string This can either be the username or the UUID of the user, surrounded by curly-braces, for example: `{user UUID}`.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
issueId string
username string This can either be the username or the UUID of the user, surrounded by curly-braces, for example: `{user UUID}`.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
q string Query string to narrow down the response as per filtering and sorting.

Return type

PaginatedIssueComments

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdCommentsPost

RepositoriesUsernameRepoSlugIssuesIssueIdCommentsPost(ctx, issueId, username, repoSlug, body)

Creates a new issue comment. $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/ \\ -X POST -u evzijst \\ -H 'Content-Type: application/json' \\ -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
issueId string
username string This can either be the username or the UUID of the user, surrounded by curly-braces, for example: `{user UUID}`.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
body IssueComment The new issue comment object.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdDelete

Issue RepositoriesUsernameRepoSlugIssuesIssueIdDelete(ctx, username, issueId, repoSlug)

Deletes the specified issue. This requires write access to the repository.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

Issue

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdGet

Issue RepositoriesUsernameRepoSlugIssuesIssueIdGet(ctx, username, issueId, repoSlug)

Returns the specified issue.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

Issue

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdPut

Issue RepositoriesUsernameRepoSlugIssuesIssueIdPut(ctx, username, issueId, repoSlug)

Modifies the issue. $ curl https://api.bitbucket.org/2.0/repostories/evzijst/dogslow/issues/123 \\ -u evzijst -s -X PUT -H 'Content-Type: application/json' \\ -d '{ \"title\": \"Updated title\", \"assignee\": { \"username\": \"evzijst\" }, \"priority\": \"minor\", \"version\": { \"name\": \"1.0\" }, \"component\": null }' This example changes the title, assignee, priority and the version. It also removes the value of the component from the issue by setting the field to null. Any field not present keeps its existing value. Each time an issue is edited in the UI or through the API, an immutable change record is created under the /issues/123/changes endpoint. It also has a comment associated with the change.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

Issue

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdVoteDelete

ModelError RepositoriesUsernameRepoSlugIssuesIssueIdVoteDelete(ctx, username, issueId, repoSlug)

Retract your vote.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdVoteGet

ModelError RepositoriesUsernameRepoSlugIssuesIssueIdVoteGet(ctx, username, issueId, repoSlug)

Check whether the authenticated user has voted for this issue. A 204 status code indicates that the user has voted, while a 404 implies they haven't.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdVotePut

ModelError RepositoriesUsernameRepoSlugIssuesIssueIdVotePut(ctx, username, issueId, repoSlug)

Vote for this issue. To cast your vote, do an empty PUT. The 204 status code indicates that the operation was successful.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdWatchDelete

ModelError RepositoriesUsernameRepoSlugIssuesIssueIdWatchDelete(ctx, username, issueId, repoSlug)

Stop watching this issue.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdWatchGet

ModelError RepositoriesUsernameRepoSlugIssuesIssueIdWatchGet(ctx, username, issueId, repoSlug)

Indicated whether or not the authenticated user is watching this issue.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesIssueIdWatchPut

ModelError RepositoriesUsernameRepoSlugIssuesIssueIdWatchPut(ctx, username, issueId, repoSlug)

Start watching this issue. To start watching this issue, do an empty PUT. The 204 status code indicates that the operation was successful.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
issueId string The issue id
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugIssuesPost

Issue RepositoriesUsernameRepoSlugIssuesPost(ctx, username, repoSlug, body)

Creates a new issue. This call requires authentication. Private repositories or private issue trackers require the caller to authenticate with an account that has appropriate authorization. The authenticated user is used for the issue's reporter field.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
body Issue The new issue. The only required element is `title`. All other elements can be omitted from the body.

Return type

Issue

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugMilestonesGet

PaginatedMilestones RepositoriesUsernameRepoSlugMilestonesGet(ctx, username, repoSlug)

Returns the milestones that have been defined in the issue tracker. This resource is only available on repositories that have the issue tracker enabled.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

PaginatedMilestones

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugMilestonesMilestoneIdGet

Milestone RepositoriesUsernameRepoSlugMilestonesMilestoneIdGet(ctx, username, repoSlug, milestoneId)

Returns the specified issue tracker milestone object.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
milestoneId int32 The milestone's id

Return type

Milestone

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugVersionsGet

PaginatedVersions RepositoriesUsernameRepoSlugVersionsGet(ctx, username, repoSlug)

Returns the versions that have been defined in the issue tracker. This resource is only available on repositories that have the issue tracker enabled.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

PaginatedVersions

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugVersionsVersionIdGet

Version RepositoriesUsernameRepoSlugVersionsVersionIdGet(ctx, username, repoSlug, versionId)

Returns the specified issue tracker version object.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
versionId int32 The version's id

Return type

Version

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]