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

[Julia] Cleanup README docs (#15295)

Browse Source 
* [Julia] fix documentation of API authorization in README files

fix hierarchy level + add internal links + align wording across generators

* [Julia] fix anchor links in documentation
This commit is contained in:
Tiffany Marrel 2023-05-10 08:10:35 +02:00 committed by GitHub
parent b4d2c14f12
commit ef5dc1c8a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
modules/openapi-generator/src/main/resources/julia-client/README.mustache vendored
View File

@ -36,11 +36,13 @@ Class | Method
{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md) {{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md)
{{/model}}{{/models}} {{/model}}{{/models}}
<a id="authorization"></a>
## Authorization ## Authorization
{{^authMethods}} Endpoints do not require authorization. {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}} {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{#authMethods}} {{#authMethods}}
## {{{name}}} <a id="{{name}}"></a>
### {{{name}}}
{{#isApiKey}}- **Type**: API key {{#isApiKey}}- **Type**: API key
Example Example

8
samples/client/petstore/julia/README.md
View File

@ -52,9 +52,12 @@ Class | Method
- [User](docs/User.md) - [User](docs/User.md)
<a id="authorization"></a>
## Authorization ## Authorization
## petstore_auth Authentication schemes defined for the API:
<a id="petstore_auth"></a>
### petstore_auth
- **Type**: OAuth - **Type**: OAuth
- **Flow**: implicit - **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
@ -72,7 +75,8 @@ Example
api = MyApi(client) api = MyApi(client)
result = callApi(api, args...; api_key) result = callApi(api, args...; api_key)
``` ```
## api_key <a id="api_key"></a>
### api_key
- **Type**: API key - **Type**: API key
Example Example