Skip to content

Commit a19c782

Browse files
Copilothawkeyexl
andcommitted
Initial plan for schema reference builder enhancement
Co-authored-by: hawkeyexl <[email protected]>
1 parent 6e0b8b6 commit a19c782

File tree

3 files changed

+57
-2
lines changed

3 files changed

+57
-2
lines changed

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 | Optional. Configuration for file types and their markup detection. | []
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. | []
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)<br/>-&nbsp;object | Optional. Perform a generic HTTP request, for example to an API. |
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. |
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` |
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
2+
# typeKeys
3+
4+
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$`.
5+
6+
## Fields
7+
8+
Field | Type | Description | Default
9+
:-- | :-- | :-- | :--
10+
keys | One of<br/>-&nbsp;string<br/>-&nbsp;array of string | Optional. Sequence of keys to enter. |
11+
inputDelay | number | Optional. Delay in milliseconds between each key press during a recording | `100`
12+
selector | string | Optional. Selector for the element to type into. If not specified, the typing occurs in the active element. |
13+
14+
## Examples
15+
16+
```json
17+
"kittens"
18+
```
19+
20+
```json
21+
[
22+
"$ENTER$"
23+
]
24+
```
25+
26+
```json
27+
[
28+
"kittens",
29+
"$ENTER$"
30+
]
31+
```
32+
33+
```json
34+
{
35+
"keys": "kittens"
36+
}
37+
```
38+
39+
```json
40+
{
41+
"keys": [
42+
"$ENTER$"
43+
]
44+
}
45+
```
46+
47+
```json
48+
{
49+
"keys": [
50+
"kittens",
51+
"$ENTER$"
52+
],
53+
"inputDelay": 500
54+
}
55+
```

0 commit comments

Comments
 (0)