Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 0 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -407,40 +407,3 @@ However, you can configure your own rules from the [ruleset available on the Red
## Running the Arazzo Specification

For now, I recommend using the [Redocly CLI](https://redocly.com/redocly-cli) to [run your Arazzo Workflows](https://redocly.com/learn/arazzo/testing-arazzo-workflows).

### Here be Dragons

To run the generated Arazzo Specification, you can call the plugin from the CLI like:

```bash
serverless arazzo run
```

Options:

```
--source -s The default Arazzo Specification source file. Default: arazzo.json
--input -i The file containign input variables to run the Workflow steps. Default: input.json
```

### Input file

The input file is where you keep your variables that you wish to use within your workflow and should be a json file structured like:

```json
{
"worflowId1": {
"name": "Jared"
}
}
```

The file should contain objects for each workflow, by workflowId, with the variables matching up to the inputs that you defined in your workflow [inputs](#inputs) schema.

This file is likely to be comitted to your repository, so you should not store secrets in the file, instead you might use something like [jq](https://jqlang.org/) that can take repository variables and insert them into your input file:

```bash
jq --arg password "$secret_password" '.workflowId1.password = $password' input.json
```

Obviously, if you have a lot of secret variables that need adding as inputs, then you might need to write a script that can alter the `input.json` file for you within your CI/CD runner.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "serverless-arazzo-workflows",
"version": "0.0.8",
"version": "0.0.9",
"description": "Document your Serverless Framework API workflows with the OpenAPI Arazzo Workflow Spec",
"main": "index.js",
"scripts": {
Expand Down
72 changes: 0 additions & 72 deletions resources/rules.peggy

This file was deleted.

Loading