Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Java] Cleanup documentation #15300

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,14 @@ Class | Method | HTTP request | Description
{{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
{{/model}}{{/models}}

<a id="documentation-for-authorization"></a>
## 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}}
<a id="{{name}}"></a>
### {{name}}

{{#isApiKey}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,14 @@ Class | Method | HTTP request | Description
{{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
{{/model}}{{/models}}

<a id="documentation-for-authorization"></a>
## 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}}
<a id="{{name}}"></a>
### {{name}}

{{#isApiKey}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,14 @@ Class | Method | HTTP request | Description
{{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
{{/model}}{{/models}}

<a id="documentation-for-authorization"></a>
## 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}}
<a id="{{name}}"></a>
### {{name}}

{{#isApiKey}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ public class Example {
{{/responses.0}}
{{#vendorExtensions.x-group-parameters}}{{#hasParams}}

<a name="API{{operationId}}Request"></a>
<a id="API{{operationId}}Request"></a>
## API{{operationId}}Request
### Properties
{{#allParams}}{{#-last}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,14 @@ Class | Method | HTTP request | Description
{{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
{{/model}}{{/models}}

<a id="documentation-for-authorization"></a>
## 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}}
<a id="{{name}}"></a>
### {{name}}

{{#isApiKey}}- **Type**: API key
- **API key parameter name**: {{keyParamName}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ All URIs are relative to *{{basePath}}*

{{#operations}}
{{#operation}}
<a name="{{operationId}}"></a>
<a id="{{operationId}}"></a>
# **{{operationId}}**{{^vendorExtensions.x-group-parameters}}
> {{#returnType}}{{.}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}}){{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}
> {{#returnType}}{{.}} {{/returnType}}{{operationId}}({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}){{#optionalParams}}.{{paramName}}({{paramName}}){{/optionalParams}}.execute();{{/vendorExtensions.x-group-parameters}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ All URIs are relative to *{{basePath}}*

{{#operations}}
{{#operation}}
<a name="{{operationId}}"></a>
<a id="{{operationId}}"></a>
# **{{operationId}}**
> {{#returnType}}{{.}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}})

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ More information can be found inside [Inversion of Control guide section](https:

{{#operations}}
{{#operation}}
<a name="{{operationId}}"></a>
<a id="{{operationId}}"></a>
# **{{operationId}}**
```java
{{#returnType}}Mono<{{{returnType}}}>{{/returnType}}{{^returnType}}Mono<Void>{{/returnType}} {{classname}}.{{nickname}}({{#allParams}}{{{paramName}}}{{#hasMore}}, {{/hasMore}}{{/allParams}})
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Authorization methods
{{#authMethods}}
<a name="name"></a>
<a id="name"></a>
# {{name}}
{{!
basic auth
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Method | HTTP request | Description

{{#operations}}
{{#operation}}
<a name="{{operationId}}"></a>
<a id="{{operationId}}"></a>
# **{{operationId}}**
```java
{{#returnType}}Mono<{{{returnType}}}>{{/returnType}}{{^returnType}}Mono<Object>{{/returnType}} {{classname}}.{{nickname}}({{#allParams}}{{{paramName}}}{{#hasMore}}, {{/hasMore}}{{/allParams}})
Expand Down
5 changes: 3 additions & 2 deletions samples/client/echo_api/java/apache-httpclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,11 @@ Class | Method | HTTP request | Description
- [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)


<a id="documentation-for-authorization"></a>
## Documentation for Authorization

All endpoints do not require authorization.
Authentication schemes defined for the API:
Endpoints do not require authorization.


## Recommendation

Expand Down
5 changes: 3 additions & 2 deletions samples/client/echo_api/java/native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,10 +156,11 @@ Class | Method | HTTP request | Description
- [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)


<a id="documentation-for-authorization"></a>
## Documentation for Authorization

All endpoints do not require authorization.
Authentication schemes defined for the API:
Endpoints do not require authorization.


## Recommendation

Expand Down
5 changes: 3 additions & 2 deletions samples/client/echo_api/java/okhttp-gson/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,11 @@ Class | Method | HTTP request | Description
- [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)


<a id="documentation-for-authorization"></a>
## Documentation for Authorization

All endpoints do not require authorization.
Authentication schemes defined for the API:
Endpoints do not require authorization.


## Recommendation

Expand Down
12 changes: 6 additions & 6 deletions samples/client/echo_api/java/okhttp-gson/docs/BodyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ All URIs are relative to *http://localhost:3000*
| [**testEchoBodyTagResponseString**](BodyApi.md#testEchoBodyTagResponseString) | **POST** /echo/body/Tag/response_string | Test empty json (request body) |


<a name="testBinaryGif"></a>
<a id="testBinaryGif"></a>
# **testBinaryGif**
> File testBinaryGif()

Expand Down Expand Up @@ -70,7 +70,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testBodyApplicationOctetstreamBinary"></a>
<a id="testBodyApplicationOctetstreamBinary"></a>
# **testBodyApplicationOctetstreamBinary**
> String testBodyApplicationOctetstreamBinary(body)

Expand Down Expand Up @@ -132,7 +132,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testEchoBodyFreeFormObjectResponseString"></a>
<a id="testEchoBodyFreeFormObjectResponseString"></a>
# **testEchoBodyFreeFormObjectResponseString**
> String testEchoBodyFreeFormObjectResponseString(body)

Expand Down Expand Up @@ -194,7 +194,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testEchoBodyPet"></a>
<a id="testEchoBodyPet"></a>
# **testEchoBodyPet**
> Pet testEchoBodyPet(pet)

Expand Down Expand Up @@ -256,7 +256,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testEchoBodyPetResponseString"></a>
<a id="testEchoBodyPetResponseString"></a>
# **testEchoBodyPetResponseString**
> String testEchoBodyPetResponseString(pet)

Expand Down Expand Up @@ -318,7 +318,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testEchoBodyTagResponseString"></a>
<a id="testEchoBodyTagResponseString"></a>
# **testEchoBodyTagResponseString**
> String testEchoBodyTagResponseString(tag)

Expand Down
2 changes: 1 addition & 1 deletion samples/client/echo_api/java/okhttp-gson/docs/FormApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ All URIs are relative to *http://localhost:3000*
| [**testFormIntegerBooleanString**](FormApi.md#testFormIntegerBooleanString) | **POST** /form/integer/boolean/string | Test form parameter(s) |


<a name="testFormIntegerBooleanString"></a>
<a id="testFormIntegerBooleanString"></a>
# **testFormIntegerBooleanString**
> String testFormIntegerBooleanString(integerForm, booleanForm, stringForm)

Expand Down
2 changes: 1 addition & 1 deletion samples/client/echo_api/java/okhttp-gson/docs/HeaderApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ All URIs are relative to *http://localhost:3000*
| [**testHeaderIntegerBooleanString**](HeaderApi.md#testHeaderIntegerBooleanString) | **GET** /header/integer/boolean/string | Test header parameter(s) |


<a name="testHeaderIntegerBooleanString"></a>
<a id="testHeaderIntegerBooleanString"></a>
# **testHeaderIntegerBooleanString**
> String testHeaderIntegerBooleanString(integerHeader, booleanHeader, stringHeader)

Expand Down
2 changes: 1 addition & 1 deletion samples/client/echo_api/java/okhttp-gson/docs/PathApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ All URIs are relative to *http://localhost:3000*
| [**testsPathStringPathStringIntegerPathInteger**](PathApi.md#testsPathStringPathStringIntegerPathInteger) | **GET** /path/string/{path_string}/integer/{path_integer} | Test path parameter(s) |


<a name="testsPathStringPathStringIntegerPathInteger"></a>
<a id="testsPathStringPathStringIntegerPathInteger"></a>
# **testsPathStringPathStringIntegerPathInteger**
> String testsPathStringPathStringIntegerPathInteger(pathString, pathInteger)

Expand Down
16 changes: 8 additions & 8 deletions samples/client/echo_api/java/okhttp-gson/docs/QueryApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ All URIs are relative to *http://localhost:3000*
| [**testQueryStyleFormExplodeTrueObjectAllOf**](QueryApi.md#testQueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) |


<a name="testEnumRefString"></a>
<a id="testEnumRefString"></a>
# **testEnumRefString**
> String testEnumRefString(enumRefStringQuery)

Expand Down Expand Up @@ -76,7 +76,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testQueryDatetimeDateString"></a>
<a id="testQueryDatetimeDateString"></a>
# **testQueryDatetimeDateString**
> String testQueryDatetimeDateString(datetimeQuery, dateQuery, stringQuery)

Expand Down Expand Up @@ -142,7 +142,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testQueryIntegerBooleanString"></a>
<a id="testQueryIntegerBooleanString"></a>
# **testQueryIntegerBooleanString**
> String testQueryIntegerBooleanString(integerQuery, booleanQuery, stringQuery)

Expand Down Expand Up @@ -208,7 +208,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testQueryStyleDeepObjectExplodeTrueObject"></a>
<a id="testQueryStyleDeepObjectExplodeTrueObject"></a>
# **testQueryStyleDeepObjectExplodeTrueObject**
> String testQueryStyleDeepObjectExplodeTrueObject(queryObject)

Expand Down Expand Up @@ -270,7 +270,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testQueryStyleDeepObjectExplodeTrueObjectAllOf"></a>
<a id="testQueryStyleDeepObjectExplodeTrueObjectAllOf"></a>
# **testQueryStyleDeepObjectExplodeTrueObjectAllOf**
> String testQueryStyleDeepObjectExplodeTrueObjectAllOf(queryObject)

Expand Down Expand Up @@ -332,7 +332,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testQueryStyleFormExplodeTrueArrayString"></a>
<a id="testQueryStyleFormExplodeTrueArrayString"></a>
# **testQueryStyleFormExplodeTrueArrayString**
> String testQueryStyleFormExplodeTrueArrayString(queryObject)

Expand Down Expand Up @@ -394,7 +394,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testQueryStyleFormExplodeTrueObject"></a>
<a id="testQueryStyleFormExplodeTrueObject"></a>
# **testQueryStyleFormExplodeTrueObject**
> String testQueryStyleFormExplodeTrueObject(queryObject)

Expand Down Expand Up @@ -456,7 +456,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | Successful operation | - |

<a name="testQueryStyleFormExplodeTrueObjectAllOf"></a>
<a id="testQueryStyleFormExplodeTrueObjectAllOf"></a>
# **testQueryStyleFormExplodeTrueObjectAllOf**
> String testQueryStyleFormExplodeTrueObjectAllOf(queryObject)

Expand Down
5 changes: 3 additions & 2 deletions samples/client/others/java/okhttp-gson-streaming/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,11 @@ Class | Method | HTTP request | Description
- [SomeObj](docs/SomeObj.md)


<a id="documentation-for-authorization"></a>
## Documentation for Authorization

All endpoints do not require authorization.
Authentication schemes defined for the API:
Endpoints do not require authorization.


## Recommendation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ All URIs are relative to *http://localhost:8082*
| [**postPing**](PingApi.md#postPing) | **POST** /ping | |


<a name="getPing"></a>
<a id="getPing"></a>
# **getPing**
> SomeObj getPing(petId).name(name).status(status).execute();

Expand Down Expand Up @@ -75,7 +75,7 @@ No authorization required
|-------------|-------------|------------------|
| **200** | OK | - |

<a name="postPing"></a>
<a id="postPing"></a>
# **postPing**
> SomeObj postPing(someObj)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Note that the class needs to be annotated with one of Micronaut's [scope annotat

More information can be found inside [Inversion of Control guide section](https://docs.micronaut.io/latest/guide/#ioc).

<a name="call123testSpecialTags"></a>
<a id="call123testSpecialTags"></a>
# **call123testSpecialTags**
```java
Mono<ModelClient> AnotherFakeApi.call123testSpecialTags(_body)
Expand Down
Loading