Skip to content

Commit

Permalink
doc: update readme with more examples for render-bundle
Browse files Browse the repository at this point in the history
  • Loading branch information
micovery committed Apr 16, 2024
1 parent f68898a commit cf115da
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -540,13 +540,29 @@ Below is an example of generating an API Proxy bundle directly from a template
render-bundle -template ./examples/templates/oas3/apiproxy.yaml \
-set-oas spec=./examples/specs/petstore.yaml \
-include ./examples/templates/oas3/*.tmpl \
-dry-run "yaml" \
-validate false \
-output ./out/bundles/petstore.zip
```
Just like the `render-template`, and `yaml2bundle` tool this tool supports flags such as `-validate` and `-dry-run`
For example, the following command will print out the XML, but not create the bundle.
```shell
render-bundle -template ./examples/templates/oas3/apiproxy.yaml \
-set-oas spec=./examples/specs/petstore.yaml \
-include ./examples/templates/oas3/*.tmpl \
-dry-run "xml"
```
Or, if you want to peek and see what the intermediate YAML looks like, you can pass `-dry-run "yaml` like this:
```shell
render-bundle -template ./examples/templates/oas3/apiproxy.yaml \
-set-oas spec=./examples/specs/petstore.yaml \
-include ./examples/templates/oas3/*.tmpl \
-dry-run "yaml"
```
## Installation
If you already have [Go](https://go.dev/doc/install) installed in your machine, run the following command:
Expand Down

0 comments on commit cf115da

Please # to comment.