Add --format flag to Zally CLI
See original GitHub issueIn order to make Zally Command Line Utility (CLI) usable in different Continuous Integration platforms, we want to add more formatting options. Therefore, we need to implement an extra --format
flag.
Acceptance Criteria
As a Zally CLI user
I want to provide the --format flag when running CLI
So that Zally will format its output in plain text or markdown
Example
./zally --format=markdown
Expected text output:
MUST Use Problem JSON
Operations Should Return Problem JSON When Any Problem Occurs During Processing Whether Caused by Client Or Server
https://zalando.github.io/restful-api-guidelines/#176
/products GET 429
/products/{product_id} GET 418
/products/{product_id} GET 429
/products/{product_id} PATCH 400
/products/{product_id} PATCH 429
Expected markdown output
### `MUST` [Use Problem JSON](https://zalando.github.io/restful-api-guidelines/#176)
> Operations Should Return Problem JSON When Any Problem Occurs During Processing Whether Caused by Client Or Server
- /products GET 429
- /products/{product_id} GET 418
- /products/{product_id} GET 429
- /products/{product_id} PATCH 400
- /products/{product_id} PATCH 429
Expected output when no violations happened:
Congratulations! No violations found.
Issue Analytics
- State:
- Created 6 years ago
- Comments:6 (5 by maintainers)
Top Results From Across the Web
zalando/zally - Gitter
Hi Zally team, we are an OpenAPI team from Finastra. We are successfully running the full Zalando-Zally stack on both Windows and Linux...
Read more >zally | A minimalistic, simple-to-use API linter
Zally's easy-to-use CLI uses the server in the background so that you can check ... Swagger-friendly: accepts Swagger .yaml and JSON formats; includes...
Read more >Teleport CLI Reference | Teleport Docs
These flags are available for all commands --login, --proxy, --user, --ttl, --identity, --cert-format, --insecure, --auth, --skip-version, --debug, --jumphost .
Read more >CLI Flags in Practice + How to Make Your Own CLI Command ...
The syntax of CLI commands plus how to create your own CLI with oclif. ... These two formats for flags are the standard...
Read more >podman-run
podman save --format docker-dir fedora -o /tmp/fedora $ podman run ... Use the --group-add keep-groups flag to pass the user's supplementary group access ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Thanks @maxim-tschumak and @roxspring for the valuable input. Let me proceed with the implementation then
Looks good!
Let’s keep it simple 😃
IMHO, it can be the same
Great idea!