Skip to content

Commit c9d7550

Browse files
authored
docs(go): API documentation fixes (#853)
1 parent bcd12c8 commit c9d7550

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

openapi-generator/go_lang.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ gitRepoId: phrase-go
88
httpUserAgent: Phrase Strings go
99
templateDir: openapi-generator/templates/go
1010
apiNameSuffix: Api
11+
invokerPackage: phrase

openapi-generator/templates/go/api_doc.mustache

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# {{invokerPackage}}\{{classname}}{{#description}}
1+
# {{invokerPackage}}.{{classname}}{{#description}}
22

33
{{description}}{{/description}}
44

@@ -35,8 +35,8 @@ Optional parameters are passed through a pointer to a {{{nickname}}}Opts struct
3535
{{#allParams}}{{#-last}}
3636

3737
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}}
38+
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}{{#allParams}}{{^required}}
39+
**{{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}}
4040

4141
### Return type
4242

0 commit comments

Comments
 (0)