-
Notifications
You must be signed in to change notification settings - Fork 0
Codegen javadoc enhancement, compare with getallmodels-description branch #3
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
base: getallmodels-description
Are you sure you want to change the base?
Codegen javadoc enhancement, compare with getallmodels-description branch #3
Conversation
…dummy description when both summary and description are empty
* @param input The input parameter. Allowed values: "value1", "value2". | ||
* @param input . Allowed values: "value1", "value2". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably want "The input parameter. Allowed values: "value1", "value2"." here.
The ". Allowed .." likely added by codegen. Swagger prorbably have no description on this param.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the catch! I'm fixing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 7b1bc2e
* @param model I am root, and I ref a model with no meta. | ||
* @param model The model parameter. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As long as this is what Swagger defines, this should be fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change is because we don't fallback to param's schema's description. So default description is generated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change is because we don't fallback to param's schema's description. So default description is generated.
I am asking you to at least check 1 or 2 places in https://github.com/Azure/autorest.testserver/blob/main/swagger, that this assertion is true.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
impacts: