github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/go/api_doc.mustache (about) 1 # {{invokerPackage}}\{{classname}}{{#description}} 2 3 {{description}}{{/description}} 4 5 All URIs are relative to *{{basePath}}* 6 7 Method | HTTP request | Description 8 ------------- | ------------- | ------------- 9 {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} 10 {{/operation}}{{/operations}} 11 12 {{#operations}} 13 {{#operation}} 14 15 ## {{{operationId}}} 16 17 > {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}(ctx, {{#allParams}}{{#required}}{{paramName}}{{^-last}}, {{/-last}}{{/required}}{{/allParams}}{{#hasOptionalParams}}optional{{/hasOptionalParams}}) 18 19 {{{summary}}}{{#notes}} 20 21 {{{notes}}}{{/notes}} 22 23 ### Required Parameters 24 25 {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} 26 Name | Type | Description | Notes 27 ------------- | ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.{{/-last}}{{/allParams}}{{#allParams}}{{#required}} 29 **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}{{/required}}{{/allParams}}{{#hasOptionalParams}} 30 **optional** | ***{{{nickname}}}Opts** | optional parameters | nil if no parameters 31 32 ### Optional Parameters 33 34 Optional parameters are passed through a pointer to a {{{nickname}}}Opts struct 35 {{#allParams}}{{#-last}} 36 37 Name | Type | Description | Notes 38 ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}{{#allParams}} 39 {{^required}} **{{paramName}}** | {{#isFile}}**optional.Interface of {{dataType}}**{{/isFile}}{{#isPrimitiveType}}**optional.{{#lambda.titlecase}}{{dataType}}{{/lambda.titlecase}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**optional.Interface of {{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}{{/required}}{{/allParams}}{{/hasOptionalParams}} 40 41 ### Return type 42 43 {{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}} (empty response body){{/returnType}} 44 45 ### Authorization 46 47 {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} 48 49 ### HTTP request headers 50 51 - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} 52 - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} 53 54 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 55 [[Back to Model list]](../README.md#documentation-for-models) 56 [[Back to README]](../README.md) 57 58 {{/operation}} 59 {{/operations}}