Validation Schemas (ssd schema)

The ssd schema command allows you to get validation schemas for documents used on Sensedia CLI in the declarative mode, through the terminal.

For more specific information on the available schema kinds, refer to the documentation on the Declarative Mode.

Usage

The ssd schema command can be followed by flags with their respective arguments:

ssd schema [flags]

If no flag is specified, the interactive mode will be activated.

# Gets an APPLY operation validation schema for the Environment resource
$ ssd schema --kinds Environment --operations APPLY

# Gets a DELETE operation validation schema for the App resource
$ ssd schema --kinds App --operations DELETE

# Gets APPLY and DELETE operations validation schemas for the RestAPI and Plan resources
$ ssd schema --kinds "RestAPI, Plan" --operations "APPLY, DELETE"

Available flags

The following flags can be used with the ssd schema command:

Flag

Type

Description

-h, --help

Displays help for the command

--kinds

string

Available kind names in the declarative mode, followed by commas

--operations

string

Operation names. E.g: "APPLY", "DELETE" e "APPLY, DELETE"

Global Flags

Flag

Type

Description

-c, --config

string

Configuration file (default: $HOME/.sensedia/config.json)

--profile

string

The configuration profile you want to use (default: "default")

--verbose

Lists all requests made by the command. It is possible to store this information in a TXT file instead of displaying it on the terminal. E.g.: $ ssd (api-management | apim) list apis --verbose 2> log.txt

Thanks for your feedback!

EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]