GYAT v0.1.0 - info and get command - MVP

[adrianescutia]

Installation

1. Download the binary for your operating system from the GitHub releases page.
2. Extract the binary from the downloaded archive.
3. Move the binary to a directory in your system path (e.g., /usr/local/bin).
4. Run the binary from your terminal.

Usage

You can go to the documentation page for more details on the commands.

Features:

InfoCommand with list

gyat info list - List all the available commands based on the specs directory - for more details check the docs

gyat info list -o yaml - List all the available commands based on the specs directory in yaml format

gyat info list -v - List all the available commands based on the specs directory with additional details about the resources

GetCommand

Get a resource based on the specs file - for more details check the docs

The get command can be compared with the kubectl get command where you can get the resources defined in the specs file. We encorage to use the the Swagger tags to group the resources and use the gyat info list to get the list of resources.

The operationId is a unique identifier for resources and operations, hence it is used to invoke the resources.

gyat petstore get pet 10 - Example from the petstore specs file, we get the pet with the id 10.
gyat petstore get pet --id 10 - Example from the petstore specs file, we get the pet with the id 10.

Adding query params in URL

gyat petstore get pet --operationId=findPetsByStatus --status=available --o=json - Example from the petstore specs file, we get the pets with the status available in json format.

Supported formats for output: yaml|json|details

---

This discussion was created from the release GYAT v0.1.0 - info and get command - MVP.