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

     1  # \MilestonesApi
     2  
     3  All URIs are relative to *https://gitee.com/api*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteV5ReposOwnerRepoMilestonesNumber**](MilestonesApi.md#DeleteV5ReposOwnerRepoMilestonesNumber) | **Delete** /v5/repos/{owner}/{repo}/milestones/{number} | 删除仓库单个里程碑
     8  [**GetV5ReposOwnerRepoMilestones**](MilestonesApi.md#GetV5ReposOwnerRepoMilestones) | **Get** /v5/repos/{owner}/{repo}/milestones | 获取仓库所有里程碑
     9  [**GetV5ReposOwnerRepoMilestonesNumber**](MilestonesApi.md#GetV5ReposOwnerRepoMilestonesNumber) | **Get** /v5/repos/{owner}/{repo}/milestones/{number} | 获取仓库单个里程碑
    10  [**PatchV5ReposOwnerRepoMilestonesNumber**](MilestonesApi.md#PatchV5ReposOwnerRepoMilestonesNumber) | **Patch** /v5/repos/{owner}/{repo}/milestones/{number} | 更新仓库里程碑
    11  [**PostV5ReposOwnerRepoMilestones**](MilestonesApi.md#PostV5ReposOwnerRepoMilestones) | **Post** /v5/repos/{owner}/{repo}/milestones | 创建仓库里程碑
    12  
    13  
    14  # **DeleteV5ReposOwnerRepoMilestonesNumber**
    15  > DeleteV5ReposOwnerRepoMilestonesNumber(ctx, owner, repo, number, optional)
    16  删除仓库单个里程碑
    17  
    18  删除仓库单个里程碑
    19  
    20  ### Required Parameters
    21  
    22  Name | Type | Description  | Notes
    23  ------------- | ------------- | ------------- | -------------
    24   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    25    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
    26    **repo** | **string**| 仓库路径(path) | 
    27    **number** | **int32**| 里程碑序号(id) | 
    28   **optional** | ***DeleteV5ReposOwnerRepoMilestonesNumberOpts** | optional parameters | nil if no parameters
    29  
    30  ### Optional Parameters
    31  Optional parameters are passed through a pointer to a DeleteV5ReposOwnerRepoMilestonesNumberOpts struct
    32  
    33  Name | Type | Description  | Notes
    34  ------------- | ------------- | ------------- | -------------
    35  
    36  
    37  
    38   **accessToken** | **optional.String**| 用户授权码 | 
    39  
    40  ### Return type
    41  
    42   (empty response body)
    43  
    44  ### Authorization
    45  
    46  No authorization required
    47  
    48  ### HTTP request headers
    49  
    50   - **Content-Type**: application/json, multipart/form-data
    51   - **Accept**: application/json
    52  
    53  [[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)
    54  
    55  # **GetV5ReposOwnerRepoMilestones**
    56  > []Milestone GetV5ReposOwnerRepoMilestones(ctx, owner, repo, optional)
    57  获取仓库所有里程碑
    58  
    59  获取仓库所有里程碑
    60  
    61  ### Required Parameters
    62  
    63  Name | Type | Description  | Notes
    64  ------------- | ------------- | ------------- | -------------
    65   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    66    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
    67    **repo** | **string**| 仓库路径(path) | 
    68   **optional** | ***GetV5ReposOwnerRepoMilestonesOpts** | optional parameters | nil if no parameters
    69  
    70  ### Optional Parameters
    71  Optional parameters are passed through a pointer to a GetV5ReposOwnerRepoMilestonesOpts struct
    72  
    73  Name | Type | Description  | Notes
    74  ------------- | ------------- | ------------- | -------------
    75  
    76  
    77   **accessToken** | **optional.String**| 用户授权码 | 
    78   **state** | **optional.String**| 里程碑状态: open, closed, all。默认: open | [default to open]
    79   **sort** | **optional.String**| 排序方式: due_on | [default to due_on]
    80   **direction** | **optional.String**| 升序(asc)或是降序(desc)。默认: asc | 
    81   **page** | **optional.Int32**| 当前的页码 | [default to 1]
    82   **perPage** | **optional.Int32**| 每页的数量,最大为 100 | [default to 20]
    83  
    84  ### Return type
    85  
    86  [**[]Milestone**](Milestone.md)
    87  
    88  ### Authorization
    89  
    90  No authorization required
    91  
    92  ### HTTP request headers
    93  
    94   - **Content-Type**: application/json, multipart/form-data
    95   - **Accept**: application/json
    96  
    97  [[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)
    98  
    99  # **GetV5ReposOwnerRepoMilestonesNumber**
   100  > Milestone GetV5ReposOwnerRepoMilestonesNumber(ctx, owner, repo, number, optional)
   101  获取仓库单个里程碑
   102  
   103  获取仓库单个里程碑
   104  
   105  ### Required Parameters
   106  
   107  Name | Type | Description  | Notes
   108  ------------- | ------------- | ------------- | -------------
   109   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   110    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   111    **repo** | **string**| 仓库路径(path) | 
   112    **number** | **int32**| 里程碑序号(id) | 
   113   **optional** | ***GetV5ReposOwnerRepoMilestonesNumberOpts** | optional parameters | nil if no parameters
   114  
   115  ### Optional Parameters
   116  Optional parameters are passed through a pointer to a GetV5ReposOwnerRepoMilestonesNumberOpts struct
   117  
   118  Name | Type | Description  | Notes
   119  ------------- | ------------- | ------------- | -------------
   120  
   121  
   122  
   123   **accessToken** | **optional.String**| 用户授权码 | 
   124  
   125  ### Return type
   126  
   127  [**Milestone**](Milestone.md)
   128  
   129  ### Authorization
   130  
   131  No authorization required
   132  
   133  ### HTTP request headers
   134  
   135   - **Content-Type**: application/json, multipart/form-data
   136   - **Accept**: application/json
   137  
   138  [[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)
   139  
   140  # **PatchV5ReposOwnerRepoMilestonesNumber**
   141  > Milestone PatchV5ReposOwnerRepoMilestonesNumber(ctx, owner, repo, number, title, dueOn, optional)
   142  更新仓库里程碑
   143  
   144  更新仓库里程碑
   145  
   146  ### Required Parameters
   147  
   148  Name | Type | Description  | Notes
   149  ------------- | ------------- | ------------- | -------------
   150   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   151    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   152    **repo** | **string**| 仓库路径(path) | 
   153    **number** | **int32**| 里程碑序号(id) | 
   154    **title** | **string**| 里程碑标题 | 
   155    **dueOn** | **string**| 里程碑的截止日期 | 
   156   **optional** | ***PatchV5ReposOwnerRepoMilestonesNumberOpts** | optional parameters | nil if no parameters
   157  
   158  ### Optional Parameters
   159  Optional parameters are passed through a pointer to a PatchV5ReposOwnerRepoMilestonesNumberOpts struct
   160  
   161  Name | Type | Description  | Notes
   162  ------------- | ------------- | ------------- | -------------
   163  
   164  
   165  
   166  
   167  
   168   **accessToken** | **optional.String**| 用户授权码 | 
   169   **state** | **optional.String**| 里程碑状态: open, closed, all。默认: open | [default to open]
   170   **description** | **optional.String**| 里程碑具体描述 | 
   171  
   172  ### Return type
   173  
   174  [**Milestone**](Milestone.md)
   175  
   176  ### Authorization
   177  
   178  No authorization required
   179  
   180  ### HTTP request headers
   181  
   182   - **Content-Type**: application/json, multipart/form-data
   183   - **Accept**: application/json
   184  
   185  [[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)
   186  
   187  # **PostV5ReposOwnerRepoMilestones**
   188  > Milestone PostV5ReposOwnerRepoMilestones(ctx, owner, repo, title, dueOn, optional)
   189  创建仓库里程碑
   190  
   191  创建仓库里程碑
   192  
   193  ### Required Parameters
   194  
   195  Name | Type | Description  | Notes
   196  ------------- | ------------- | ------------- | -------------
   197   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   198    **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 
   199    **repo** | **string**| 仓库路径(path) | 
   200    **title** | **string**| 里程碑标题 | 
   201    **dueOn** | **string**| 里程碑的截止日期 | 
   202   **optional** | ***PostV5ReposOwnerRepoMilestonesOpts** | optional parameters | nil if no parameters
   203  
   204  ### Optional Parameters
   205  Optional parameters are passed through a pointer to a PostV5ReposOwnerRepoMilestonesOpts struct
   206  
   207  Name | Type | Description  | Notes
   208  ------------- | ------------- | ------------- | -------------
   209  
   210  
   211  
   212  
   213   **accessToken** | **optional.String**| 用户授权码 | 
   214   **state** | **optional.String**| 里程碑状态: open, closed, all。默认: open | [default to open]
   215   **description** | **optional.String**| 里程碑具体描述 | 
   216  
   217  ### Return type
   218  
   219  [**Milestone**](Milestone.md)
   220  
   221  ### Authorization
   222  
   223  No authorization required
   224  
   225  ### HTTP request headers
   226  
   227   - **Content-Type**: application/json, multipart/form-data
   228   - **Accept**: application/json
   229  
   230  [[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)
   231