Merged
requested to merge github/fork/alexrashed/feature/singleRequestParameter-documentation into master
Created by: alexrashed
Fixes #5307 (closed) If useSingleRequestParameter is activated for the Angular generator, a JSDoc comment is added to the generated request parameter interface members (if a description is given in the spec).
Previously:
export interface ExampleRequestParams {
test: string;
}
With this PR:
export interface ExampleRequestParams {
/** An example documentation of the request parameter test. */
test: string;
}
PR checklist
-
Read the contribution guidelines. -
If contributing template-only or documentation-only changes which will change sample output, build the project before. -
Run the shell script(s) under ./bin/
(or Windows batch scripts under.\bin\windows
) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the code or mustache templates for a language ({LANG}
) (e.g. php, ruby, python, etc). -
File the PR against the correct branch: master
,4.3.x
,5.0.x
. Default:master
. -
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
Technical commitee
@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @nicokoenig (2018/09) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)