From ef5dc1c8a0467abeba63c29a43c2ba24ed5eb503 Mon Sep 17 00:00:00 2001 From: Tiffany Marrel Date: Wed, 10 May 2023 08:10:35 +0200 Subject: [PATCH] [Julia] Cleanup README docs (#15295) * [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 --- .../src/main/resources/julia-client/README.mustache | 8 +++++--- samples/client/petstore/julia/README.md | 8 ++++++-- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/julia-client/README.mustache b/modules/openapi-generator/src/main/resources/julia-client/README.mustache index 599c87c2304..b14d062b2f8 100644 --- a/modules/openapi-generator/src/main/resources/julia-client/README.mustache +++ b/modules/openapi-generator/src/main/resources/julia-client/README.mustache @@ -36,11 +36,13 @@ Class | Method {{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md) {{/model}}{{/models}} + ## Authorization -{{^authMethods}} Endpoints do not require authorization. -{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}} +{{^authMethods}}Endpoints do not require authorization.{{/authMethods}} +{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}} {{#authMethods}} -## {{{name}}} + +### {{{name}}} {{#isApiKey}}- **Type**: API key Example diff --git a/samples/client/petstore/julia/README.md b/samples/client/petstore/julia/README.md index 4032ba97fc3..f596feac9b8 100644 --- a/samples/client/petstore/julia/README.md +++ b/samples/client/petstore/julia/README.md @@ -52,9 +52,12 @@ Class | Method - [User](docs/User.md) + ## Authorization -## petstore_auth +Authentication schemes defined for the API: + +### petstore_auth - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog @@ -72,7 +75,8 @@ Example api = MyApi(client) result = callApi(api, args...; api_key) ``` -## api_key + +### api_key - **Type**: API key Example