Skip to content

Commit 5833d3a

Browse files
committed
- Update references in documentation for type action to point to the correct schema.
- Modify `fileTypes` description in config schema for clarity. - Adjust `httpRequest` type definition for consistency. - Add new `type` schema documentation with detailed examples.
1 parent ece676f commit 5833d3a

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

docs/get-started/actions/find.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You can specify the target element directly using a string (for simple text or s
2323
- `timeout`: (Optional) Maximum duration in milliseconds to wait for the element to exist (default: 5000).
2424
- `moveTo`: (Optional) Move the cursor to the element. If the element isn't visible, it's scrolled into view (default: `true`).
2525
- `click`: (Optional) Click the element after finding it. Can be `true` (for a default left click), `"left"`, `"right"`, `"middle"`, or an object like `{ "button": "right" }`.
26-
- `type`: (Optional) Type keys after finding the element. Requires the element to be made active first (e.g., by using `click: true`). Accepts a string or an object like `{ "keys": "my text", "inputDelay": 100 }`. See [`typeKeys`](/docs/references/schemas/typeKeys) for details.
26+
- `type`: (Optional) Type keys after finding the element. Requires the element to be made active first (e.g., by using `click: true`). Accepts a string or an object like `{ "keys": "my text", "inputDelay": 100 }`. See [`type`](type) for details.
2727

2828
**Setting Variables:** To capture a found element's attributes into variables for later steps, use the step-level `variables` object. You can assign values based on the element using expressions like `$$element.text`.
2929

docs/get-started/actions/type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can specify the keys to type in several ways:
1919
- `keys`: (Required) A string or an array of strings representing the keys to type.
2020
- `inputDelay`: (Optional) Delay in milliseconds between each key press. Useful for making recordings more legible.
2121

22-
> For comprehensive options, see the [`type`](/docs/references/schemas/typeKeys) reference.
22+
> For comprehensive options, see the [`type`](/docs/references/schemas/type) reference.
2323
2424
## Special keys
2525

docs/references/schemas/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ afterAll | One of<br/>-&nbsp;string<br/>-&nbsp;array of string | Optional. Path
1919
detectSteps | boolean | Optional. Whether or not to detect steps in input files based on defined markup. | `true`
2020
logLevel | string | Optional. Amount of detail to output when performing an operation.<br/><br/>Accepted values: `silent`, `error`, `warning`, `info`, `debug` | `info`
2121
runOn | array of object([context](/docs/references/schemas/context)) | Optional. Contexts to run the test in. Overrides contexts defined at the config and spec levels. |
22-
fileTypes | array of <br/>one of:<br/>- string<br/>-&nbsp;object([Custom](/docs/references/schemas/Custom))<br/>-&nbsp;object([Executable](/docs/references/schemas/Executable)) | Optional. Configuration for file types and their markup detection. | []
22+
fileTypes | array of <br/>one of:<br/>- string<br/>-&nbsp;object | Optional. Configuration for file types and their markup detection. | []
2323
integrations | object | Optional. Options for connecting to external services. |
2424
integrations.openApi | array of unknown | Optional. No description provided. |
2525
telemetry | object | Optional. Options around sending telemetry for Doc Detective usage. | ``{"send":true}``

docs/references/schemas/step.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ checkLink | One of<br/>-&nbsp;string<br/>-&nbsp;object | Optional. No descripti
1515
click | One of<br/>-&nbsp;string([Find element (simple)](/docs/references/schemas/Find element (simple)))<br/>-&nbsp;object([Click element (detailed)](/docs/references/schemas/Click element (detailed)))<br/>-&nbsp;boolean | Optional. Click or tap an element. |
1616
find | One of<br/>-&nbsp;string([Find element (simple)](/docs/references/schemas/Find element (simple)))<br/>-&nbsp;object([Find element (detailed)](/docs/references/schemas/Find element (detailed))) | Optional. Find an element based on display text or a selector, then optionally interact with it. |
1717
goTo | One of<br/>-&nbsp;string<br/>-&nbsp;object | Optional. No description provided. |
18-
httpRequest | One of<br/>-&nbsp;string([URL](/docs/references/schemas/URL))<br/>-&nbsp;object | Optional. Perform a generic HTTP request, for example to an API. |
18+
httpRequest | One of<br/>-&nbsp;string(URL)<br/>-&nbsp;object | Optional. Perform a generic HTTP request, for example to an API. |
1919
runShell | One of<br/>-&nbsp;string<br/>-&nbsp;object | Optional. Perform a native shell command. |
2020
runCode | object | Optional. Assemble and run code. |
2121
runCode.language | string | Optional. Language of the code to run.<br/><br/>Accepted values: `python`, `bash`, `javascript` |

docs/references/schemas/typeKeys.md renamed to docs/references/schemas/type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# typeKeys
2+
# type
33

44
Type keys. To type special keys, begin and end the string with `$` and use the special key's keyword. For example, to type the Escape key, enter `$ESCAPE$`.
55

0 commit comments

Comments
 (0)