From 196148747568eb5cda28d75cd9635d1cee7bf33f Mon Sep 17 00:00:00 2001 From: zengchen1024 Date: Wed, 24 Mar 2021 11:08:17 +0800 Subject: [PATCH] fix api of opreating log and add an api of replace labels of pr --- README.md | 2 + api/swagger.yaml | 35 ++++++++++++++++- docs/OperateLog.md | 2 +- docs/PullRequestsApi.md | 80 +++++++++++++++++++++++++++++++++++++- gitee/api_pull_requests.go | 28 +++++-------- gitee/model_operate_log.go | 2 +- 6 files changed, 124 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index b2146f0..b9fdef5 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,7 @@ Class | Method | HTTP request | Description *PullRequestsApi* | [**GetV5ReposOwnerRepoPullsNumberComments**](docs/PullRequestsApi.md#getv5reposownerrepopullsnumbercomments) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/comments | 获取某个Pull Request的所有评论 *PullRequestsApi* | [**GetV5ReposOwnerRepoPullsNumberCommits**](docs/PullRequestsApi.md#getv5reposownerrepopullsnumbercommits) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/commits | 获取某Pull Request的所有Commit信息。最多显示250条Commit *PullRequestsApi* | [**GetV5ReposOwnerRepoPullsNumberFiles**](docs/PullRequestsApi.md#getv5reposownerrepopullsnumberfiles) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/files | Pull Request Commit文件列表。最多显示300条diff +*PullRequestsApi* | [**GetV5ReposOwnerRepoPullsNumberIssues**](docs/PullRequestsApi.md#getv5reposownerrepopullsnumberissues) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/issues | 获取 Pull Request 关联的 issues *PullRequestsApi* | [**GetV5ReposOwnerRepoPullsNumberLabels**](docs/PullRequestsApi.md#getv5reposownerrepopullsnumberlabels) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/labels | 获取某个 Pull Request 的所有标签 *PullRequestsApi* | [**GetV5ReposOwnerRepoPullsNumberMerge**](docs/PullRequestsApi.md#getv5reposownerrepopullsnumbermerge) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/merge | 判断Pull Request是否已经合并 *PullRequestsApi* | [**GetV5ReposOwnerRepoPullsNumberOperateLogs**](docs/PullRequestsApi.md#getv5reposownerrepopullsnumberoperatelogs) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/operate_logs | 获取某个Pull Request的操作日志 @@ -165,6 +166,7 @@ Class | Method | HTTP request | Description *PullRequestsApi* | [**PostV5ReposOwnerRepoPullsNumberComments**](docs/PullRequestsApi.md#postv5reposownerrepopullsnumbercomments) | **Post** /v5/repos/{owner}/{repo}/pulls/{number}/comments | 提交Pull Request评论 *PullRequestsApi* | [**PostV5ReposOwnerRepoPullsNumberLabels**](docs/PullRequestsApi.md#postv5reposownerrepopullsnumberlabels) | **Post** /v5/repos/{owner}/{repo}/pulls/{number}/labels | 创建 Pull Request 标签 *PullRequestsApi* | [**PostV5ReposOwnerRepoPullsNumberTesters**](docs/PullRequestsApi.md#postv5reposownerrepopullsnumbertesters) | **Post** /v5/repos/{owner}/{repo}/pulls/{number}/testers | 指派用户测试 Pull Request +*PullRequestsApi* | [**PutV5ReposOwnerRepoPullsNumberLabels**](docs/PullRequestsApi.md#putv5reposownerrepopullsnumberlabels) | **Put** /v5/repos/{owner}/{repo}/pulls/{number}/labels | 替换Pull Request 所有标签 *PullRequestsApi* | [**PutV5ReposOwnerRepoPullsNumberMerge**](docs/PullRequestsApi.md#putv5reposownerrepopullsnumbermerge) | **Put** /v5/repos/{owner}/{repo}/pulls/{number}/merge | 合并Pull Request *RepositoriesApi* | [**DeleteV5ReposOwnerRepo**](docs/RepositoriesApi.md#deletev5reposownerrepo) | **Delete** /v5/repos/{owner}/{repo} | 删除一个仓库 *RepositoriesApi* | [**DeleteV5ReposOwnerRepoBranchesBranchProtection**](docs/RepositoriesApi.md#deletev5reposownerrepobranchesbranchprotection) | **Delete** /v5/repos/{owner}/{repo}/branches/{branch}/protection | 取消保护分支的设置 diff --git a/api/swagger.yaml b/api/swagger.yaml index 2685a11..4b5ebff 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -4036,7 +4036,10 @@ paths: 200: description: "返回格式" schema: - $ref: "#/definitions/OperateLog" + type: "array" + items: + $ref: "#/definitions/OperateLog" + /v5/repos/{owner}/{repo}/pulls/{number}/commits: get: tags: @@ -4731,6 +4734,34 @@ paths: schema: $ref: "#/definitions/Label" + put: + tags: + - "Pull Requests" + summary: "替换Pull Request 所有标签" + description: "替换Pull Request 所有标签\n 需要在请求的body里填上数组，元素为标签的名字。如: [\"performance\", \"\ + bug\"]" + operationId: "putV5ReposOwnerRepoPullsNumberLabels" + consumes: + - "application/json" + - "multipart/form-data" + produces: + - "application/json" + parameters: + - in: "body" + name: "body" + description: "必选，标签的内容" + required: true + schema: + $ref: "#/definitions/PullRequestLabelPostParam" + x-exportParamName: "Body" + responses: + 202: + description: "返回格式" + schema: + type: "array" + items: + $ref: "#/definitions/Label" + /v5/repos/{owner}/{repo}/pulls/{number}/labels/{name}: parameters: - name: "owner" @@ -13941,7 +13972,7 @@ definitions: icon: type: "string" user: - type: "string" + $ref: "#/definitions/User" content: type: "string" created_at: diff --git a/docs/OperateLog.md b/docs/OperateLog.md index 757bf3e..2891a27 100644 --- a/docs/OperateLog.md +++ b/docs/OperateLog.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **string** | | [optional] [default to null] **Icon** | **string** | | [optional] [default to null] -**User** | **string** | | [optional] [default to null] +**User** | [***User**](User.md) | | [optional] [default to null] **Content** | **string** | | [optional] [default to null] **CreatedAt** | **string** | | [optional] [default to null] diff --git a/docs/PullRequestsApi.md b/docs/PullRequestsApi.md index 4c85ea9..f37d004 100644 --- a/docs/PullRequestsApi.md +++ b/docs/PullRequestsApi.md @@ -15,6 +15,7 @@ Method | HTTP request | Description [**GetV5ReposOwnerRepoPullsNumberComments**](PullRequestsApi.md#GetV5ReposOwnerRepoPullsNumberComments) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/comments | 获取某个Pull Request的所有评论 [**GetV5ReposOwnerRepoPullsNumberCommits**](PullRequestsApi.md#GetV5ReposOwnerRepoPullsNumberCommits) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/commits | 获取某Pull Request的所有Commit信息。最多显示250条Commit [**GetV5ReposOwnerRepoPullsNumberFiles**](PullRequestsApi.md#GetV5ReposOwnerRepoPullsNumberFiles) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/files | Pull Request Commit文件列表。最多显示300条diff +[**GetV5ReposOwnerRepoPullsNumberIssues**](PullRequestsApi.md#GetV5ReposOwnerRepoPullsNumberIssues) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/issues | 获取 Pull Request 关联的 issues [**GetV5ReposOwnerRepoPullsNumberLabels**](PullRequestsApi.md#GetV5ReposOwnerRepoPullsNumberLabels) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/labels | 获取某个 Pull Request 的所有标签 [**GetV5ReposOwnerRepoPullsNumberMerge**](PullRequestsApi.md#GetV5ReposOwnerRepoPullsNumberMerge) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/merge | 判断Pull Request是否已经合并 [**GetV5ReposOwnerRepoPullsNumberOperateLogs**](PullRequestsApi.md#GetV5ReposOwnerRepoPullsNumberOperateLogs) | **Get** /v5/repos/{owner}/{repo}/pulls/{number}/operate_logs | 获取某个Pull Request的操作日志 @@ -25,6 +26,7 @@ Method | HTTP request | Description [**PostV5ReposOwnerRepoPullsNumberComments**](PullRequestsApi.md#PostV5ReposOwnerRepoPullsNumberComments) | **Post** /v5/repos/{owner}/{repo}/pulls/{number}/comments | 提交Pull Request评论 [**PostV5ReposOwnerRepoPullsNumberLabels**](PullRequestsApi.md#PostV5ReposOwnerRepoPullsNumberLabels) | **Post** /v5/repos/{owner}/{repo}/pulls/{number}/labels | 创建 Pull Request 标签 [**PostV5ReposOwnerRepoPullsNumberTesters**](PullRequestsApi.md#PostV5ReposOwnerRepoPullsNumberTesters) | **Post** /v5/repos/{owner}/{repo}/pulls/{number}/testers | 指派用户测试 Pull Request +[**PutV5ReposOwnerRepoPullsNumberLabels**](PullRequestsApi.md#PutV5ReposOwnerRepoPullsNumberLabels) | **Put** /v5/repos/{owner}/{repo}/pulls/{number}/labels | 替换Pull Request 所有标签 [**PutV5ReposOwnerRepoPullsNumberMerge**](PullRequestsApi.md#PutV5ReposOwnerRepoPullsNumberMerge) | **Put** /v5/repos/{owner}/{repo}/pulls/{number}/merge | 合并Pull Request @@ -497,6 +499,49 @@ 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) +# **GetV5ReposOwnerRepoPullsNumberIssues** +> []Issue GetV5ReposOwnerRepoPullsNumberIssues(ctx, owner, repo, number, optional) +获取 Pull Request 关联的 issues + +获取 Pull Request 关联的 issues + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | + **repo** | **string**| 仓库路径(path) | + **number** | **int32**| | + **optional** | ***GetV5ReposOwnerRepoPullsNumberIssuesOpts** | optional parameters | nil if no parameters + +### Optional Parameters +Optional parameters are passed through a pointer to a GetV5ReposOwnerRepoPullsNumberIssuesOpts struct + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **accessToken** | **optional.String**| 用户授权码 | + **page** | **optional.Int32**| 当前的页码 | [default to 1] + **perPage** | **optional.Int32**| 每页的数量，最大为 100 | [default to 20] + +### Return type + +[**[]Issue**](Issue.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + # **GetV5ReposOwnerRepoPullsNumberLabels** > []Label GetV5ReposOwnerRepoPullsNumberLabels(ctx, owner, repo, number, optional) 获取某个 Pull Request 的所有标签 @@ -582,7 +627,7 @@ 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) # **GetV5ReposOwnerRepoPullsNumberOperateLogs** -> OperateLog GetV5ReposOwnerRepoPullsNumberOperateLogs(ctx, owner, repo, number, optional) +> []OperateLog GetV5ReposOwnerRepoPullsNumberOperateLogs(ctx, owner, repo, number, optional) 获取某个Pull Request的操作日志 获取某个Pull Request的操作日志 @@ -610,7 +655,7 @@ Name | Type | Description | Notes ### Return type -[**OperateLog**](OperateLog.md) +[**[]OperateLog**](OperateLog.md) ### Authorization @@ -851,6 +896,37 @@ 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) +# **PutV5ReposOwnerRepoPullsNumberLabels** +> []Label PutV5ReposOwnerRepoPullsNumberLabels(ctx, owner, repo, number, body) +替换Pull Request 所有标签 + +替换Pull Request 所有标签 需要在请求的body里填上数组，元素为标签的名字。如: [\"performance\", \"bug\"] + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | + **repo** | **string**| 仓库路径(path) | + **number** | **int32**| 第几个PR，即本仓库PR的序数 | + **body** | [**PullRequestLabelPostParam**](PullRequestLabelPostParam.md)| 必选，标签的内容 | + +### Return type + +[**[]Label**](Label.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + +[[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) + # **PutV5ReposOwnerRepoPullsNumberMerge** > PutV5ReposOwnerRepoPullsNumberMerge(ctx, owner, repo, number, body) 合并Pull Request diff --git a/gitee/api_pull_requests.go b/gitee/api_pull_requests.go index 61b6902..d67bc75 100644 --- a/gitee/api_pull_requests.go +++ b/gitee/api_pull_requests.go @@ -1522,7 +1522,7 @@ PullRequestsApiService 获取某个Pull Request的操作日志 * @param "AccessToken" (optional.String) - 用户授权码 * @param "Sort" (optional.String) - 按递增(asc)或递减(desc)排序，默认：递减 -@return OperateLog +@return []OperateLog */ type GetV5ReposOwnerRepoPullsNumberOperateLogsOpts struct { @@ -2374,23 +2374,18 @@ func (a *PullRequestsApiService) PutV5ReposOwnerRepoPullsNumberMerge(ctx context return localVarHttpResponse, nil } -type PutV5ReposOwnerRepoPullsNumberLabelsOpts struct { - AccessToken optional.String - Body optional.Interface -} - /* -PullRequestsApiService 替换 Pull Request 标签 -合并Pull Request +PullRequestsApiService 替换Pull Request 所有标签 +替换Pull Request 所有标签 需要在请求的body里填上数组，元素为标签的名字。如: [\"performance\", \"bug\"] * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param owner 仓库所属空间地址(企业、组织或个人的地址path) * @param repo 仓库路径(path) * @param number 第几个PR，即本仓库PR的序数 - * @param body PullRequest 需替换的标签 - + * @param body 必选，标签的内容 +@return []Label */ -func (a *PullRequestsApiService) PutV5ReposOwnerRepoPullsNumberLabels(ctx context.Context, owner string, repo string, number int32, localVarOptionals *PutV5ReposOwnerRepoPullsNumberLabelsOpts) ([]Label, *http.Response, error) { +func (a *PullRequestsApiService) PutV5ReposOwnerRepoPullsNumberLabels(ctx context.Context, owner string, repo string, number int32, body PullRequestLabelPostParam) ([]Label, *http.Response, error) { var ( localVarHttpMethod = strings.ToUpper("Put") localVarPostBody interface{} @@ -2426,13 +2421,8 @@ func (a *PullRequestsApiService) PutV5ReposOwnerRepoPullsNumberLabels(ctx contex if localVarHttpHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHttpHeaderAccept } - if localVarOptionals != nil && localVarOptionals.AccessToken.IsSet() { - localVarFormParams.Add("access_token", parameterToString(localVarOptionals.AccessToken.Value(), "")) - } - - if localVarOptionals != nil && localVarOptionals.Body.IsSet() { - localVarPostBody = localVarOptionals.Body.Value() - } + // body params + localVarPostBody = &body.Body // This should not be &body because the gitee api is not normalized. r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) if err != nil { return localVarReturnValue, nil, err @@ -2463,7 +2453,7 @@ func (a *PullRequestsApiService) PutV5ReposOwnerRepoPullsNumberLabels(ctx contex error: localVarHttpResponse.Status, } - if localVarHttpResponse.StatusCode == 200 { + if localVarHttpResponse.StatusCode == 202 { var v []Label err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type")) if err != nil { diff --git a/gitee/model_operate_log.go b/gitee/model_operate_log.go index 369c3af..2421e55 100644 --- a/gitee/model_operate_log.go +++ b/gitee/model_operate_log.go @@ -13,7 +13,7 @@ package gitee type OperateLog struct { Id string `json:"id,omitempty"` Icon string `json:"icon,omitempty"` - User User `json:"user,omitempty"` + User *User `json:"user,omitempty"` Content string `json:"content,omitempty"` CreatedAt string `json:"created_at,omitempty"` } -- Gitee