The qaskx-cli definition print command performs a flat structure output of the OpenAPI
definition as defined in the “devops.json” file.
The command help is shown below.
Usage: qaskx-cli definition print [-d=<devops file>] [-s=<openAPI file>] [--output=<output file>] [--services] [--validate] [--name=<name>] [--path=<service path>] [--overwrite][-v | --vv | --vvv | --silent] [-c=<conf file>] [--colourCLI] [--offline] [--env=<environment file>]
Pretty print an OpenAPI document
Options:
-d, --devops rediOps (devops.json) file path
-o, --output Output file path (default "CONSOLE")
-s, --spec OpenAPI file to parse for print
--services Service paths
-n, --name Service name filter
-p, --path Service path filter
--validate Validate API definition
--overwrite Overwrite existing file
-v, --verbose Verbose logging
--vv Verbose logging level 3
--vvv Verbose logging level 5
--silent Silent running
--colourCLI Colour terminal and command line (env $QASKX_COLOUR_CLI)
-c, --conf Configuration file (env $QASKX_CONFIG_FILE)
--offline Offline mode (env $QASKX_OFFLINE)
--env Environment file to use (default ".env")
Purpose
The purpose of the command is to produce a stucture that is not nested and hierarchical like the OpenAPI json or yaml file, but a file that can be viewed in Excel or similar program or fed into other tools as a CSV formatted output.
Example
If your run the command below
qaskx-cli definition print --spec https://petstore3.swagger.io/api/v3/openapi.json
The ouput to console will be something like:
______ ___ _______. __ ___ ___ ___
/ __ \ / \ / || |/ / \ \ / /
| | | | / ^ \ | (----`| ' / \ V /
| | | | / /_\ \ \ \ | < > <
| `--' '--. / _____ \ .----) | | . \ / . \
\_____\_____\/__/ \__\ |_______/ |__|\__\ /__/ \__\
qaskx-cli - command line tool
version - 0.0.5
url - https://docs.qaskx.one/qaskx-cli/
copyright - 2023 qaskx.one, usage license limited
HD https petstore3.swagger.io /api/v3/openapi.json
RP /user/createWithList Creates list of users with given input... POST 200 Successful operation 1 firstName string 0 -1
RP /user/createWithList Creates list of users with given input... POST 200 Successful operation 2 lastName string 0 -1
RP /user/createWithList Creates list of users with given input... POST 200 Successful operation 3 email string 0 -1
RP /user/createWithList Creates list of users with given input... POST 200 Successful operation 4 password string 0 -1
RP /user/createWithList Creates list of users with given input... POST 200 Successful operation 5 phone string 0 -1
RP /user/createWithList Creates list of users with given input... POST 200 Successful operation 6 userStatus integer int32 0 -1 User Status
RP /user/createWithList Creates list of users with given input... POST 200 Successful operation 7 id integer int64 0 -1
RP /user/createWithList Creates list of users with given input... POST 200 Successful operation 8 username string 0 -1
RQ /user This can only be done by the logged in... POST 000 Created user object 1 username string 0 0
RQ /user This can only be done by the logged in... POST 000 Created user object 2 firstName string 0 0
RQ /user This can only be done by the logged in... POST 000 Created user object 3 lastName string 0 0
RQ /user This can only be done by the logged in... POST 000 Created user object 4 email string 0 0
RQ /user This can only be done by the logged in... POST 000 Created user object 5 password string 0 0
RQ /user This can only be done by the logged in... POST 000 Created user object 6 phone string 0 0
RQ /user This can only be done by the logged in... POST 000 Created user object 7 userStatus integer int32 0 0 User Status
RQ /user This can only be done by the logged in... POST 000 Created user object 8 id integer int64 0 0
RP /user This can only be done by the logged in... POST default successful operation 1 id integer int64 0 -1
RP /user This can only be done by the logged in... POST default successful operation 2 username string 0 -1
RP /user This can only be done by the logged in... POST default successful operation 3 firstName string 0 -1
RP /user This can only be done by the logged in... POST default successful operation 4 lastName string 0 -1
RP /user This can only be done by the logged in... POST default successful operation 5 email string 0 -1
RP /user This can only be done by the logged in... POST default successful operation 6 password string 0 -1
RP /user This can only be done by the logged in... POST default successful operation 7 phone string 0 -1
RP /user This can only be done by the logged in... POST default successful operation 8 userStatus integer int32 0 -1 User Status
RQ /store/order Place a new order in the store POST 000 1 complete boolean 0 0
RQ /store/order Place a new order in the store POST 000 2 id integer int64 0 0
RQ /store/order Place a new order in the store POST 000 3 petId integer int64 0 0
RQ /store/order Place a new order in the store POST 000 4 quantity integer int32 0 0
RQ /store/order Place a new order in the store POST 000 5 shipDate string date-time 0 0
RQ /store/order Place a new order in the store POST 000 6 status string 0 0 Order Status
RP /store/order Place a new order in the store POST 200 successful operation 1 petId integer int64 0 -1
RP /store/order Place a new order in the store POST 200 successful operation 2 quantity integer int32 0 -1
RP /store/order Place a new order in the store POST 200 successful operation 3 shipDate string date-time 0 -1
RP /store/order Place a new order in the store POST 200 successful operation 4 status string 0 -1 Order Status
RP /store/order Place a new order in the store POST 200 successful operation 5 complete boolean 0 -1
RP /store/order Place a new order in the store POST 200 successful operation 6 id integer int64 0 -1
RQ /pet Add a new pet to the store POST 000 Create a new pet in the store 1 id integer int64 0 0
RQ /pet Add a new pet to the store POST 000 Create a new pet in the store 2 name string 0 0
RQ /pet Add a new pet to the store POST 000 Create a new pet in the store 3 category Category 0 0
RQ /pet Add a new pet to the store POST 000 Create a new pet in the store 4 photoUrls []string 0 0
RQ /pet Add a new pet to the store POST 000 Create a new pet in the store 5 tags []Tag 0 0
RQ /pet Add a new pet to the store POST 000 Create a new pet in the store 6 status string 0 0 pet status in the store
RP /pet Add a new pet to the store POST 200 Successful operation 1 name string 0 -1
RP /pet Add a new pet to the store POST 200 Successful operation 2 category Category 0 -1
RP /pet Add a new pet to the store POST 200 Successful operation 3 photoUrls []string 0 -1
RP /pet Add a new pet to the store POST 200 Successful operation 4 tags []Tag 0 -1
RP /pet Add a new pet to the store POST 200 Successful operation 5 status string 0 -1 pet status in the store
RP /pet Add a new pet to the store POST 200 Successful operation 6 id integer int64 0 -1
RQ /pet Update an existing pet by Id PUT 000 Update an existent pet in the store 1 tags []Tag 0 0
RQ /pet Update an existing pet by Id PUT 000 Update an existent pet in the store 2 status string 0 0 pet status in the store
RQ /pet Update an existing pet by Id PUT 000 Update an existent pet in the store 3 id integer int64 0 0
RQ /pet Update an existing pet by Id PUT 000 Update an existent pet in the store 4 name string 0 0
RQ /pet Update an existing pet by Id PUT 000 Update an existent pet in the store 5 category Category 0 0
RQ /pet Update an existing pet by Id PUT 000 Update an existent pet in the store 6 photoUrls []string 0 0
RP /pet Update an existing pet by Id PUT 200 Successful operation 1 name string 0 -1
RP /pet Update an existing pet by Id PUT 200 Successful operation 2 category Category 0 -1
RP /pet Update an existing pet by Id PUT 200 Successful operation 3 photoUrls []string 0 -1
RP /pet Update an existing pet by Id PUT 200 Successful operation 4 tags []Tag 0 -1
RP /pet Update an existing pet by Id PUT 200 Successful operation 5 status string 0 -1 pet status in the store
RP /pet Update an existing pet by Id PUT 200 Successful operation 6 id integer int64 0 -1
RP /user/{username} GET 200 successful operation 1 password string 0 -1
RP /user/{username} GET 200 successful operation 2 phone string 0 -1
RP /user/{username} GET 200 successful operation 3 userStatus integer int32 0 -1 User Status
RP /user/{username} GET 200 successful operation 4 id integer int64 0 -1
RP /user/{username} GET 200 successful operation 5 username string 0 -1
RP /user/{username} GET 200 successful operation 6 firstName string 0 -1
RP /user/{username} GET 200 successful operation 7 lastName string 0 -1
RP /user/{username} GET 200 successful operation 8 email string 0 -1
RQ /user/{username} This can only be done by the logged in... PUT 000 Update an existent user in the store 1 email string 0 0
RQ /user/{username} This can only be done by the logged in... PUT 000 Update an existent user in the store 2 password string 0 0
RQ /user/{username} This can only be done by the logged in... PUT 000 Update an existent user in the store 3 phone string 0 0
RQ /user/{username} This can only be done by the logged in... PUT 000 Update an existent user in the store 4 userStatus integer int32 0 0 User Status
RQ /user/{username} This can only be done by the logged in... PUT 000 Update an existent user in the store 5 id integer int64 0 0
RQ /user/{username} This can only be done by the logged in... PUT 000 Update an existent user in the store 6 username string 0 0
RQ /user/{username} This can only be done by the logged in... PUT 000 Update an existent user in the store 7 firstName string 0 0
RQ /user/{username} This can only be done by the logged in... PUT 000 Update an existent user in the store 8 lastName string 0 0
RP /store/order/{orderId} For valid response try integer IDs wit... GET 200 successful operation 1 quantity integer int32 0 -1
RP /store/order/{orderId} For valid response try integer IDs wit... GET 200 successful operation 2 shipDate string date-time 0 -1
RP /store/order/{orderId} For valid response try integer IDs wit... GET 200 successful operation 3 status string 0 -1 Order Status
RP /store/order/{orderId} For valid response try integer IDs wit... GET 200 successful operation 4 complete boolean 0 -1
RP /store/order/{orderId} For valid response try integer IDs wit... GET 200 successful operation 5 id integer int64 0 -1
RP /store/order/{orderId} For valid response try integer IDs wit... GET 200 successful operation 6 petId integer int64 0 -1
RP /pet/{petId}/uploadImage POST 200 successful operation 1 code integer int32 0 -1
RP /pet/{petId}/uploadImage POST 200 successful operation 2 type string 0 -1
RP /pet/{petId}/uploadImage POST 200 successful operation 3 message string 0 -1
RP /pet/{petId} Returns a single pet GET 200 successful operation 1 category Category 0 -1
RP /pet/{petId} Returns a single pet GET 200 successful operation 2 photoUrls []string 0 -1
RP /pet/{petId} Returns a single pet GET 200 successful operation 3 tags []Tag 0 -1
RP /pet/{petId} Returns a single pet GET 200 successful operation 4 status string 0 -1 pet status in the store
RP /pet/{petId} Returns a single pet GET 200 successful operation 5 id integer int64 0 -1
RP /pet/{petId} Returns a single pet GET 200 successful operation 6 name string 0 -1