openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[cpp-ue4] Update CppUE4ClientCodegen.java to generate docs

Open monicataina opened this issue 2 years ago • 0 comments

Add support for the global properties: apiDocs and modelDocs. In case the files are generated enabling them, it will search for api_doc.mustache and model_doc.mustache to generate md documentation files.

Add an optional property for the generating call: generateReadme = true. By default, it's false and it can be omitted, so that it won't be a breaking change. If this option is used, then it will search for README.mustache and it will generate index.md file. The "index" name was chosen so that mkdocs can be used including multiple services generated via OpenAPI and this way can create a page for each of them and use the mkdocs index section feature

PR checklist

  • [x] Read the contribution guidelines.
  • [x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [x] File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Mentioning C++ committee members as instructed: @ravinikam @stkrwork @etherealjoy @martindelille @muttleyxd

monicataina avatar Feb 01 '24 15:02 monicataina