Skip to content
GitLab

Javadoc + operations interface + provider for state(ful/less) handlers

Merged Administrator requested to merge github/fork/noordawod/undertow-update/javadoc-and-make-abstract into master

Created by: noordawod

This pr brings the Undertow Server template up-to-date by adding the following:

  • Make the main class and methods abstract; this ensures that implementations do not miss an endpoint by mistake.
  • Added possibility to set a different base path if needed.
  • Added Javadoc for the endpoints, including description, notes, expects/returns and consumes/produces.
  • Properly links to other POJOs from the documentation.
  • Added licensing header to all files.
  • Fixed a couple of indentation errors in classes.
  • Allows users to just supply the implementation without the need to perform any modifications to the stock template.
  • Add @Nunnull annotations to the main generated class.

This could be a breaking change if one has forgotten to override an endpoint, so in many ways this pr helps users find such scenarios even before releasing to production.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

PR checklist

  • Read the contribution guidelines.
  • 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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. 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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.