LDS Luvio.raml Wizard

The LDS wizard is an SDFX command that automatically creates a functional luvio.raml from an existing api.raml.

For more information on RAML and how Luvio uses it, please refer to the Luvio documentation (https://luvio-docs.herokuapp.com/guide/quick-start#raml-overview).

Invoke the CLI with the following command:

$ ldscli lds:generate ./api.raml

The wizard asks a series of questions to determine certain output features of luvio.raml and generates a luvio.raml file to the same directory as the input api.raml file.

Arguments

- a positional argument to denote the location of the input api.raml file

* --defaults - uses default values for luvio.raml type annotations. This argument sets a luvio.ttl to 15 seconds and omits luvio.opaque and luvio.key properties.

* --force - forces overwrite of an existing luvio.raml file without asking for confirmation
---

Usage examples

$3

This command processes the api.raml file and creates a luvio.raml file in the same directory.

$ ldscli lds:generate ./api.raml

The CLI returns a series of prompts similar to the following:

``----------------------- Define Type Annotations -----------------------

TodoList ========== ? How often does this data change? (Use arrow keys) Every second Every 5 seconds ❯ Every 15 seconds Every minute Every 5 minutes Every 15 minutes ? Should this type be stored as a blob? (luvio will not normalize its properties) (Y/n) ? Select the luvio.key properties (Press to select, to toggle all, to invert selection) ❯◯ items`

`Future enhancements`

* Partial processing of an api.ramlfile (i.e., user-chosen resources to process) * Ability to save and resume progress

sfdx lds:generate [-d] [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

generates luvio.raml from supplied api.raml

ARGUMENTS APIRAMLPATH Location of api.raml used for generating luvio.raml

DESCRIPTION generates luvio.raml from supplied api.raml

EXAMPLES $ ldscli lds:generate [apiRamlPath]`

_See code: src/commands/lds/generate.ts_

`LDS Luvio.raml Wizard`

The LDS wizard is an SDFX command that automatically creates a functional luvio.raml from an existing api.raml.

For more information on RAML and how Luvio uses it, please refer to the Luvio documentation (https://luvio-docs.herokuapp.com/guide/quick-start#raml-overview).

Invoke the CLI with the following command:

$ ldscli lds:generate ./api.raml

The wizard asks a series of questions to determine certain output features of luvio.raml and generates a luvio.raml file to the same directory as the input api.raml file.

`Arguments`

- a positional argument to denote the location of the input api.raml file

* --defaults - uses default values for luvio.raml type annotations. This argument sets a luvio.ttl to 15 seconds and omits luvio.opaque and luvio.key properties.

* --force - forces overwrite of an existing luvio.raml file without asking for confirmation ---

`Usage examples`

`$3`

This command processes the api.raml file and creates a luvio.raml file in the same directory.

$ ldscli lds:generate ./api.raml

The CLI returns a series of prompts similar to the following:

`` ----------------------- Define Type Annotations -----------------------

TodoList ========== ? How often does this data change? (Use arrow keys) Every second Every 5 seconds ❯ Every 15 seconds Every minute Every 5 minutes Every 15 minutes ? Should this type be stored as a blob? (luvio will not normalize its properties) (Y/n) ? Select the luvio.key properties (Press to select, to toggle all, to invert selection) ❯◯ items `