TerribleDev/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify what curly brackets are. Other minor updates and clarifications.

Browse Source
This commit is contained in:
Ross McDonald
2018-02-02 16:45:47 -06:00
parent 7285d7a9e1
commit fe5e946afe
2 changed files with 19 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
articles/testing/variables-context.md
View File

@@ -64,19 +64,18 @@ To reference a context variable in a scenario, use the following syntax:
Where:
* `{...}` - Curly brackets signify that this is a variable reference. See the
[variables overview](./variables-overview.md) section for more information on
how variables are used.
* `{...}` - Braces signify that this is a variable reference. See the [variables
overview](./variables-overview.md) section for more information on how
variables are used.
* `$` - The "single dollar sign" syntax is a reference to the current scenario's
"context".
* `ctx` - Every scenario context has an `ctx` property that signifies this being
a reference to the editor's environment.
* `myVariable` - This is the variable being referenced, which comes from the
project's `.stoplight.yml` file. Substitute your own variable name when using
this in a scenario.
runtime scope.
* `ctx` - Every scenario step has a `ctx` property that allows access to the
runtime context (where variables can be stored for later use).
* `myVariable` - This is the variable being referenced within the context.
When the scenario or step is run, any environment variable references will
automatically be populated based on the editor's current environment.
When the scenario or step is run, any context variable references will
automatically be populated based on the contents of the scenario context at
runtime.
### In Scripts
@@ -87,7 +86,7 @@ script, use the following syntax:
$.ctx.get('myVariable');
```
Where the curly brackets are absent, and we are using the `get()` method for
Where the braces (`{}`) are absent, and we are using the `get()` method for
retrieving the context variable under the `myVariable` key.
***

12
articles/testing/variables-environment.md
View File

@@ -36,6 +36,10 @@ Where the `$$.env.set(x, y)` function adds the data referenced in the second
argument (`y`) to the environment under the string value of the first argument
(`x`).
> Environment variables set via script are only added to the user's private
variables, and are not sent to Stoplight. See the [Environment
section](../editor/environments.md) for more information.
## Referencing Environment Variables
<!--(FIXME - SHOW USING A VARIABLE IN A SCENARIO STEP)-->
@@ -48,9 +52,9 @@ To reference an environment variable in a scenario, use the following syntax:
Where:
* `{...}` - Curly brackets signify that this is a variable reference. See the
[variables overview](./variables-overview.md) section for more information on
how variables are used.
* `{...}` - Braces signify that this is a variable reference. See the [variables
overview](./variables-overview.md) section for more information on how
variables are used.
* `$$` - The "double dollar sign" syntax is a reference to the scenario's global
scope.
* `env` - Every scenario has a global `env` property that signifies this being a
@@ -71,7 +75,7 @@ script, use the following syntax:
$$.env.get('myVariable');
```
Where the curly brackets are absent, and we are using the `get()` method for
Where the braces (`{}`) are absent, and we are using the `get()` method for
retrieving the environment variable under the `myVariable` key.
***