From 22268470fa4b1f730df0e6ed4e814de837e7a6ed Mon Sep 17 00:00:00 2001 From: Tiffany Marrel Date: Fri, 21 Apr 2023 09:26:50 +0200 Subject: [PATCH] [Java] fix documentation of API authorization in README files fix hierarchy level + add internal links + align wording across generators --- .../src/main/resources/Java/README.mustache | 9 ++++++--- .../Java/libraries/apache-httpclient/README.mustache | 9 ++++++--- .../main/resources/Java/libraries/native/README.mustache | 9 ++++++--- .../resources/Java/libraries/okhttp-gson/README.mustache | 9 ++++++--- samples/client/echo_api/java/apache-httpclient/README.md | 5 +++-- samples/client/echo_api/java/native/README.md | 5 +++-- samples/client/echo_api/java/okhttp-gson/README.md | 5 +++-- .../client/others/java/okhttp-gson-streaming/README.md | 5 +++-- samples/client/petstore/java/apache-httpclient/README.md | 8 ++++++++ samples/client/petstore/java/google-api-client/README.md | 6 ++++++ samples/client/petstore/java/jersey1/README.md | 6 ++++++ .../petstore/java/jersey2-java8-localdatetime/README.md | 6 ++++++ samples/client/petstore/java/jersey2-java8/README.md | 6 ++++++ samples/client/petstore/java/jersey3/README.md | 8 ++++++++ samples/client/petstore/java/native-async/README.md | 8 ++++++++ samples/client/petstore/java/native-jakarta/README.md | 4 ++++ samples/client/petstore/java/native/README.md | 8 ++++++++ .../petstore/java/okhttp-gson-awsv4signature/README.md | 4 ++++ .../java/okhttp-gson-dynamicOperations/README.md | 6 ++++++ .../petstore/java/okhttp-gson-group-parameter/README.md | 4 ++++ .../petstore/java/okhttp-gson-parcelableModel/README.md | 6 ++++++ .../client/petstore/java/okhttp-gson-swagger1/README.md | 4 ++++ samples/client/petstore/java/okhttp-gson/README.md | 8 ++++++++ samples/client/petstore/java/resteasy/README.md | 6 ++++++ .../client/petstore/java/resttemplate-jakarta/README.md | 4 ++++ .../client/petstore/java/resttemplate-swagger1/README.md | 4 ++++ .../client/petstore/java/resttemplate-withXml/README.md | 6 ++++++ samples/client/petstore/java/resttemplate/README.md | 6 ++++++ samples/client/petstore/java/vertx-no-nullable/README.md | 6 ++++++ samples/client/petstore/java/vertx/README.md | 6 ++++++ samples/client/petstore/java/webclient-jakarta/README.md | 8 ++++++++ .../petstore/java/webclient-nullable-arrays/README.md | 5 +++-- samples/client/petstore/java/webclient/README.md | 8 ++++++++ .../x-auth-id-alias/java/jersey2-java8/README.md | 4 ++++ .../java/jersey2-java8-special-characters/README.md | 5 +++-- .../petstore/java/jersey2-java8-swagger1/README.md | 4 ++++ .../client/petstore/java/jersey2-java8/README.md | 8 ++++++++ 37 files changed, 204 insertions(+), 24 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/Java/README.mustache b/modules/openapi-generator/src/main/resources/Java/README.mustache index c08caee14c30..05e9f3c7e498 100644 --- a/modules/openapi-generator/src/main/resources/Java/README.mustache +++ b/modules/openapi-generator/src/main/resources/Java/README.mustache @@ -197,11 +197,14 @@ Class | Method | HTTP request | Description {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md) {{/model}}{{/models}} + ## Documentation for Authorization -{{^authMethods}}All endpoints do not require authorization. -{{/authMethods}}Authentication schemes defined for the API: -{{#authMethods}}### {{name}} +{{^authMethods}}Endpoints do not require authorization.{{/authMethods}} +{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}} +{{#authMethods}} + +### {{name}} {{#isApiKey}} diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/apache-httpclient/README.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/apache-httpclient/README.mustache index c6ae4fa23617..b7b058e8a3c3 100644 --- a/modules/openapi-generator/src/main/resources/Java/libraries/apache-httpclient/README.mustache +++ b/modules/openapi-generator/src/main/resources/Java/libraries/apache-httpclient/README.mustache @@ -158,11 +158,14 @@ Class | Method | HTTP request | Description {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md) {{/model}}{{/models}} + ## Documentation for Authorization -{{^authMethods}}All endpoints do not require authorization. -{{/authMethods}}Authentication schemes defined for the API: -{{#authMethods}}### {{name}} +{{^authMethods}}Endpoints do not require authorization.{{/authMethods}} +{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}} +{{#authMethods}} + +### {{name}} {{#isApiKey}} diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/native/README.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/native/README.mustache index ef15f379a13c..235f854ec07f 100644 --- a/modules/openapi-generator/src/main/resources/Java/libraries/native/README.mustache +++ b/modules/openapi-generator/src/main/resources/Java/libraries/native/README.mustache @@ -139,11 +139,14 @@ Class | Method | HTTP request | Description {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md) {{/model}}{{/models}} + ## Documentation for Authorization -{{^authMethods}}All endpoints do not require authorization. -{{/authMethods}}Authentication schemes defined for the API: -{{#authMethods}}### {{name}} +{{^authMethods}}Endpoints do not require authorization.{{/authMethods}} +{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}} +{{#authMethods}} + +### {{name}} {{#isApiKey}} diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/README.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/README.mustache index 40f8a61cacbf..e2cb404c4b63 100644 --- a/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/README.mustache +++ b/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/README.mustache @@ -155,11 +155,14 @@ Class | Method | HTTP request | Description {{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md) {{/model}}{{/models}} + ## Documentation for Authorization -{{^authMethods}}All endpoints do not require authorization. -{{/authMethods}}Authentication schemes defined for the API: -{{#authMethods}}### {{name}} +{{^authMethods}}Endpoints do not require authorization.{{/authMethods}} +{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}} +{{#authMethods}} + +### {{name}} {{#isApiKey}}- **Type**: API key - **API key parameter name**: {{keyParamName}} diff --git a/samples/client/echo_api/java/apache-httpclient/README.md b/samples/client/echo_api/java/apache-httpclient/README.md index 28b76ab904c9..64a56b0caa28 100644 --- a/samples/client/echo_api/java/apache-httpclient/README.md +++ b/samples/client/echo_api/java/apache-httpclient/README.md @@ -140,10 +140,11 @@ Class | Method | HTTP request | Description - [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md) + ## Documentation for Authorization -All endpoints do not require authorization. -Authentication schemes defined for the API: +Endpoints do not require authorization. + ## Recommendation diff --git a/samples/client/echo_api/java/native/README.md b/samples/client/echo_api/java/native/README.md index fac47b3cb49e..addeaf9a7c42 100644 --- a/samples/client/echo_api/java/native/README.md +++ b/samples/client/echo_api/java/native/README.md @@ -156,10 +156,11 @@ Class | Method | HTTP request | Description - [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md) + ## Documentation for Authorization -All endpoints do not require authorization. -Authentication schemes defined for the API: +Endpoints do not require authorization. + ## Recommendation diff --git a/samples/client/echo_api/java/okhttp-gson/README.md b/samples/client/echo_api/java/okhttp-gson/README.md index 1bfba649e4cc..bd82cc3ac271 100644 --- a/samples/client/echo_api/java/okhttp-gson/README.md +++ b/samples/client/echo_api/java/okhttp-gson/README.md @@ -147,10 +147,11 @@ Class | Method | HTTP request | Description - [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md) + ## Documentation for Authorization -All endpoints do not require authorization. -Authentication schemes defined for the API: +Endpoints do not require authorization. + ## Recommendation diff --git a/samples/client/others/java/okhttp-gson-streaming/README.md b/samples/client/others/java/okhttp-gson-streaming/README.md index 3d7eefeba9f2..a75c377f27f1 100644 --- a/samples/client/others/java/okhttp-gson-streaming/README.md +++ b/samples/client/others/java/okhttp-gson-streaming/README.md @@ -127,10 +127,11 @@ Class | Method | HTTP request | Description - [SomeObj](docs/SomeObj.md) + ## Documentation for Authorization -All endpoints do not require authorization. -Authentication schemes defined for the API: +Endpoints do not require authorization. + ## Recommendation diff --git a/samples/client/petstore/java/apache-httpclient/README.md b/samples/client/petstore/java/apache-httpclient/README.md index 45ace68ceee4..e12c5c334773 100644 --- a/samples/client/petstore/java/apache-httpclient/README.md +++ b/samples/client/petstore/java/apache-httpclient/README.md @@ -201,9 +201,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -214,6 +217,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -221,6 +225,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -228,16 +233,19 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### bearer_test - **Type**: HTTP basic authentication + ### http_signature_test diff --git a/samples/client/petstore/java/google-api-client/README.md b/samples/client/petstore/java/google-api-client/README.md index 0b08bf579e73..b1de467248ea 100644 --- a/samples/client/petstore/java/google-api-client/README.md +++ b/samples/client/petstore/java/google-api-client/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -217,6 +220,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -224,6 +228,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -231,6 +236,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/jersey1/README.md b/samples/client/petstore/java/jersey1/README.md index f137bef7607a..c07ca14a71f1 100644 --- a/samples/client/petstore/java/jersey1/README.md +++ b/samples/client/petstore/java/jersey1/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -217,6 +220,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -224,6 +228,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -231,6 +236,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/jersey2-java8-localdatetime/README.md b/samples/client/petstore/java/jersey2-java8-localdatetime/README.md index 65c2604a2a84..56e2094675f0 100644 --- a/samples/client/petstore/java/jersey2-java8-localdatetime/README.md +++ b/samples/client/petstore/java/jersey2-java8-localdatetime/README.md @@ -229,9 +229,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -242,6 +245,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -249,6 +253,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -256,6 +261,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/jersey2-java8/README.md b/samples/client/petstore/java/jersey2-java8/README.md index c2b1bfa34dd4..d8b2542b4403 100644 --- a/samples/client/petstore/java/jersey2-java8/README.md +++ b/samples/client/petstore/java/jersey2-java8/README.md @@ -229,9 +229,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -242,6 +245,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -249,6 +253,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -256,6 +261,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/jersey3/README.md b/samples/client/petstore/java/jersey3/README.md index dd55b36a2acf..43348534909d 100644 --- a/samples/client/petstore/java/jersey3/README.md +++ b/samples/client/petstore/java/jersey3/README.md @@ -234,9 +234,12 @@ Class | Method | HTTP request | Description - [Zebra](docs/Zebra.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -247,6 +250,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -254,6 +258,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -261,16 +266,19 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### bearer_test - **Type**: HTTP basic authentication + ### http_signature_test diff --git a/samples/client/petstore/java/native-async/README.md b/samples/client/petstore/java/native-async/README.md index cf4e76b2e591..2023aae15a40 100644 --- a/samples/client/petstore/java/native-async/README.md +++ b/samples/client/petstore/java/native-async/README.md @@ -266,9 +266,12 @@ Class | Method | HTTP request | Description - [Zebra](docs/Zebra.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -279,6 +282,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -286,6 +290,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -293,16 +298,19 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### bearer_test - **Type**: HTTP basic authentication + ### http_signature_test diff --git a/samples/client/petstore/java/native-jakarta/README.md b/samples/client/petstore/java/native-jakarta/README.md index 7f5e0c87672d..6e8c5c8af973 100644 --- a/samples/client/petstore/java/native-jakarta/README.md +++ b/samples/client/petstore/java/native-jakarta/README.md @@ -157,9 +157,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -170,6 +173,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key diff --git a/samples/client/petstore/java/native/README.md b/samples/client/petstore/java/native/README.md index 9bb58bc15eb6..6b9f0271d115 100644 --- a/samples/client/petstore/java/native/README.md +++ b/samples/client/petstore/java/native/README.md @@ -265,9 +265,12 @@ Class | Method | HTTP request | Description - [Zebra](docs/Zebra.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -278,6 +281,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -285,6 +289,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -292,16 +297,19 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### bearer_test - **Type**: HTTP basic authentication + ### http_signature_test diff --git a/samples/client/petstore/java/okhttp-gson-awsv4signature/README.md b/samples/client/petstore/java/okhttp-gson-awsv4signature/README.md index ebbaac626f4b..14dbf28ab6b8 100644 --- a/samples/client/petstore/java/okhttp-gson-awsv4signature/README.md +++ b/samples/client/petstore/java/okhttp-gson-awsv4signature/README.md @@ -152,9 +152,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth - **Type**: OAuth @@ -164,6 +167,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key - **Type**: API key diff --git a/samples/client/petstore/java/okhttp-gson-dynamicOperations/README.md b/samples/client/petstore/java/okhttp-gson-dynamicOperations/README.md index 8fb7ff731901..1e4fad2050f6 100644 --- a/samples/client/petstore/java/okhttp-gson-dynamicOperations/README.md +++ b/samples/client/petstore/java/okhttp-gson-dynamicOperations/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth - **Type**: OAuth @@ -216,18 +219,21 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication diff --git a/samples/client/petstore/java/okhttp-gson-group-parameter/README.md b/samples/client/petstore/java/okhttp-gson-group-parameter/README.md index c85dbe0a807b..7a11923a40b1 100644 --- a/samples/client/petstore/java/okhttp-gson-group-parameter/README.md +++ b/samples/client/petstore/java/okhttp-gson-group-parameter/README.md @@ -139,9 +139,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth - **Type**: OAuth @@ -151,6 +154,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key - **Type**: API key diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/README.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/README.md index bea3268deeac..66eb96471c18 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/README.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth - **Type**: OAuth @@ -216,18 +219,21 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication diff --git a/samples/client/petstore/java/okhttp-gson-swagger1/README.md b/samples/client/petstore/java/okhttp-gson-swagger1/README.md index b51dc4c0b2f1..bc572b68542a 100644 --- a/samples/client/petstore/java/okhttp-gson-swagger1/README.md +++ b/samples/client/petstore/java/okhttp-gson-swagger1/README.md @@ -150,9 +150,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth - **Type**: OAuth @@ -162,6 +165,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key - **Type**: API key diff --git a/samples/client/petstore/java/okhttp-gson/README.md b/samples/client/petstore/java/okhttp-gson/README.md index 1c47396314b5..2afff823d3e6 100644 --- a/samples/client/petstore/java/okhttp-gson/README.md +++ b/samples/client/petstore/java/okhttp-gson/README.md @@ -238,9 +238,12 @@ Class | Method | HTTP request | Description - [Zebra](docs/Zebra.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth - **Type**: OAuth @@ -250,26 +253,31 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### bearer_test - **Type**: HTTP basic authentication + ### http_signature_test - **Type**: HTTP basic authentication diff --git a/samples/client/petstore/java/resteasy/README.md b/samples/client/petstore/java/resteasy/README.md index ea31b284bf49..a0b5ddd6048a 100644 --- a/samples/client/petstore/java/resteasy/README.md +++ b/samples/client/petstore/java/resteasy/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -217,6 +220,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -224,6 +228,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -231,6 +236,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/resttemplate-jakarta/README.md b/samples/client/petstore/java/resttemplate-jakarta/README.md index 303aac2d5af1..f9bb2708621f 100644 --- a/samples/client/petstore/java/resttemplate-jakarta/README.md +++ b/samples/client/petstore/java/resttemplate-jakarta/README.md @@ -149,9 +149,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -162,6 +165,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key diff --git a/samples/client/petstore/java/resttemplate-swagger1/README.md b/samples/client/petstore/java/resttemplate-swagger1/README.md index 303aac2d5af1..f9bb2708621f 100644 --- a/samples/client/petstore/java/resttemplate-swagger1/README.md +++ b/samples/client/petstore/java/resttemplate-swagger1/README.md @@ -149,9 +149,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -162,6 +165,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key diff --git a/samples/client/petstore/java/resttemplate-withXml/README.md b/samples/client/petstore/java/resttemplate-withXml/README.md index 4c4642113b28..5cbbb4147873 100644 --- a/samples/client/petstore/java/resttemplate-withXml/README.md +++ b/samples/client/petstore/java/resttemplate-withXml/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -217,6 +220,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -224,6 +228,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -231,6 +236,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/resttemplate/README.md b/samples/client/petstore/java/resttemplate/README.md index 2bace9845b14..5c320a6f122b 100644 --- a/samples/client/petstore/java/resttemplate/README.md +++ b/samples/client/petstore/java/resttemplate/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -217,6 +220,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -224,6 +228,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -231,6 +236,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/vertx-no-nullable/README.md b/samples/client/petstore/java/vertx-no-nullable/README.md index 00456e7d15f5..27027a49222b 100644 --- a/samples/client/petstore/java/vertx-no-nullable/README.md +++ b/samples/client/petstore/java/vertx-no-nullable/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -217,6 +220,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -224,6 +228,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -231,6 +236,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/vertx/README.md b/samples/client/petstore/java/vertx/README.md index fd7796984d05..57d95a617169 100644 --- a/samples/client/petstore/java/vertx/README.md +++ b/samples/client/petstore/java/vertx/README.md @@ -204,9 +204,12 @@ Class | Method | HTTP request | Description - [XmlItem](docs/XmlItem.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -217,6 +220,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -224,6 +228,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -231,6 +236,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test diff --git a/samples/client/petstore/java/webclient-jakarta/README.md b/samples/client/petstore/java/webclient-jakarta/README.md index 75a5fba59e2d..ef29a6a2f727 100644 --- a/samples/client/petstore/java/webclient-jakarta/README.md +++ b/samples/client/petstore/java/webclient-jakarta/README.md @@ -208,9 +208,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -221,6 +224,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -228,6 +232,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -235,16 +240,19 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### bearer_test - **Type**: HTTP basic authentication + ### http_signature_test diff --git a/samples/client/petstore/java/webclient-nullable-arrays/README.md b/samples/client/petstore/java/webclient-nullable-arrays/README.md index d290aad04980..321255562813 100644 --- a/samples/client/petstore/java/webclient-nullable-arrays/README.md +++ b/samples/client/petstore/java/webclient-nullable-arrays/README.md @@ -120,10 +120,11 @@ Class | Method | HTTP request | Description - [ByteArrayObject](docs/ByteArrayObject.md) + ## Documentation for Authorization -All endpoints do not require authorization. -Authentication schemes defined for the API: +Endpoints do not require authorization. + ## Recommendation diff --git a/samples/client/petstore/java/webclient/README.md b/samples/client/petstore/java/webclient/README.md index 75a5fba59e2d..ef29a6a2f727 100644 --- a/samples/client/petstore/java/webclient/README.md +++ b/samples/client/petstore/java/webclient/README.md @@ -208,9 +208,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -221,6 +224,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -228,6 +232,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -235,16 +240,19 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### bearer_test - **Type**: HTTP basic authentication + ### http_signature_test diff --git a/samples/openapi3/client/extensions/x-auth-id-alias/java/jersey2-java8/README.md b/samples/openapi3/client/extensions/x-auth-id-alias/java/jersey2-java8/README.md index 147549882a0f..3d49b91f5b48 100644 --- a/samples/openapi3/client/extensions/x-auth-id-alias/java/jersey2-java8/README.md +++ b/samples/openapi3/client/extensions/x-auth-id-alias/java/jersey2-java8/README.md @@ -159,9 +159,12 @@ Class | Method | HTTP request | Description + ## Documentation for Authorization + Authentication schemes defined for the API: + ### api_key @@ -169,6 +172,7 @@ Authentication schemes defined for the API: - **API key parameter name**: X-Api-Key - **Location**: HTTP header + ### api_key_query diff --git a/samples/openapi3/client/petstore/java/jersey2-java8-special-characters/README.md b/samples/openapi3/client/petstore/java/jersey2-java8-special-characters/README.md index d58ea10bdc01..8b9880600cef 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8-special-characters/README.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8-special-characters/README.md @@ -150,10 +150,11 @@ Class | Method | HTTP request | Description - [Parent](docs/Parent.md) + ## Documentation for Authorization -All endpoints do not require authorization. -Authentication schemes defined for the API: +Endpoints do not require authorization. + ## Recommendation diff --git a/samples/openapi3/client/petstore/java/jersey2-java8-swagger1/README.md b/samples/openapi3/client/petstore/java/jersey2-java8-swagger1/README.md index 12f02de97e32..7202f797ee1d 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8-swagger1/README.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8-swagger1/README.md @@ -174,9 +174,12 @@ Class | Method | HTTP request | Description - [User](docs/User.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -187,6 +190,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key diff --git a/samples/openapi3/client/petstore/java/jersey2-java8/README.md b/samples/openapi3/client/petstore/java/jersey2-java8/README.md index 870b398e0935..df8d6f8f9a78 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8/README.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8/README.md @@ -259,9 +259,12 @@ Class | Method | HTTP request | Description - [Zebra](docs/Zebra.md) + ## Documentation for Authorization + Authentication schemes defined for the API: + ### petstore_auth @@ -272,6 +275,7 @@ Authentication schemes defined for the API: - write:pets: modify pets in your account - read:pets: read your pets + ### api_key @@ -279,6 +283,7 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query @@ -286,16 +291,19 @@ Authentication schemes defined for the API: - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### bearer_test - **Type**: HTTP basic authentication + ### http_signature_test