Skip to content

Commit

Permalink
fix(go): method in the doc (#3250)
Browse files Browse the repository at this point in the history
  • Loading branch information
Fluf22 authored Jun 25, 2024
1 parent 43ba867 commit b7ce7c8
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion templates/go/api.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,33 @@ func (r {{#structPrefix}}{{&classname}}{{/structPrefix}}{{^structPrefix}}Api{{/s
{{/hasParams}}
/*
{{operationId}} calls the API and returns the raw response from it.
{{> operation_description}}
{{#notes}}

{{{unescapedNotes}}}
{{/notes}}
{{#vendorExtensions}}
{{#x-acl.0}}

Required API Key ACLs:{{/x-acl.0}}
{{#x-acl}}
- {{.}}
{{/x-acl}}
{{/vendorExtensions}}

Request can be constructed by NewApi{{operationId}}Request with parameters below.
@param ctx context.Context - Context of the request
{{#allParams}}
@param {{paramName}} {{dataType}}{{#description}} - {{{.}}}{{/description}}
{{/allParams}}
@param opts ...Option - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails
{{#isDeprecated}}

Deprecated
{{/isDeprecated}}
*/
func (c *APIClient) {{nickname}}WithHTTPInfo(ctx context.Context, {{#hasParams}}r {{#structPrefix}}{{&classname}}{{/structPrefix}}{{^structPrefix}}Api{{/structPrefix}}{{operationId}}Request,{{/hasParams}} opts ...Option) (*http.Response, []byte, error) {
var (
postBody any
Expand Down

1 comment on commit b7ce7c8

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.