loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

cleanup new generator documentation (#15359)

Browse Source 
* align wording across generators

* add missing authentication schemes from README of new generators

* fix anchor links in new generator documentation
This commit is contained in:
Tiffany Marrel 2023-06-01 05:17:11 +02:00 committed by GitHub
parent c2f635a330
commit e593591401
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/new-generator.md
View File

@ -187,7 +187,7 @@ The `new.sh` created our three required files. Let's start filling out each of t
# Documentation for {{appName}} # Documentation for {{appName}}
{{#generateApiDocs}} {{#generateApiDocs}}
<a name="documentation-for-api-endpoints"></a> <a id="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints ## Documentation for API Endpoints
All URIs are relative to *{{{basePath}}}* All URIs are relative to *{{{basePath}}}*
@ -199,7 +199,7 @@ Class | Method | HTTP request | Description
{{/generateApiDocs}} {{/generateApiDocs}}
{{#generateModelDocs}} {{#generateModelDocs}}
<a name="documentation-for-models"></a> <a id="documentation-for-models"></a>
## Documentation for Models ## Documentation for Models
{{#modelPackage}} {{#modelPackage}}
@ -211,19 +211,13 @@ No model defined in this package
{{/modelPackage}} {{/modelPackage}}
{{/generateModelDocs}} {{/generateModelDocs}}
<a name="documentation-for-authorization"></a>{{! TODO: optional documentation for authorization? }} <a id="documentation-for-authorization"></a>{{! TODO: optional documentation for authorization? }}
## Documentation for Authorization ## Documentation for Authorization
{{^authMethods}} {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
All endpoints do not require authorization. {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{/authMethods}}
{{#authMethods}} {{#authMethods}}
{{#last}} <a id="{{name}}"></a>
Authentication schemes defined for the API:
{{/last}}
{{/authMethods}}
{{#authMethods}}
<a name="{{name}}"></a>
### {{name}} ### {{name}}
{{#isApiKey}}- **Type**: API key {{#isApiKey}}- **Type**: API key
@ -270,7 +264,7 @@ Method | HTTP request | Description
{{#operations}} {{#operations}}
{{#operation}} {{#operation}}
<a name="{{operationId}}"></a> <a id="{{operationId}}"></a>
# **{{operationId}}** # **{{operationId}}**
> {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}}) > {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}})