gitee.com/openeuler/go-gitee@v0.0.0-20220530104019-3af895bc380c/docs/LabelsApi.md (about)

     1  # \LabelsApi
     2  
     3  All URIs are relative to *https://gitee.com/api*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteV5ReposOwnerRepoIssuesNumberLabels**](LabelsApi.md#DeleteV5ReposOwnerRepoIssuesNumberLabels) | **Delete** /v5/repos/{owner}/{repo}/issues/{number}/labels | 删除Issue所有标签
     8  [**DeleteV5ReposOwnerRepoIssuesNumberLabelsName**](LabelsApi.md#DeleteV5ReposOwnerRepoIssuesNumberLabelsName) | **Delete** /v5/repos/{owner}/{repo}/issues/{number}/labels/{name} | 删除Issue标签
     9  [**DeleteV5ReposOwnerRepoLabelsName**](LabelsApi.md#DeleteV5ReposOwnerRepoLabelsName) | **Delete** /v5/repos/{owner}/{repo}/labels/{name} | 删除一个仓库任务标签
    10  [**GetV5EnterprisesEnterpriseLabels**](LabelsApi.md#GetV5EnterprisesEnterpriseLabels) | **Get** /v5/enterprises/{enterprise}/labels | 获取企业所有标签
    11  [**GetV5EnterprisesEnterpriseLabelsName**](LabelsApi.md#GetV5EnterprisesEnterpriseLabelsName) | **Get** /v5/enterprises/{enterprise}/labels/{name} | 获取企业某个标签
    12  [**GetV5ReposOwnerRepoIssuesNumberLabels**](LabelsApi.md#GetV5ReposOwnerRepoIssuesNumberLabels) | **Get** /v5/repos/{owner}/{repo}/issues/{number}/labels | 获取仓库任务的所有标签
    13  [**GetV5ReposOwnerRepoLabels**](LabelsApi.md#GetV5ReposOwnerRepoLabels) | **Get** /v5/repos/{owner}/{repo}/labels | 获取仓库所有任务标签
    14  [**GetV5ReposOwnerRepoLabelsName**](LabelsApi.md#GetV5ReposOwnerRepoLabelsName) | **Get** /v5/repos/{owner}/{repo}/labels/{name} | 根据标签名称获取单个标签
    15  [**PatchV5ReposOwnerRepoLabelsOriginalName**](LabelsApi.md#PatchV5ReposOwnerRepoLabelsOriginalName) | **Patch** /v5/repos/{owner}/{repo}/labels/{original_name} | 更新一个仓库任务标签
    16  [**PostV5ReposOwnerRepoIssuesNumberLabels**](LabelsApi.md#PostV5ReposOwnerRepoIssuesNumberLabels) | **Post** /v5/repos/{owner}/{repo}/issues/{number}/labels | 创建Issue标签
    17  [**PostV5ReposOwnerRepoLabels**](LabelsApi.md#PostV5ReposOwnerRepoLabels) | **Post** /v5/repos/{owner}/{repo}/labels | 创建仓库任务标签
    18  [**PutV5ReposOwnerRepoIssuesNumberLabels**](LabelsApi.md#PutV5ReposOwnerRepoIssuesNumberLabels) | **Put** /v5/repos/{owner}/{repo}/issues/{number}/labels | 替换Issue所有标签
    19  
    20  
    21  # **DeleteV5ReposOwnerRepoIssuesNumberLabels**
    22  > DeleteV5ReposOwnerRepoIssuesNumberLabels(ctx, owner, repo, number, optional)
    23  删除Issue所有标签
    24  
    25  删除Issue所有标签
    26  
    27  ### Required Parameters
    28  
    29  Name | Type | Description  | Notes
    30  ------------- | ------------- | ------------- | -------------
    31   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    32    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
    33    **repo** | **string**| 仓库路径(path) | 
    34    **number** | **string**| Issue 编号(区分大小写,无需添加 # 号) | 
    35   **optional** | ***DeleteV5ReposOwnerRepoIssuesNumberLabelsOpts** | optional parameters | nil if no parameters
    36  
    37  ### Optional Parameters
    38  Optional parameters are passed through a pointer to a DeleteV5ReposOwnerRepoIssuesNumberLabelsOpts struct
    39  
    40  Name | Type | Description  | Notes
    41  ------------- | ------------- | ------------- | -------------
    42  
    43  
    44  
    45   **accessToken** | **optional.String**| 用户授权码 | 
    46  
    47  ### Return type
    48  
    49   (empty response body)
    50  
    51  ### Authorization
    52  
    53  No authorization required
    54  
    55  ### HTTP request headers
    56  
    57   - **Content-Type**: application/json, multipart/form-data
    58   - **Accept**: application/json
    59  
    60  [[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)
    61  
    62  # **DeleteV5ReposOwnerRepoIssuesNumberLabelsName**
    63  > DeleteV5ReposOwnerRepoIssuesNumberLabelsName(ctx, owner, repo, number, name, optional)
    64  删除Issue标签
    65  
    66  删除Issue标签
    67  
    68  ### Required Parameters
    69  
    70  Name | Type | Description  | Notes
    71  ------------- | ------------- | ------------- | -------------
    72   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    73    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
    74    **repo** | **string**| 仓库路径(path) | 
    75    **number** | **string**| Issue 编号(区分大小写,无需添加 # 号) | 
    76    **name** | **string**| 标签名称 | 
    77   **optional** | ***DeleteV5ReposOwnerRepoIssuesNumberLabelsNameOpts** | optional parameters | nil if no parameters
    78  
    79  ### Optional Parameters
    80  Optional parameters are passed through a pointer to a DeleteV5ReposOwnerRepoIssuesNumberLabelsNameOpts struct
    81  
    82  Name | Type | Description  | Notes
    83  ------------- | ------------- | ------------- | -------------
    84  
    85  
    86  
    87  
    88   **accessToken** | **optional.String**| 用户授权码 | 
    89  
    90  ### Return type
    91  
    92   (empty response body)
    93  
    94  ### Authorization
    95  
    96  No authorization required
    97  
    98  ### HTTP request headers
    99  
   100   - **Content-Type**: application/json, multipart/form-data
   101   - **Accept**: application/json
   102  
   103  [[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)
   104  
   105  # **DeleteV5ReposOwnerRepoLabelsName**
   106  > DeleteV5ReposOwnerRepoLabelsName(ctx, owner, repo, name, optional)
   107  删除一个仓库任务标签
   108  
   109  删除一个仓库任务标签
   110  
   111  ### Required Parameters
   112  
   113  Name | Type | Description  | Notes
   114  ------------- | ------------- | ------------- | -------------
   115   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   117    **repo** | **string**| 仓库路径(path) | 
   118    **name** | **string**| 标签名称 | 
   119   **optional** | ***DeleteV5ReposOwnerRepoLabelsNameOpts** | optional parameters | nil if no parameters
   120  
   121  ### Optional Parameters
   122  Optional parameters are passed through a pointer to a DeleteV5ReposOwnerRepoLabelsNameOpts struct
   123  
   124  Name | Type | Description  | Notes
   125  ------------- | ------------- | ------------- | -------------
   126  
   127  
   128  
   129   **accessToken** | **optional.String**| 用户授权码 | 
   130  
   131  ### Return type
   132  
   133   (empty response body)
   134  
   135  ### Authorization
   136  
   137  No authorization required
   138  
   139  ### HTTP request headers
   140  
   141   - **Content-Type**: application/json, multipart/form-data
   142   - **Accept**: application/json
   143  
   144  [[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)
   145  
   146  # **GetV5EnterprisesEnterpriseLabels**
   147  > []Label GetV5EnterprisesEnterpriseLabels(ctx, enterprise, optional)
   148  获取企业所有标签
   149  
   150  获取企业所有标签
   151  
   152  ### Required Parameters
   153  
   154  Name | Type | Description  | Notes
   155  ------------- | ------------- | ------------- | -------------
   156   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   157    **enterprise** | **string**| 企业的路径(path/login) | 
   158   **optional** | ***GetV5EnterprisesEnterpriseLabelsOpts** | optional parameters | nil if no parameters
   159  
   160  ### Optional Parameters
   161  Optional parameters are passed through a pointer to a GetV5EnterprisesEnterpriseLabelsOpts struct
   162  
   163  Name | Type | Description  | Notes
   164  ------------- | ------------- | ------------- | -------------
   165  
   166   **accessToken** | **optional.String**| 用户授权码 | 
   167  
   168  ### Return type
   169  
   170  [**[]Label**](Label.md)
   171  
   172  ### Authorization
   173  
   174  No authorization required
   175  
   176  ### HTTP request headers
   177  
   178   - **Content-Type**: application/json, multipart/form-data
   179   - **Accept**: application/json
   180  
   181  [[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)
   182  
   183  # **GetV5EnterprisesEnterpriseLabelsName**
   184  > Label GetV5EnterprisesEnterpriseLabelsName(ctx, enterprise, name, optional)
   185  获取企业某个标签
   186  
   187  获取企业某个标签
   188  
   189  ### Required Parameters
   190  
   191  Name | Type | Description  | Notes
   192  ------------- | ------------- | ------------- | -------------
   193   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   194    **enterprise** | **string**| 企业的路径(path/login) | 
   195    **name** | **string**| 标签名称 | 
   196   **optional** | ***GetV5EnterprisesEnterpriseLabelsNameOpts** | optional parameters | nil if no parameters
   197  
   198  ### Optional Parameters
   199  Optional parameters are passed through a pointer to a GetV5EnterprisesEnterpriseLabelsNameOpts struct
   200  
   201  Name | Type | Description  | Notes
   202  ------------- | ------------- | ------------- | -------------
   203  
   204  
   205   **accessToken** | **optional.String**| 用户授权码 | 
   206  
   207  ### Return type
   208  
   209  [**Label**](Label.md)
   210  
   211  ### Authorization
   212  
   213  No authorization required
   214  
   215  ### HTTP request headers
   216  
   217   - **Content-Type**: application/json, multipart/form-data
   218   - **Accept**: application/json
   219  
   220  [[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)
   221  
   222  # **GetV5ReposOwnerRepoIssuesNumberLabels**
   223  > []Label GetV5ReposOwnerRepoIssuesNumberLabels(ctx, owner, repo, number, optional)
   224  获取仓库任务的所有标签
   225  
   226  获取仓库任务的所有标签
   227  
   228  ### Required Parameters
   229  
   230  Name | Type | Description  | Notes
   231  ------------- | ------------- | ------------- | -------------
   232   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   233    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   234    **repo** | **string**| 仓库路径(path) | 
   235    **number** | **string**| Issue 编号(区分大小写,无需添加 # 号) | 
   236   **optional** | ***GetV5ReposOwnerRepoIssuesNumberLabelsOpts** | optional parameters | nil if no parameters
   237  
   238  ### Optional Parameters
   239  Optional parameters are passed through a pointer to a GetV5ReposOwnerRepoIssuesNumberLabelsOpts struct
   240  
   241  Name | Type | Description  | Notes
   242  ------------- | ------------- | ------------- | -------------
   243  
   244  
   245  
   246   **accessToken** | **optional.String**| 用户授权码 | 
   247  
   248  ### Return type
   249  
   250  [**[]Label**](Label.md)
   251  
   252  ### Authorization
   253  
   254  No authorization required
   255  
   256  ### HTTP request headers
   257  
   258   - **Content-Type**: application/json, multipart/form-data
   259   - **Accept**: application/json
   260  
   261  [[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)
   262  
   263  # **GetV5ReposOwnerRepoLabels**
   264  > []Label GetV5ReposOwnerRepoLabels(ctx, owner, repo, optional)
   265  获取仓库所有任务标签
   266  
   267  获取仓库所有任务标签
   268  
   269  ### Required Parameters
   270  
   271  Name | Type | Description  | Notes
   272  ------------- | ------------- | ------------- | -------------
   273   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   274    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   275    **repo** | **string**| 仓库路径(path) | 
   276   **optional** | ***GetV5ReposOwnerRepoLabelsOpts** | optional parameters | nil if no parameters
   277  
   278  ### Optional Parameters
   279  Optional parameters are passed through a pointer to a GetV5ReposOwnerRepoLabelsOpts struct
   280  
   281  Name | Type | Description  | Notes
   282  ------------- | ------------- | ------------- | -------------
   283  
   284  
   285   **accessToken** | **optional.String**| 用户授权码 | 
   286  
   287  ### Return type
   288  
   289  [**[]Label**](Label.md)
   290  
   291  ### Authorization
   292  
   293  No authorization required
   294  
   295  ### HTTP request headers
   296  
   297   - **Content-Type**: application/json, multipart/form-data
   298   - **Accept**: application/json
   299  
   300  [[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)
   301  
   302  # **GetV5ReposOwnerRepoLabelsName**
   303  > Label GetV5ReposOwnerRepoLabelsName(ctx, owner, repo, name, optional)
   304  根据标签名称获取单个标签
   305  
   306  根据标签名称获取单个标签
   307  
   308  ### Required Parameters
   309  
   310  Name | Type | Description  | Notes
   311  ------------- | ------------- | ------------- | -------------
   312   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   313    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   314    **repo** | **string**| 仓库路径(path) | 
   315    **name** | **string**| 标签名称 | 
   316   **optional** | ***GetV5ReposOwnerRepoLabelsNameOpts** | optional parameters | nil if no parameters
   317  
   318  ### Optional Parameters
   319  Optional parameters are passed through a pointer to a GetV5ReposOwnerRepoLabelsNameOpts struct
   320  
   321  Name | Type | Description  | Notes
   322  ------------- | ------------- | ------------- | -------------
   323  
   324  
   325  
   326   **accessToken** | **optional.String**| 用户授权码 | 
   327  
   328  ### Return type
   329  
   330  [**Label**](Label.md)
   331  
   332  ### Authorization
   333  
   334  No authorization required
   335  
   336  ### HTTP request headers
   337  
   338   - **Content-Type**: application/json, multipart/form-data
   339   - **Accept**: application/json
   340  
   341  [[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)
   342  
   343  # **PatchV5ReposOwnerRepoLabelsOriginalName**
   344  > Label PatchV5ReposOwnerRepoLabelsOriginalName(ctx, owner, repo, originalName, optional)
   345  更新一个仓库任务标签
   346  
   347  更新一个仓库任务标签
   348  
   349  ### Required Parameters
   350  
   351  Name | Type | Description  | Notes
   352  ------------- | ------------- | ------------- | -------------
   353   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   354    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   355    **repo** | **string**| 仓库路径(path) | 
   356    **originalName** | **string**| 标签原有名称 | 
   357   **optional** | ***PatchV5ReposOwnerRepoLabelsOriginalNameOpts** | optional parameters | nil if no parameters
   358  
   359  ### Optional Parameters
   360  Optional parameters are passed through a pointer to a PatchV5ReposOwnerRepoLabelsOriginalNameOpts struct
   361  
   362  Name | Type | Description  | Notes
   363  ------------- | ------------- | ------------- | -------------
   364  
   365  
   366  
   367   **accessToken** | **optional.String**| 用户授权码 | 
   368   **name** | **optional.String**| 标签新名称 | 
   369   **color** | **optional.String**| 标签新颜色 | 
   370  
   371  ### Return type
   372  
   373  [**Label**](Label.md)
   374  
   375  ### Authorization
   376  
   377  No authorization required
   378  
   379  ### HTTP request headers
   380  
   381   - **Content-Type**: application/json, multipart/form-data
   382   - **Accept**: application/json
   383  
   384  [[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)
   385  
   386  # **PostV5ReposOwnerRepoIssuesNumberLabels**
   387  > []Label PostV5ReposOwnerRepoIssuesNumberLabels(ctx, owner, repo, number, body)
   388  创建Issue标签
   389  
   390  创建Issue标签  需要在请求的body里填上数组,元素为标签的名字。如: [\"performance\", \"bug\"]
   391  
   392  ### Required Parameters
   393  
   394  Name | Type | Description  | Notes
   395  ------------- | ------------- | ------------- | -------------
   396   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   397    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   398    **repo** | **string**| 仓库路径(path) | 
   399    **number** | **string**| Issue 编号(区分大小写,无需添加 # 号) | 
   400    **body** | [**PullRequestLabelPostParam**](PullRequestLabelPostParam.md)| 必选,标签的内容 | 
   401  
   402  ### Return type
   403  
   404  [**[]Label**](Label.md)
   405  
   406  ### Authorization
   407  
   408  No authorization required
   409  
   410  ### HTTP request headers
   411  
   412   - **Content-Type**: application/json, multipart/form-data
   413   - **Accept**: application/json
   414  
   415  [[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)
   416  
   417  # **PostV5ReposOwnerRepoLabels**
   418  > Label PostV5ReposOwnerRepoLabels(ctx, owner, repo, body)
   419  创建仓库任务标签
   420  
   421  创建仓库任务标签
   422  
   423  ### Required Parameters
   424  
   425  Name | Type | Description  | Notes
   426  ------------- | ------------- | ------------- | -------------
   427   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   428    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   429    **repo** | **string**| 仓库路径(path) | 
   430    **body** | [**LabelPostParam**](LabelPostParam.md)| 必选,标签的内容 | 
   431  
   432  ### Return type
   433  
   434  [**Label**](Label.md)
   435  
   436  ### Authorization
   437  
   438  No authorization required
   439  
   440  ### HTTP request headers
   441  
   442   - **Content-Type**: application/json, multipart/form-data
   443   - **Accept**: application/json
   444  
   445  [[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)
   446  
   447  # **PutV5ReposOwnerRepoIssuesNumberLabels**
   448  > []Label PutV5ReposOwnerRepoIssuesNumberLabels(ctx, owner, repo, number, body)
   449  替换Issue所有标签
   450  
   451  替换Issue所有标签  需要在请求的body里填上数组,元素为标签的名字。如: [\"performance\", \"bug\"]
   452  
   453  ### Required Parameters
   454  
   455  Name | Type | Description  | Notes
   456  ------------- | ------------- | ------------- | -------------
   457   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   458    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   459    **repo** | **string**| 仓库路径(path) | 
   460    **number** | **string**| Issue 编号(区分大小写,无需添加 # 号) | 
   461    **body** | [**PullRequestLabelPostParam**](PullRequestLabelPostParam.md)| 必选,标签的内容 | 
   462  
   463  ### Return type
   464  
   465  [**[]Label**](Label.md)
   466  
   467  ### Authorization
   468  
   469  No authorization required
   470  
   471  ### HTTP request headers
   472  
   473   - **Content-Type**: application/json, multipart/form-data
   474   - **Accept**: application/json
   475  
   476  [[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)
   477