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

Description from Javadoc @param not generated when first line is empty #129

Closed
meredrica opened this issue Jan 30, 2020 · 0 comments · Fixed by #152
Closed

Description from Javadoc @param not generated when first line is empty #129

meredrica opened this issue Jan 30, 2020 · 0 comments · Fixed by #152

Comments

@meredrica
Copy link

Given the following Javadoc:

/**
* Check if the given user has access.
*
* @param username The username to check.
* @param password The password to check.
* @return 'allow' or 'deny'.
*/

The generated API doc is correct. However, with this:

/**
* Check if the given user has access to RabbitMQ.
*
* @param username
*                   The username to check.
* @param password
*                   The password to check.
* @return 'allow' or 'deny' and user tags.
*/

The generated yaml file lacks the description.

Expected:

      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                username:
                  type: string
                  description: "The username to check."
                  nullable: false
                password:
                  type: string
                  description: The password to check.
                  nullable: false

Actual:

      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                username:
                  type: string
                  nullable: false
                password:
                  type: string
                  nullable: false
croudet pushed a commit to croudet/micronaut-openapi that referenced this issue Feb 17, 2020
graemerocher pushed a commit that referenced this issue Feb 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant