Skip to content
GitLab

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

Merged Administrator requested to merge github/fork/Kraust/html2docs-curl-examples into master

Created by: Kraust

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.