Skip to content
GitLab

Outputs dataType to YARD tag

Merged Administrator requested to merge github/fork/ota42y/feature/data_type into master

Created by: ota42y

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh, ./bin/security/{LANG}-petstore.sh and ./bin/openapi3/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language. @cliffano (2017/07) @zlx (2017/09) @autopp (2019/02)

YARD supports parameter type tag. https://www.rubydoc.info/gems/yard/file/docs/Tags.md#param

We can use dataType as parameter type. So it's very useful to output dataType.

(details of the change, additional tests that have been done, reference to the issue for tracking, etc)