Skip to content

Updated the HTML2 Doc Curl Examples to provide sample Request Body & Query Param examples.#10323

Merged
wing328 merged 3 commits into
OpenAPITools:masterfrom
Kraust:html2docs-curl-examples
Sep 9, 2021
Merged

Updated the HTML2 Doc Curl Examples to provide sample Request Body & Query Param examples.#10323
wing328 merged 3 commits into
OpenAPITools:masterfrom
Kraust:html2docs-curl-examples

Conversation

@Kraust

@Kraust Kraust commented Sep 3, 2021

Copy link
Copy Markdown
Contributor

Addressed the issue in #9384 where query strings in curl examples were not displaying their example values.
I also refactored the code out so that the curl example into its own mustache file, and provided the request body examples as well.

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.
  • Run the following to build the project and update samples:
    ./mvn clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.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.

@Kraust

Kraust commented Sep 3, 2021

Copy link
Copy Markdown
Contributor Author

Note: I would have assumed samples/documentation/html2/index.html would have been modified by this change, but it doesn't seem like the sample was modified despite the fact I ran generate_samples.sh.

@wing328

wing328 commented Sep 8, 2021

Copy link
Copy Markdown
Member

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@wing328

wing328 commented Sep 8, 2021

Copy link
Copy Markdown
Member

Note: I would have assumed samples/documentation/html2/index.html would have been modified by this change, but it doesn't seem like the sample was modified despite the fact I ran generate_samples.sh.

Don't worry. We'll take a look.

@wing328 wing328 added Doc: HTML Generation of HTML documentation Enhancement: General labels Sep 8, 2021
@wing328 wing328 added this to the 5.3.0 milestone Sep 8, 2021
@Kraust

Kraust commented Sep 8, 2021

Copy link
Copy Markdown
Contributor Author

Hopefully that fixes that for you, thanks.

@wing328 wing328 merged commit 0eba15f into OpenAPITools:master Sep 9, 2021
@wing328

wing328 commented Sep 9, 2021

Copy link
Copy Markdown
Member

Yup, looks good now. Commits are correctly linked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc: HTML Generation of HTML documentation Enhancement: General

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants