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

[Java][jersey2]: Documentation changes and making example snippet compilable #3056

Merged
merged 5 commits into from
Jun 3, 2019

Conversation

saigiridhar21
Copy link
Contributor

@saigiridhar21 saigiridhar21 commented Jun 2, 2019

PR checklist

  • 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 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\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Closes: #3059
Closes: #3060

For Java Jersey2's client, following changes are done.

  • Adding Http response details on each method's summary.
  • Adding Http response details on the api docs (Jersey2 is using common api_doc.mustache and so other client's petstore projects were also update in this pull request).
  • On api docs, example snippet was updated to make it compilable.
  • On Readme, example snippet was updated to make it compilable on Readme(Jersey2 is using common readme.mustache and so other client's petstore projects were also update in this pull request).

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

@saigiridhar21 saigiridhar21 changed the title Java jersey docs changes [Java][jersey2]: Documentation changes and making example snippet compilable Jun 2, 2019
@saigiridhar21 saigiridhar21 force-pushed the java-jersey-docs-changes branch from 251c2be to bf0e3b7 Compare June 2, 2019 06:08
@wing328 wing328 merged commit 6ff0512 into OpenAPITools:master Jun 3, 2019
@wing328 wing328 added this to the 4.0.2 milestone Jun 3, 2019
@saigiridhar21 saigiridhar21 deleted the java-jersey-docs-changes branch June 3, 2019 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment