mirror of
https://github.com/gfleury/go-bitbucket-v1.git
synced 2025-04-04 08:50:13 -05:00
feat: adds functional support for updating PR comments
This commit is contained in:
Silviu Tanasă
parent
b03c3e7561
commit
9c8acea33c
@ -16,7 +16,7 @@ This API client was generated by the [swagger-codegen](https://github.com/swagge
|
||||
All URIs are relative to *http://example.com/rest/*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
------------ |-------------------------------------------------------------------------------------------| ------------- | -------------
|
||||
*DefaultApi* | [**AddGroupToUser**](docs/DefaultApi.md#addgrouptouser) | **Post** /api/1.0/admin/users/add-group |
|
||||
*DefaultApi* | [**AddUserToGroup**](docs/DefaultApi.md#addusertogroup) | **Post** /api/1.0/admin/groups/add-user |
|
||||
*DefaultApi* | [**AddUserToGroups**](docs/DefaultApi.md#addusertogroups) | **Post** /api/1.0/admin/users/add-groups |
|
||||
@ -193,6 +193,7 @@ Class | Method | HTTP request | Description
|
||||
*DefaultApi* | [**UpdateProject**](docs/DefaultApi.md#updateproject) | **Put** /api/1.0/projects/{projectKey} |
|
||||
*DefaultApi* | [**UpdatePullRequestSettings**](docs/DefaultApi.md#updatepullrequestsettings) | **Post** /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests |
|
||||
*DefaultApi* | [**UpdatePullRequest**](docs/DefaultApi.md#updatepullrequest) | **Put** /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId} |
|
||||
*DefaultApi* | [**UpdatePullRequestComment**](docs/DefaultApi.md#updatepullrequestcomment) | **Put** /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId} |
|
||||
*DefaultApi* | [**UpdatePullRequestSettings_0**](docs/DefaultApi.md#updatepullrequestsettings_0) | **Post** /api/1.0/projects/{projectKey}/settings/pull-requests/{scmId} |
|
||||
*DefaultApi* | [**UpdateRepository**](docs/DefaultApi.md#updaterepository) | **Put** /api/1.0/projects/{projectKey}/repos/{repositorySlug} |
|
||||
*DefaultApi* | [**UpdateSettings**](docs/DefaultApi.md#updatesettings) | **Post** /api/1.0/users/{userSlug}/settings |
|
||||
|
||||
18
api_request.go
Normal file
18
api_request.go
Normal file
@ -0,0 +1,18 @@
|
||||
package bitbucketv1
|
||||
|
||||
// UpdatePullRequestCommentRequest represents the request body for the Update pull request comment API.
|
||||
// API doc: https://developer.atlassian.com/server/bitbucket/rest/v805/api-group-pull-requests/#api-api-latest-projects-projectkey-repos-repositoryslug-pull-requests-pullrequestid-comments-commentid-put
|
||||
type UpdatePullRequestCommentRequest struct {
|
||||
// updated comment ID
|
||||
ID int `json:"id"`
|
||||
// updated comment updated state
|
||||
State string `json:"state,omitempty"`
|
||||
// existing comment version which need to be fetched from the actual comment
|
||||
Version int `json:"version"`
|
||||
// updated comment severity
|
||||
Severity string `json:"severity,omitempty"`
|
||||
// updated comment text
|
||||
Text string `json:"text,omitempty"`
|
||||
// updated comment properties (should be able to be marshalled into an object according to the documentation
|
||||
Properties interface{} `json:"properties,omitempty"`
|
||||
}
|
||||
@ -13294,6 +13294,89 @@ func (a *DefaultApiService) UpdateComment_46(projectKey, repositorySlug string,
|
||||
return NewBitbucketAPIResponse(localVarHTTPResponse)
|
||||
}
|
||||
|
||||
// UpdatePullRequestComment updates a PR comment.
|
||||
//
|
||||
// Only the user who created a comment may update it.
|
||||
// The supplied JSON object must contain a version field that must match the server's version of the comment
|
||||
// or the update will fail. To determine the current version of the comment, the comment should be fetched from the server
|
||||
// prior to the update (look for the version attribute in the returned JSON structure).
|
||||
//
|
||||
// The content of the message can be updated by setting the UpdatePullRequestCommentRequest.Text attribute.
|
||||
//
|
||||
// Comments can be converted to tasks by setting the UpdatePullRequestCommentRequest.Severity attribute to 'BLOCKER':
|
||||
// {
|
||||
// "severity": "BLOCKER"
|
||||
// }
|
||||
// Tasks can be converted to comments by setting the 'severity' attribute to 'NORMAL':
|
||||
// {
|
||||
// "severity": "NORMAL"
|
||||
// }
|
||||
// Resolve a task.
|
||||
// Tasks can be resolved by setting the 'state' attribute to 'RESOLVED':
|
||||
// {
|
||||
// "state": "RESOLVED"
|
||||
// }
|
||||
//
|
||||
// The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
|
||||
func (a *DefaultApiService) UpdatePullRequestComment(projectKey, repositorySlug string, pullRequestID, commentId int, updateCommentRequest UpdatePullRequestCommentRequest) (*APIResponse, error) {
|
||||
var (
|
||||
localVarHTTPMethod = strings.ToUpper("Put")
|
||||
localVarPostBody interface{}
|
||||
localVarFileName string
|
||||
localVarFileBytes []byte
|
||||
)
|
||||
|
||||
localVarPostBody, err := json.Marshal(updateCommentRequest)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// create path and map variables
|
||||
localVarPath := a.client.cfg.BasePath + "/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}"
|
||||
localVarPath = strings.Replace(localVarPath, "{"+"projectKey"+"}", fmt.Sprintf("%v", projectKey), -1)
|
||||
localVarPath = strings.Replace(localVarPath, "{"+"repositorySlug"+"}", fmt.Sprintf("%v", repositorySlug), -1)
|
||||
localVarPath = strings.Replace(localVarPath, "{"+"pullRequestId"+"}", fmt.Sprintf("%v", pullRequestID), -1)
|
||||
localVarPath = strings.Replace(localVarPath, "{"+"commentId"+"}", fmt.Sprintf("%v", commentId), -1)
|
||||
|
||||
localVarHeaderParams := make(map[string]string)
|
||||
localVarQueryParams := url.Values{}
|
||||
localVarFormParams := url.Values{}
|
||||
|
||||
// to determine the Content-Type header
|
||||
localVarHTTPContentTypes := []string{"application/json"}
|
||||
|
||||
// set Content-Type header
|
||||
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
||||
if localVarHTTPContentType != "" {
|
||||
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
||||
}
|
||||
|
||||
// to determine the Accept header
|
||||
localVarHTTPHeaderAccepts := []string{}
|
||||
|
||||
// set Accept header
|
||||
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
||||
if localVarHTTPHeaderAccept != "" {
|
||||
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
||||
}
|
||||
r, err := a.client.prepareRequest(a.client.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
localVarHTTPResponse, err := a.client.callAPI(r)
|
||||
if err != nil || localVarHTTPResponse == nil {
|
||||
return NewAPIResponseWithError(localVarHTTPResponse, nil, err)
|
||||
}
|
||||
defer localVarHTTPResponse.Body.Close()
|
||||
if localVarHTTPResponse.StatusCode >= 300 {
|
||||
bodyBytes, _ := io.ReadAll(localVarHTTPResponse.Body)
|
||||
return NewAPIResponseWithError(localVarHTTPResponse, bodyBytes, reportError("Status: %v, Body: %s", localVarHTTPResponse.Status, bodyBytes))
|
||||
}
|
||||
|
||||
return NewBitbucketAPIResponse(localVarHTTPResponse)
|
||||
}
|
||||
|
||||
/*
|
||||
DefaultApiService
|
||||
|
||||
|
||||
@ -7582,6 +7582,45 @@ func TestDefaultApiService_UpdateComment_46(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
func TestDefaultApiService_UpdatePullRequestComment(t *testing.T) {
|
||||
type fields struct {
|
||||
client *APIClient
|
||||
}
|
||||
type args struct {
|
||||
projectKey string
|
||||
repositorySlug string
|
||||
pullRequestID int
|
||||
commentId int
|
||||
comment UpdatePullRequestCommentRequest
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
fields fields
|
||||
args args
|
||||
want *APIResponse
|
||||
wantErr, integrationTest bool
|
||||
}{
|
||||
{"networkErrorContextExceeded", fields{client: generateConfigFake()}, args{}, &APIResponse{Message: "Put https://stash.domain.com/rest/api/1.0/projects//repos//pull-requests/0/comments/0: context canceled"}, true, false},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
if tt.integrationTest != runIntegrationTests {
|
||||
continue
|
||||
}
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
a := &DefaultApiService{
|
||||
client: tt.fields.client,
|
||||
}
|
||||
got, err := a.UpdatePullRequestComment(tt.args.projectKey, tt.args.repositorySlug, tt.args.pullRequestID, tt.args.commentId, tt.args.comment)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("DefaultApiService.UpdatePullRequestComment() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if !reflect.DeepEqual(got, tt.want) {
|
||||
t.Errorf("DefaultApiService.UpdatePullRequestComment() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestDefaultApiService_UpdateProject(t *testing.T) {
|
||||
type fields struct {
|
||||
|
||||
@ -177,6 +177,7 @@ Method | HTTP request | Description
|
||||
[**Update**](DefaultApi.md#Update) | **Post** /api/1.0/admin/license |
|
||||
[**UpdateComment**](DefaultApi.md#UpdateComment) | **Put** /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId} |
|
||||
[**UpdateComment_0**](DefaultApi.md#UpdateComment_0) | **Put** /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId} |
|
||||
[**UpdatePullRequestComment**](DefaultApi.md#UpdatePullRequestComment) | **Put** /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId} |
|
||||
[**UpdateProject**](DefaultApi.md#UpdateProject) | **Put** /api/1.0/projects/{projectKey} |
|
||||
[**UpdatePullRequestSettings**](DefaultApi.md#UpdatePullRequestSettings) | **Post** /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests |
|
||||
[**UpdatePullRequestSettings_0**](DefaultApi.md#UpdatePullRequestSettings_0) | **Post** /api/1.0/projects/{projectKey}/settings/pull-requests/{scmId} |
|
||||
@ -5672,6 +5673,36 @@ No authorization required
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **UpdatePullRequestComment**
|
||||
> UpdatePullRequestComment(projectKey, repositorySlug, pullRequestID, commentId, updateCommentRequest)
|
||||
|
||||
|
||||
Update the text of a comment. Only the user who created a comment may update it. <p> <strong>Note:</strong> the supplied supplied JSON object must contain a <code>version</code> that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure. <p> The authenticated user must have <strong>REPO_READ</strong> permission for the repository that the commit is in to call this resource.
|
||||
|
||||
### Required Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- |------------|--------------------------------------------------| -------------
|
||||
**projectKey** | **string** | The project key |
|
||||
**repositorySlug** | **string** | The repository slug. |
|
||||
**pullRequestId** | **int** | The ID of the pull request within the repository |
|
||||
**commentId** | **int** | The ID the comment |
|
||||
**updateCommentRequest** | **UpdatePullRequestCommentRequest** | The update comment request body |
|
||||
|
||||
### Return type
|
||||
|
||||
RestComment
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
# **UpdateComment**
|
||||
> UpdateComment(ctx, commitId, commentId, commitId2)
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user