Skip to content

Commit 3810d12

Browse files
theWhiteWulfywing328
authored andcommitted
[#2441] Update documentation mustache templates for proper linting. (#2458)
* [#2441] Update documentation mustache files for PHP client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] Issues with generated markdown files as reported by markdownlint for node.js are: - MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time - MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading - MD007 ul-indent - Unordered list indentation - MD009 no-trailing-spaces - Trailing spaces - MD010 no-hard-tabs - Hard tabs - MD011 no-reversed-links - Reversed link syntax - MD025 single-h1 - Multiple top level headings in the same document - MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines - MD032 blanks-around-lists - Lists should be surrounded by blank lines - MD040 fenced-code-language - Fenced code blocks should have a language specified - MD041 first-line-h1 - First line in file should be a top level heading * [#2441] Update documentation mustache files for ruby client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] Issues with generated markdown files as reported by markdownlint for node.js are: - MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time - MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading - MD007 ul-indent - Unordered list indentation - MD009 no-trailing-spaces - Trailing spaces - MD010 no-hard-tabs - Hard tabs - MD011 no-reversed-links - Reversed link syntax - MD025 single-h1 - Multiple top level headings in the same document - MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines - MD032 blanks-around-lists - Lists should be surrounded by blank lines - MD040 fenced-code-language - Fenced code blocks should have a language specified - MD041 first-line-h1 - First line in file should be a top level heading * [#2441] Update documentation mustache files for javascript client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] Issues with generated markdown files as reported by markdownlint for node.js are: - MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time - MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading - MD007 ul-indent - Unordered list indentation - MD009 no-trailing-spaces - Trailing spaces - MD010 no-hard-tabs - Hard tabs - MD011 no-reversed-links - Reversed link syntax - MD025 single-h1 - Multiple top level headings in the same document - MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines - MD032 blanks-around-lists - Lists should be surrounded by blank lines - MD040 fenced-code-language - Fenced code blocks should have a language specified - MD041 first-line-h1 - First line in file should be a top level heading * [#2441] Update documentation mustache files for Java client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] Issues with generated markdown files as reported by markdownlint for node.js are: - MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time - MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading - MD007 ul-indent - Unordered list indentation - MD009 no-trailing-spaces - Trailing spaces - MD010 no-hard-tabs - Hard tabs - MD011 no-reversed-links - Reversed link syntax - MD025 single-h1 - Multiple top level headings in the same document - MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines - MD032 blanks-around-lists - Lists should be surrounded by blank lines - MD040 fenced-code-language - Fenced code blocks should have a language specified - MD041 first-line-h1 - First line in file should be a top level heading * [#2441] Update documentation mustache files for GO client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] Issues with generated markdown files as reported by markdownlint for node.js are: - MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time - MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading - MD007 ul-indent - Unordered list indentation - MD009 no-trailing-spaces - Trailing spaces - MD010 no-hard-tabs - Hard tabs - MD011 no-reversed-links - Reversed link syntax - MD025 single-h1 - Multiple top level headings in the same document - MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines - MD032 blanks-around-lists - Lists should be surrounded by blank lines - MD040 fenced-code-language - Fenced code blocks should have a language specified - MD041 first-line-h1 - First line in file should be a top level heading * [#2441] Update documentation mustache files for Rust client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] Issues with generated markdown files as reported by markdownlint for node.js are: - MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time - MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading - MD007 ul-indent - Unordered list indentation - MD009 no-trailing-spaces - Trailing spaces - MD010 no-hard-tabs - Hard tabs - MD011 no-reversed-links - Reversed link syntax - MD025 single-h1 - Multiple top level headings in the same document - MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines - MD032 blanks-around-lists - Lists should be surrounded by blank lines - MD040 fenced-code-language - Fenced code blocks should have a language specified - MD041 first-line-h1 - First line in file should be a top level heading * [#2441] Update documentation mustache files for C# client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] Issues with generated markdown files as reported by markdownlint for node.js are: - MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time - MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading - MD007 ul-indent - Unordered list indentation - MD009 no-trailing-spaces - Trailing spaces - MD010 no-hard-tabs - Hard tabs - MD011 no-reversed-links - Reversed link syntax - MD025 single-h1 - Multiple top level headings in the same document - MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines - MD032 blanks-around-lists - Lists should be surrounded by blank lines - MD040 fenced-code-language - Fenced code blocks should have a language specified - MD041 first-line-h1 - First line in file should be a top level heading * [#2441] Update documentation mustache files for Android client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] Issues with generated markdown files as reported by markdownlint for node.js are: - MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time - MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading - MD007 ul-indent - Unordered list indentation - MD009 no-trailing-spaces - Trailing spaces - MD010 no-hard-tabs - Hard tabs - MD011 no-reversed-links - Reversed link syntax - MD025 single-h1 - Multiple top level headings in the same document - MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines - MD032 blanks-around-lists - Lists should be surrounded by blank lines - MD040 fenced-code-language - Fenced code blocks should have a language specified - MD041 first-line-h1 - First line in file should be a top level heading * Update README.mustache * [#2441] Update documentation mustache files for Ada client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] * [#2441] Update documentation mustache files for Apex client This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441] * [#2441] Update documentation mustache files for bash This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[#2441]
1 parent c918d7a commit 3810d12

37 files changed

+314
-155
lines changed

modules/openapi-generator/src/main/resources/Ada/README.mustache

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,14 @@ the [Swagger Ada library](https://github.com/stcarrez/swagger-ada).
1414
When the GNAT Ada compiler and Swagger Ada libraries are installed,
1515
run the following command:
1616

17-
```
17+
```shell
1818
gprbuild -p -P{{projectName}}
1919
```
2020

2121
After the build is successful, you will get the server binary
2222
in bin/{{packageName}}-server and you can start it as follows:
23-
```
23+
24+
```shell
2425
./bin/{{packageName}}-server
2526
```
2627

@@ -51,8 +52,8 @@ The server instance is represented by the **{{package}}.Servers.Server_Type** Ad
5152
The REST API will need an instance of it to make the operation call. Two server model
5253
exists:
5354

54-
* The instance per request model creates an instance of the server type for each request.
55-
* The shared instance model shares the same instance across all concurrent REST requests. This instance is protected using an Ada protected object which holds the server instance.
55+
- The instance per request model creates an instance of the server type for each request.
56+
- The shared instance model shares the same instance across all concurrent REST requests. This instance is protected using an Ada protected object which holds the server instance.
5657

5758
The choice of the server model is made at the compilation time by instantiating either
5859
the **{{package}}.Skeletons.Skeleton** package or the **{{package}}.Skeletons.Shared_Instance**
@@ -65,9 +66,9 @@ All you have to do is implement the server operation in the **src/{{packageName}
6566
The package already contains the operation with its parameters and you only have to replace
6667
the **null** instruction by real code.
6768

68-
# Documentation
69+
## Documentation
6970

70-
## API Documentation
71+
### API Documentation
7172

7273
All URIs are relative to *{{basePath}}*
7374

@@ -76,22 +77,30 @@ Method | HTTP request | Description
7677
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}[**{{nickname}}**]({{apiDocPath}}{{classname}}.md#{{nickname}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
7778
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
7879

79-
## Models
80+
### Models
81+
8082
{{#models}}{{#model}} - [{{package}}.Models.{{classname}}]({{modelDocPath}}{{classname}}.md)
8183
{{/model}}{{/models}}
8284

83-
## Authorization
85+
### Authorization
86+
8487
{{^authMethods}} All endpoints do not require authorization.
8588
{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
8689
{{#authMethods}}## {{{name}}}
8790

88-
{{#isApiKey}}- **Type**: API key
91+
{{#isApiKey}}
92+
93+
- **Type**: API key
8994
- **API key parameter name**: {{{keyParamName}}}
9095
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
9196
{{/isApiKey}}
92-
{{#isBasic}}- **Type**: HTTP basic authentication
97+
{{#isBasic}}
98+
99+
- **Type**: HTTP basic authentication
93100
{{/isBasic}}
94-
{{#isOAuth}}- **Type**: OAuth
101+
{{#isOAuth}}
102+
103+
- **Type**: OAuth
95104
- **Flow**: {{{flow}}}
96105
- **Authorization URL**: {{{authorizationUrl}}}
97106
- **Scopes**: {{^scopes}}N/A{{/scopes}}

modules/openapi-generator/src/main/resources/Java/README.mustache

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# {{artifactId}}
22

33
{{appName}}
4+
45
- API version: {{appVersion}}
56
{{^hideGenerationTimestamp}}
6-
- Build date: {{generatedDate}}
7+
8+
- Build date: {{generatedDate}}
79
{{/hideGenerationTimestamp}}
810

911
{{#appDescription}}{{{appDescription}}}{{/appDescription}}
@@ -14,10 +16,10 @@
1416

1517
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
1618

17-
1819
## Requirements
1920

2021
Building the API client library requires:
22+
2123
1. Java {{#supportJava6}}1.6{{/supportJava6}}{{^supportJava6}}{{#java8}}1.8{{/java8}}{{^java8}}1.7{{/java8}}{{/supportJava6}}+
2224
2. Maven/Gradle
2325

@@ -68,8 +70,8 @@ mvn clean package
6870

6971
Then manually install the following JARs:
7072

71-
* `target/{{{artifactId}}}-{{{artifactVersion}}}.jar`
72-
* `target/lib/*.jar`
73+
- `target/{{{artifactId}}}-{{{artifactVersion}}}.jar`
74+
- `target/lib/*.jar`
7375

7476
## Getting Started
7577

@@ -141,13 +143,19 @@ Class | Method | HTTP request | Description
141143
{{/authMethods}}Authentication schemes defined for the API:
142144
{{#authMethods}}### {{name}}
143145

144-
{{#isApiKey}}- **Type**: API key
146+
{{#isApiKey}}
147+
148+
- **Type**: API key
145149
- **API key parameter name**: {{keyParamName}}
146150
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
147151
{{/isApiKey}}
148-
{{#isBasic}}- **Type**: HTTP basic authentication
152+
{{#isBasic}}
153+
154+
- **Type**: HTTP basic authentication
149155
{{/isBasic}}
150-
{{#isOAuth}}- **Type**: OAuth
156+
{{#isOAuth}}
157+
158+
- **Type**: OAuth
151159
- **Flow**: {{flow}}
152160
- **Authorization URL**: {{authorizationUrl}}
153161
- **Scopes**: {{^scopes}}N/A{{/scopes}}

modules/openapi-generator/src/main/resources/Java/api_doc.mustache

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# {{classname}}{{#description}}
2+
23
{{description}}{{/description}}
34

45
All URIs are relative to *{{basePath}}*
@@ -10,15 +11,17 @@ Method | HTTP request | Description
1011

1112
{{#operations}}
1213
{{#operation}}
13-
<a name="{{operationId}}"></a>
14-
# **{{operationId}}**
14+
15+
## {{operationId}}
16+
1517
> {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{#hasMore}}, {{/hasMore}}{{/allParams}})
1618

1719
{{summary}}{{#notes}}
1820

1921
{{notes}}{{/notes}}
2022

2123
### Example
24+
2225
```java
2326
// Import classes:{{#hasAuthMethods}}
2427
//import {{{invokerPackage}}}.ApiClient;{{/hasAuthMethods}}
@@ -59,6 +62,7 @@ try {
5962
```
6063

6164
### Parameters
65+
6266
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
6367
Name | Type | Description | Notes
6468
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
@@ -75,8 +79,8 @@ Name | Type | Description | Notes
7579

7680
### HTTP request headers
7781

78-
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
79-
- **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}
82+
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
83+
- **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}
8084

8185
{{/operation}}
8286
{{/operations}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{{#models}}{{#model}}
2+
23
{{#isEnum}}{{>enum_outer_doc}}{{/isEnum}}{{^isEnum}}{{>pojo_doc}}{{/isEnum}}
34
{{/model}}{{/models}}

modules/openapi-generator/src/main/resources/Java/pojo_doc.mustache

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# {{classname}}
22

33
## Properties
4+
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------
67
{{#vars}}**{{name}}** | {{#isEnum}}[**{{datatypeWithEnum}}**](#{{datatypeWithEnum}}){{/isEnum}}{{^isEnum}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}}{{/isEnum}} | {{description}} | {{^required}} [optional]{{/required}}{{#readOnly}} [readonly]{{/readOnly}}
78
{{/vars}}
89
{{#vars}}{{#isEnum}}
910

10-
<a name="{{{datatypeWithEnum}}}"></a>
11+
1112
## Enum: {{datatypeWithEnum}}
13+
1214
Name | Value
1315
---- | -----{{#allowableValues}}{{#enumVars}}
1416
{{name}} | {{value}}{{/enumVars}}{{/allowableValues}}

modules/openapi-generator/src/main/resources/Javascript/README.mustache

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
2222

2323
#### npm
2424

25-
To publish the library as a [npm](https://www.npmjs.com/),
26-
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
25+
To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
2726

2827
Then install it via:
2928

@@ -33,8 +32,7 @@ npm install {{{projectName}}} --save
3332

3433
##### Local development
3534

36-
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
37-
into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
35+
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
3836

3937
```shell
4038
npm install
@@ -52,13 +50,11 @@ Finally, switch to the directory you want to use your {{{projectName}}} from, an
5250
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
5351
```
5452

55-
You should now be able to `require('{{{projectName}}}')` in javascript files from the directory you ran the last
56-
command above from.
53+
You should now be able to `require('{{{projectName}}}')` in javascript files from the directory you ran the last command above from.
5754

58-
#### git
59-
#
60-
If the library is hosted at a git repository, e.g.
61-
https://github.com/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}{{projectName}}{{/gitRepoId}}
55+
### git
56+
57+
If the library is hosted at a git repository, e.g. https://github.com/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}{{projectName}}{{/gitRepoId}}
6258
then install it via:
6359

6460
```shell
@@ -67,10 +63,7 @@ then install it via:
6763

6864
### For browser
6965

70-
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
71-
the above steps with Node.js and installing browserify with `npm install -g browserify`,
72-
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually
73-
use this library):
66+
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually use this library):
7467

7568
```shell
7669
browserify main.js > bundle.js
@@ -189,21 +182,28 @@ All endpoints do not require authorization.
189182
{{/authMethods}}
190183
{{#authMethods}}
191184
{{#last}} Authentication schemes defined for the API:{{/last}}
185+
192186
### {{name}}
193187

194-
{{#isApiKey}}- **Type**: API key
188+
{{#isApiKey}}
189+
190+
- **Type**: API key
195191
- **API key parameter name**: {{keyParamName}}
196192
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
197193
{{/isApiKey}}
198194
{{#isBasic}}
199195
{{^isBasicBearer}}
196+
200197
- **Type**: HTTP basic authentication
201198
{{/isBasicBearer}}
202199
{{#isBasicBearer}}
200+
203201
- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
204202
{{/isBasicBearer}}
205203
{{/isBasic}}
206-
{{#isOAuth}}- **Type**: OAuth
204+
{{#isOAuth}}
205+
206+
- **Type**: OAuth
207207
- **Flow**: {{flow}}
208208
- **Authorization URL**: {{authorizationUrl}}
209209
- **Scopes**: {{^scopes}}N/A{{/scopes}}

modules/openapi-generator/src/main/resources/Javascript/api_doc.mustache

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# {{moduleName}}.{{classname}}{{#description}}
2+
23
{{description}}{{/description}}
34

45
All URIs are relative to *{{basePath}}*
@@ -10,15 +11,17 @@ Method | HTTP request | Description
1011

1112
{{#operations}}
1213
{{#operation}}
13-
<a name="{{operationId}}"></a>
14-
# **{{operationId}}**
14+
15+
## {{operationId}}
16+
1517
> {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-last}}{{#hasRequiredParams}}, {{/hasRequiredParams}}opts{{/-last}}{{/optionalParams}})
1618

1719
{{summary}}{{#notes}}
1820

1921
{{notes}}{{/notes}}
2022

2123
### Example
24+
2225
```javascript
2326
var {{{moduleName}}} = require('{{{projectName}}}');
2427
{{#hasAuthMethods}}
@@ -86,7 +89,9 @@ apiInstance.{{{operationId}}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-
8689
```
8790

8891
### Parameters
92+
8993
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
94+
9095
Name | Type | Description | Notes
9196
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
9297
{{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}
@@ -102,8 +107,8 @@ Name | Type | Description | Notes
102107

103108
### HTTP request headers
104109

105-
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
106-
- **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}
110+
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
111+
- **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}
107112

108113
{{/operation}}
109114
{{/operations}}

modules/openapi-generator/src/main/resources/Javascript/es6/README.mustache

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
2222

2323
#### npm
2424

25-
To publish the library as a [npm](https://www.npmjs.com/),
26-
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
25+
To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
2726

2827
Then install it via:
2928

@@ -32,9 +31,8 @@ npm install {{{projectName}}} --save
3231
```
3332

3433
#### git
35-
#
36-
If the library is hosted at a git repository, e.g.
37-
https://github.com/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}{{projectName}}{{/gitRepoId}}
34+
35+
If the library is hosted at a git repository, e.g.https://github.com/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}{{projectName}}{{/gitRepoId}}
3836
then install it via:
3937

4038
```shell
@@ -166,9 +164,11 @@ All endpoints do not require authorization.
166164
{{/authMethods}}
167165
{{#authMethods}}
168166
{{#last}} Authentication schemes defined for the API:{{/last}}
167+
169168
### {{name}}
170169

171170
{{#isApiKey}}
171+
172172
- **Type**: API key
173173
- **API key parameter name**: {{keyParamName}}
174174
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
@@ -181,7 +181,9 @@ All endpoints do not require authorization.
181181
- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
182182
{{/isBasicBearer}}
183183
{{/isBasic}}
184-
{{#isOAuth}}- **Type**: OAuth
184+
{{#isOAuth}}
185+
186+
- **Type**: OAuth
185187
- **Flow**: {{flow}}
186188
- **Authorization URL**: {{authorizationUrl}}
187189
- **Scopes**: {{^scopes}}N/A{{/scopes}}

0 commit comments

Comments
 (0)