Skip to content

Commit 778dcb1

Browse files
committed
Updated all schema references
1 parent 698c0cb commit 778dcb1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+179
-932
lines changed

docs/get-started/actions/checkLink.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can specify the target URL directly as a string, or use an object for more o
1717
- `origin`: (Optional) Protocol and domain prepended to `url` when `url` is a path. If omitted and `url` is a path, the global `origin` from the configuration file is used.
1818
- `statusCodes`: (Optional) A single integer or an array of integers representing acceptable HTTP status codes. If omitted, defaults to `[200, 301, 302, 307, 308]`.
1919

20-
> For comprehensive options, see the [`checkLink`](/docs/references/schemas/checkLink) reference.
20+
> For comprehensive options, see the [`checkLink`](/docs/references/schemas/checklink) reference.
2121
2222
## Examples
2323

docs/get-started/actions/goTo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can specify the target URL directly as a string, or use an object for more o
1818
- `url`: (Required) The URL to navigate to. Can be a full URL, a path, or a variable reference.
1919
- `origin`: (Optional) Protocol and domain prepended to `url` when `url` is a path. Overrides the global `origin` if set.
2020

21-
> For comprehensive options, see the [`goTo`](/docs/references/schemas/goTo) reference.
21+
> For comprehensive options, see the [`goTo`](/docs/references/schemas/goto) reference.
2222
2323
## Examples
2424

docs/get-started/actions/httpRequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ You can specify a simple GET request using a string shorthand or use an object f
3333
- `useExample`: (Optional) Use example data from the OpenAPI spec (`request`, `response`, or `both`).
3434
- `exampleKey`: (Optional) Key of the specific example to use if multiple exist.
3535
*Note: Properties like `request.headers`, `request.parameters`, `request.body` can override values from the OpenAPI definition or example.*
36-
- *Output Saving:* You can also save the response body using `path`, `directory`, `maxVariation`, and `overwrite` properties. See the [`httpRequest`](/docs/references/schemas/httpRequest) reference for details.
36+
- *Output Saving:* You can also save the response body using `path`, `directory`, `maxVariation`, and `overwrite` properties. See the [`httpRequest`](/docs/references/schemas/httprequest) reference for details.
3737

3838
**Setting Variables:** To capture parts of the response for later steps, use the step-level `variables` object. You can assign values based on the response using expressions like `$$response.body`, `$$response.headers`, `$$response.status`, etc. You can use dot notation for nested JSON fields (e.g., `$$response.body.user.id`).
3939

40-
> For comprehensive options, see the [`httpRequest`](/docs/references/schemas/httpRequest) reference.
40+
> For comprehensive options, see the [`httpRequest`](/docs/references/schemas/httprequest) reference.
4141
4242
## Examples
4343

docs/get-started/actions/loadVariables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `loadVariables` action loads environment variables from a specified `.env` f
1313

1414
> You can also load globally applicable variables using the `loadVariables` property in the configuration file. This makes them available across all tests.
1515
>
16-
> For comprehensive options, see the [`loadVariables`](/docs/references/schemas/loadVariables) reference.
16+
> For comprehensive options, see the [`loadVariables`](/docs/references/schemas/loadvariables) reference.
1717
1818
## Example
1919

docs/get-started/actions/record.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You can specify the recording action in several ways:
2424

2525
**Stopping the Recording:** You *must* include a `stopRecord` step later in your test to finalize and save the video file.
2626

27-
> For comprehensive options, see the [`record`](/docs/references/schemas/record) and [`stopRecord`](/docs/references/schemas/stopRecord) references.
27+
> For comprehensive options, see the [`record`](/docs/references/schemas/record) and [`stopRecord`](/docs/references/schemas/stoprecord) references.
2828
2929
## Examples
3030

docs/get-started/actions/runCode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ You must specify the `runCode` action using an object format with the following
2525
- `timeout`: (Optional) Maximum duration in milliseconds to wait for the code execution to complete.
2626
- `exitCodes`: (Optional) An array of acceptable exit codes. If the code execution's exit code is not in this list, the step fails (default: `[0]`).
2727
- `stdio`: (Optional) A string or regular expression to validate against the code's combined stdout and stderr. If the output doesn't match, the step fails. Regex must start and end with `/` (e.g., `/^hello world.*/`).
28-
- *Output Saving:* You can also save the code's output using `path`, `directory`, `maxVariation`, and `overwrite` properties. See the [`runCode`](/docs/references/schemas/runCode) reference for details.
28+
- *Output Saving:* You can also save the code's output using `path`, `directory`, `maxVariation`, and `overwrite` properties. See the [`runCode`](/docs/references/schemas/runcode) reference for details.
2929

3030
**Setting Variables:** To capture output into variables for later steps, use the step-level `variables` object. You can assign values based on the code's output using expressions like `$$stdio.stdout`, `$$stdio.stderr`, or `$$exitCode`.
3131

32-
> For comprehensive options, see the [`runCode`](/docs/references/schemas/runCode) reference.
32+
> For comprehensive options, see the [`runCode`](/docs/references/schemas/runcode) reference.
3333
3434
## Examples
3535

docs/get-started/actions/runShell.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ You can specify the command directly as a string or use an object for more optio
2323
- `timeout`: (Optional) Maximum duration in milliseconds to wait for the command to complete.
2424
- `exitCodes`: (Optional) An array of acceptable exit codes. If the command's exit code is not in this list, the step fails (default: `[0]`).
2525
- `stdio`: (Optional) A string or regular expression to validate against the command's combined stdout and stderr. If the output doesn't match, the step fails. Regex must start and end with `/` (e.g., `/^hello world.*/`).
26-
- *Output Saving:* You can also save the command's output using `path`, `directory`, `maxVariation`, and `overwrite` properties. See the [`runShell`](/docs/references/schemas/runShell) reference for details.
26+
- *Output Saving:* You can also save the command's output using `path`, `directory`, `maxVariation`, and `overwrite` properties. See the [`runShell`](/docs/references/schemas/runshell) reference for details.
2727

2828
**Setting Variables:** To capture output into variables for later steps, use the step-level `variables` object. You can assign values based on the code's output using expressions like `$$stdio.stdout`, `$$stdio.stderr`, or `$$exitCode`.
2929

30-
> For comprehensive options, see the [`runShell`](/docs/references/schemas/runShell) reference.
30+
> For comprehensive options, see the [`runShell`](/docs/references/schemas/runshell) reference.
3131
3232
## Examples
3333

docs/get-started/actions/stopRecord.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This action takes a simple boolean value:
1717

1818
>Note: You must include a `stopRecord: true` step to finalize and save any recording started with the `record` action.
1919
>
20-
> For comprehensive options, see the [`stopRecord`](/docs/references/schemas/stopRecord) reference.
20+
> For comprehensive options, see the [`stopRecord`](/docs/references/schemas/stoprecord) reference.
2121
2222
## Example
2323

docs/references/schemas/Common.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/references/schemas/Custom.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)