gitee.com/openeuler/go-gitee@v0.0.0-20220530104019-3af895bc380c/docs/MiscellaneousApi.md (about) 1 # \MiscellaneousApi 2 3 All URIs are relative to *https://gitee.com/api* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**GetV5Emojis**](MiscellaneousApi.md#GetV5Emojis) | **Get** /v5/emojis | 列出可使用的 Emoji 8 [**GetV5GitignoreTemplates**](MiscellaneousApi.md#GetV5GitignoreTemplates) | **Get** /v5/gitignore/templates | 列出可使用的 .gitignore 模板 9 [**GetV5GitignoreTemplatesName**](MiscellaneousApi.md#GetV5GitignoreTemplatesName) | **Get** /v5/gitignore/templates/{name} | 获取一个 .gitignore 模板 10 [**GetV5GitignoreTemplatesNameRaw**](MiscellaneousApi.md#GetV5GitignoreTemplatesNameRaw) | **Get** /v5/gitignore/templates/{name}/raw | 获取一个 .gitignore 模板原始文件 11 [**GetV5Licenses**](MiscellaneousApi.md#GetV5Licenses) | **Get** /v5/licenses | 列出可使用的开源许可协议 12 [**GetV5LicensesLicense**](MiscellaneousApi.md#GetV5LicensesLicense) | **Get** /v5/licenses/{license} | 获取一个开源许可协议 13 [**GetV5LicensesLicenseRaw**](MiscellaneousApi.md#GetV5LicensesLicenseRaw) | **Get** /v5/licenses/{license}/raw | 获取一个开源许可协议原始文件 14 [**GetV5ReposOwnerRepoLicense**](MiscellaneousApi.md#GetV5ReposOwnerRepoLicense) | **Get** /v5/repos/{owner}/{repo}/license | 获取一个仓库使用的开源许可协议 15 [**PostV5Markdown**](MiscellaneousApi.md#PostV5Markdown) | **Post** /v5/markdown | 渲染 Markdown 文本 16 17 18 # **GetV5Emojis** 19 > GetV5Emojis(ctx, optional) 20 列出可使用的 Emoji 21 22 列出可使用的 Emoji 23 24 ### Required Parameters 25 26 Name | Type | Description | Notes 27 ------------- | ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **optional** | ***GetV5EmojisOpts** | optional parameters | nil if no parameters 30 31 ### Optional Parameters 32 Optional parameters are passed through a pointer to a GetV5EmojisOpts struct 33 34 Name | Type | Description | Notes 35 ------------- | ------------- | ------------- | ------------- 36 **accessToken** | **optional.String**| 用户授权码 | 37 38 ### Return type 39 40 (empty response body) 41 42 ### Authorization 43 44 No authorization required 45 46 ### HTTP request headers 47 48 - **Content-Type**: application/json, multipart/form-data 49 - **Accept**: application/json 50 51 [[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) 52 53 # **GetV5GitignoreTemplates** 54 > GetV5GitignoreTemplates(ctx, optional) 55 列出可使用的 .gitignore 模板 56 57 列出可使用的 .gitignore 模板 58 59 ### Required Parameters 60 61 Name | Type | Description | Notes 62 ------------- | ------------- | ------------- | ------------- 63 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 64 **optional** | ***GetV5GitignoreTemplatesOpts** | optional parameters | nil if no parameters 65 66 ### Optional Parameters 67 Optional parameters are passed through a pointer to a GetV5GitignoreTemplatesOpts struct 68 69 Name | Type | Description | Notes 70 ------------- | ------------- | ------------- | ------------- 71 **accessToken** | **optional.String**| 用户授权码 | 72 73 ### Return type 74 75 (empty response body) 76 77 ### Authorization 78 79 No authorization required 80 81 ### HTTP request headers 82 83 - **Content-Type**: application/json, multipart/form-data 84 - **Accept**: application/json 85 86 [[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) 87 88 # **GetV5GitignoreTemplatesName** 89 > GetV5GitignoreTemplatesName(ctx, name, optional) 90 获取一个 .gitignore 模板 91 92 获取一个 .gitignore 模板 93 94 ### Required Parameters 95 96 Name | Type | Description | Notes 97 ------------- | ------------- | ------------- | ------------- 98 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 99 **name** | **string**| .gitignore 模板名 | 100 **optional** | ***GetV5GitignoreTemplatesNameOpts** | optional parameters | nil if no parameters 101 102 ### Optional Parameters 103 Optional parameters are passed through a pointer to a GetV5GitignoreTemplatesNameOpts struct 104 105 Name | Type | Description | Notes 106 ------------- | ------------- | ------------- | ------------- 107 108 **accessToken** | **optional.String**| 用户授权码 | 109 110 ### Return type 111 112 (empty response body) 113 114 ### Authorization 115 116 No authorization required 117 118 ### HTTP request headers 119 120 - **Content-Type**: application/json, multipart/form-data 121 - **Accept**: application/json 122 123 [[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) 124 125 # **GetV5GitignoreTemplatesNameRaw** 126 > GetV5GitignoreTemplatesNameRaw(ctx, name, optional) 127 获取一个 .gitignore 模板原始文件 128 129 获取一个 .gitignore 模板原始文件 130 131 ### Required Parameters 132 133 Name | Type | Description | Notes 134 ------------- | ------------- | ------------- | ------------- 135 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 136 **name** | **string**| .gitignore 模板名 | 137 **optional** | ***GetV5GitignoreTemplatesNameRawOpts** | optional parameters | nil if no parameters 138 139 ### Optional Parameters 140 Optional parameters are passed through a pointer to a GetV5GitignoreTemplatesNameRawOpts struct 141 142 Name | Type | Description | Notes 143 ------------- | ------------- | ------------- | ------------- 144 145 **accessToken** | **optional.String**| 用户授权码 | 146 147 ### Return type 148 149 (empty response body) 150 151 ### Authorization 152 153 No authorization required 154 155 ### HTTP request headers 156 157 - **Content-Type**: application/json, multipart/form-data 158 - **Accept**: application/json 159 160 [[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) 161 162 # **GetV5Licenses** 163 > GetV5Licenses(ctx, optional) 164 列出可使用的开源许可协议 165 166 列出可使用的开源许可协议 167 168 ### Required Parameters 169 170 Name | Type | Description | Notes 171 ------------- | ------------- | ------------- | ------------- 172 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 173 **optional** | ***GetV5LicensesOpts** | optional parameters | nil if no parameters 174 175 ### Optional Parameters 176 Optional parameters are passed through a pointer to a GetV5LicensesOpts struct 177 178 Name | Type | Description | Notes 179 ------------- | ------------- | ------------- | ------------- 180 **accessToken** | **optional.String**| 用户授权码 | 181 182 ### Return type 183 184 (empty response body) 185 186 ### Authorization 187 188 No authorization required 189 190 ### HTTP request headers 191 192 - **Content-Type**: application/json, multipart/form-data 193 - **Accept**: application/json 194 195 [[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) 196 197 # **GetV5LicensesLicense** 198 > GetV5LicensesLicense(ctx, license, optional) 199 获取一个开源许可协议 200 201 获取一个开源许可协议 202 203 ### Required Parameters 204 205 Name | Type | Description | Notes 206 ------------- | ------------- | ------------- | ------------- 207 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 208 **license** | **string**| 协议名称 | 209 **optional** | ***GetV5LicensesLicenseOpts** | optional parameters | nil if no parameters 210 211 ### Optional Parameters 212 Optional parameters are passed through a pointer to a GetV5LicensesLicenseOpts struct 213 214 Name | Type | Description | Notes 215 ------------- | ------------- | ------------- | ------------- 216 217 **accessToken** | **optional.String**| 用户授权码 | 218 219 ### Return type 220 221 (empty response body) 222 223 ### Authorization 224 225 No authorization required 226 227 ### HTTP request headers 228 229 - **Content-Type**: application/json, multipart/form-data 230 - **Accept**: application/json 231 232 [[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) 233 234 # **GetV5LicensesLicenseRaw** 235 > GetV5LicensesLicenseRaw(ctx, license, optional) 236 获取一个开源许可协议原始文件 237 238 获取一个开源许可协议原始文件 239 240 ### Required Parameters 241 242 Name | Type | Description | Notes 243 ------------- | ------------- | ------------- | ------------- 244 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 245 **license** | **string**| 协议名称 | 246 **optional** | ***GetV5LicensesLicenseRawOpts** | optional parameters | nil if no parameters 247 248 ### Optional Parameters 249 Optional parameters are passed through a pointer to a GetV5LicensesLicenseRawOpts struct 250 251 Name | Type | Description | Notes 252 ------------- | ------------- | ------------- | ------------- 253 254 **accessToken** | **optional.String**| 用户授权码 | 255 256 ### Return type 257 258 (empty response body) 259 260 ### Authorization 261 262 No authorization required 263 264 ### HTTP request headers 265 266 - **Content-Type**: application/json, multipart/form-data 267 - **Accept**: application/json 268 269 [[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) 270 271 # **GetV5ReposOwnerRepoLicense** 272 > GetV5ReposOwnerRepoLicense(ctx, owner, repo, optional) 273 获取一个仓库使用的开源许可协议 274 275 获取一个仓库使用的开源许可协议 276 277 ### Required Parameters 278 279 Name | Type | Description | Notes 280 ------------- | ------------- | ------------- | ------------- 281 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 282 **owner** | **string**| 仓库所属空间地址(企业、组织或个人的地址path) | 283 **repo** | **string**| 仓库路径(path) | 284 **optional** | ***GetV5ReposOwnerRepoLicenseOpts** | optional parameters | nil if no parameters 285 286 ### Optional Parameters 287 Optional parameters are passed through a pointer to a GetV5ReposOwnerRepoLicenseOpts struct 288 289 Name | Type | Description | Notes 290 ------------- | ------------- | ------------- | ------------- 291 292 293 **accessToken** | **optional.String**| 用户授权码 | 294 295 ### Return type 296 297 (empty response body) 298 299 ### Authorization 300 301 No authorization required 302 303 ### HTTP request headers 304 305 - **Content-Type**: application/json, multipart/form-data 306 - **Accept**: application/json 307 308 [[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) 309 310 # **PostV5Markdown** 311 > PostV5Markdown(ctx, text, optional) 312 渲染 Markdown 文本 313 314 渲染 Markdown 文本 315 316 ### Required Parameters 317 318 Name | Type | Description | Notes 319 ------------- | ------------- | ------------- | ------------- 320 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 321 **text** | **string**| Markdown 文本 | 322 **optional** | ***PostV5MarkdownOpts** | optional parameters | nil if no parameters 323 324 ### Optional Parameters 325 Optional parameters are passed through a pointer to a PostV5MarkdownOpts struct 326 327 Name | Type | Description | Notes 328 ------------- | ------------- | ------------- | ------------- 329 330 **accessToken** | **optional.String**| 用户授权码 | 331 332 ### Return type 333 334 (empty response body) 335 336 ### Authorization 337 338 No authorization required 339 340 ### HTTP request headers 341 342 - **Content-Type**: application/json, multipart/form-data 343 - **Accept**: application/json 344 345 [[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) 346