OpenAPITools / OpenAPITools/openapi-generator

[Java][webclient] javadoc warnings

Open
#8,976 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
26.8k
Forks
7.7k
PR metrics pending

Description

Description

To address the following javadoc warnings:

/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java:142: warning: no @param for mapper
    public static WebClient buildWebClient(ObjectMapper mapper) {
                            ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java:325: warning: no @param for str
    public Date parseDate(String str) {
                ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java:325: warning: no @return
    public Date parseDate(String str) {
                ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java:336: warning: no @param for date
    public String formatDate(Date date) {
                  ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java:336: warning: no @return
    public String formatDate(Date date) {
                  ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java:526: warning: no @param for cookieParams
    public <T> Mono<T> invokeAPI(String path, HttpMethod method, Map<String, Object> pathParams, MultiValueMap<String, String> queryParams, Object body, HttpHeaders headerParams, MultiValueMap<String, String> cookieParams, MultiValueMap<String, Object> formParams, List<MediaType> accept, MediaType contentType, String[] authNames, ParameterizedTypeReference<T> returnType) throws RestClientException {
                       ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java:548: warning: no @param for cookieParams
    public <T> Flux<T> invokeFluxAPI(String path, HttpMethod method, Map<String, Object> pathParams, MultiValueMap<String, String> queryParams, Object body, HttpHeaders headerParams, MultiValueMap<String, String> cookieParams, MultiValueMap<String, Object> formParams, List<MediaType> accept, MediaType contentType, String[] authNames, ParameterizedTypeReference<T> returnType) throws RestClientException {
                       ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:63: warning: no @return
    public Mono<Void> createXmlItem(XmlItem xmlItem) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:216: warning: no @return
    public Mono<Void> testBodyWithFileSchema(FileSchemaTestClass body) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:250: warning: no @return
    public Mono<Void> testBodyWithQueryParams(String query, User body) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:339: warning: no @return
    public Mono<Void> testEndpointParameters(BigDecimal number, Double _double, String patternWithoutDelimiter, byte[] _byte, Integer integer, Integer int32, Long int64, Float _float, String string, File binary, LocalDate date, OffsetDateTime dateTime, String password, String paramCallback) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:421: warning: no @return
    public Mono<Void> testEnumParameters(List<String> enumHeaderStringArray, String enumHeaderString, List<String> enumQueryStringArray, String enumQueryString, Integer enumQueryInteger, Double enumQueryDouble, List<String> enumFormStringArray, String enumFormString) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:469: warning: no @return
    public Mono<Void> testGroupParameters(Integer requiredStringGroup, Boolean requiredBooleanGroup, Long requiredInt64Group, Integer stringGroup, Boolean booleanGroup, Long int64Group) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:517: warning: no @return
    public Mono<Void> testInlineAdditionalProperties(Map<String, String> param) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:551: warning: no @return
    public Mono<Void> testJsonFormData(String param, String param2) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/FakeApi.java:597: warning: no @return
    public Mono<Void> testQueryParameterCollectionFormat(List<String> pipe, List<String> ioutil, List<String> http, List<String> url, List<String> context) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/PetApi.java:59: warning: no @return
    public Mono<Void> addPet(Pet body) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/PetApi.java:94: warning: no @return
    public Mono<Void> deletePet(Long petId, String apiKey) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/PetApi.java:244: warning: no @return
    public Mono<Void> updatePet(Pet body) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/PetApi.java:279: warning: no @return
    public Mono<Void> updatePetWithForm(Long petId, String name, String status) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/StoreApi.java:56: warning: no @return
    public Mono<Void> deleteOrder(String orderId) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/UserApi.java:55: warning: no @return
    public Mono<Void> createUser(User body) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/UserApi.java:86: warning: no @return
    public Mono<Void> createUsersWithArrayInput(List<User> body) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/UserApi.java:117: warning: no @return
    public Mono<Void> createUsersWithListInput(List<User> body) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/UserApi.java:149: warning: no @return
    public Mono<Void> deleteUser(String username) throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/UserApi.java:262: warning: no @return
    public Mono<Void> logoutUser() throws WebClientResponseException {
                      ^
/Users/williamcheng/Code/openapi-generator2/samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/UserApi.java:291: warning: no @return
    public Mono<Void> updateUser(String username, User body) throws WebClientResponseException {
                      ^
27 warnings
openapi-generator version

latest master

OpenAPI declaration file content or url

petstore spec

Command line used for generation
Steps to reproduce

Run gradle build or mvn clen package in samples/client/petstore/java/webclient/

Related issues/PRs
Suggest a fix/enhancement

Fix the warnings by updating the docstrings in the templates.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the generated samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java and the FakeApi.java, PetApi.java, StoreApi.java, and UserApi.java files named in the warnings. Trace their Javadocs back to the Java webclient templates, then run gradle build or mvn clen package in samples/client/petstore/java/webclient/. Done means the listed Javadoc warnings no longer appear.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.