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

[docs] Sorted doc outputs and clean up duplicated CliOptions #5046

Merged
merged 6 commits into from
Jan 20, 2020

Conversation

jimschubert
Copy link
Member

This is general maintenance on quality of generator docs.
This PR:

  • Sorts the outputs alphabetically, to make it easier to find what users are looking for
  • Removes generator docs for old generator names (where current docs are those matching the current generator names): avoids potential confusion for people browsing docs on github
  • Fixes 5-6 cases where generators were inadvertently adding duplicated CliOptions, likely not apparent before because they weren't sorted
  • Add --github-nested-index for generating docs/generators/README.md. This file has been maintained manually, but this allows copy/paste from CLI output

cc @OpenAPITools/generator-core-team

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.

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.
@jimschubert
Copy link
Member Author

Added bug fix as this fixes duplicate CLI options and invalid version CLI option (was packageName) for two Erlang generators.

@jimschubert jimschubert merged commit 644f720 into master Jan 20, 2020
@jimschubert jimschubert deleted the config-docs branch January 20, 2020 01:19
jimschubert added a commit that referenced this pull request Jan 26, 2020
* 5.0.x: (92 commits)
  [Rust Server] Handle array of objects inside an object correctly (#5044)
  [Rust Server] Sanitise enum values (#5042)
  [Rust Server] Add support for primitive arrays (#5041)
  [elm] Fix duplicate coder names (#5100)
  [elm] enum items and parameters (#5051)
  [elm] Fix decoding empty operation responses (#5055)
  resolve merge conflicts in VERSION files
  undo restoring ElmClientCodegenTest.java
  fix merge conflicts
  [dart-dio] Various fixes (#5027)
  Add java code comments based on explanation from Jim Schubert (#5048)
  Execute ./bin/openapi3/go-experimental-petstore.sh script (#5049)
  [docs] Sorted doc outputs and clean up duplicated CliOptions (#5046)
  Add docs/installation.md and docsite index to version update script (#5037)
  [gradle] consistent use of maven url in gradle files (#5045)
  Use HTTPS Maven URL in Kotlin meta generator (#5043)
  [Python] fix numeric enum in python flask, aiohttp (#5019)
  add multipleOf to various codegen classes (#5021)
  Add a link to a youtube video on Pulp and OpenAPI Generator (#5038)
  [scripts] Remove misspelled OPENAPI_GENERATOR_DOWLOAD_CACHE_DIR (#5035)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant