Skip to content

Commit d06d7fa

Browse files
hawkeyexlhawkeyexl
committed
Built references
1 parent 4aa5e42 commit d06d7fa

Some content is hidden

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

49 files changed

+895
-639
lines changed

‎docs/references/schemas/Browser Viewport.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
# Browser Viewport
3+
4+
Viewport dimensions.
5+
6+
## Referenced In
7+
8+
- [Browser](/docs/references/schemas/Browser)
9+
10+
## Fields
11+
12+
Field | Type | Description | Default
13+
:-- | :-- | :-- | :--
14+
width | integer | Optional. Width of the viewport in pixels. |
15+
height | integer | Optional. Height of the viewport in pixels. |
16+
17+
## Examples
18+
19+
```json
20+
{
21+
"width": 42,
22+
"height": 42
23+
}
24+
```

‎docs/references/schemas/Browser Window.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
# Browser Window
3+
4+
Browser dimensions.
5+
6+
## Referenced In
7+
8+
- [Browser](/docs/references/schemas/Browser)
9+
10+
## Fields
11+
12+
Field | Type | Description | Default
13+
:-- | :-- | :-- | :--
14+
width | integer | Optional. Width of the browser window in pixels. |
15+
height | integer | Optional. Height of the browser window in pixels. |
16+
17+
## Examples
18+
19+
```json
20+
{
21+
"width": 42,
22+
"height": 42
23+
}
24+
```

‎docs/references/schemas/Browser.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
# Browser
3+
4+
Browser configuration.
5+
6+
## Referenced In
7+
8+
- [context](/docs/references/schemas/context)
9+
- [Resolved context](/docs/references/schemas/Resolved context)
10+
11+
## Fields
12+
13+
Field | Type | Description | Default
14+
:-- | :-- | :-- | :--
15+
name | string | Required. Name of the browser.<br/><br/>Accepted values: `chrome`, `firefox`, `safari`, `webkit` |
16+
headless | boolean | Optional. If `true`, runs the browser in headless mode. | `true`
17+
window | object([Browser Window](/docs/references/schemas/Browser Window)) | Optional. Browser dimensions. |
18+
viewport | object([Browser Viewport](/docs/references/schemas/Browser Viewport)) | Optional. Viewport dimensions. |
19+
20+
## Examples
21+
22+
```json
23+
{
24+
"name": "chrome",
25+
"headless": true,
26+
"window": {
27+
"width": 42,
28+
"height": 42
29+
},
30+
"viewport": {
31+
"width": 42,
32+
"height": 42
33+
}
34+
}
35+
```

‎docs/references/schemas/Capture screenshot (detailed).md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# Capture screenshot (detailed)
3+
4+
5+
6+
## Referenced In
7+
8+
- [screenshot](/docs/references/schemas/screenshot)
9+
10+
## Fields
11+
12+
Field | Type | Description | Default
13+
:-- | :-- | :-- | :--
14+
path | string | Optional. File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.<br/><br/>Pattern: `([A-Za-z0-9_-]*\.(png|PNG)$|\$[A-Za-z0-9_]+)` |
15+
directory | string | Optional. Directory of the PNG file. If the directory doesn't exist, creates the directory. |
16+
maxVariation | number | Optional. Allowed variation in percentage of pixels between the new screenshot and the existing screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, this value is ignored.<br/><br/>Minimum: 0. Maximum: 1 | `0.05`
17+
overwrite | string | Optional. If `true`, overwrites the existing screenshot at `path` if it exists.
18+
If `aboveVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.<br/><br/>Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation`
19+
crop | one of:<br/>- string<br/>- object([Crop by element (detailed)](/docs/references/schemas/Crop by element (detailed))) | Optional. No description provided. |
20+
21+
## Examples
22+
23+
```json
24+
{
25+
"path": "example",
26+
"directory": "example",
27+
"maxVariation": 0.05,
28+
"overwrite": "aboveVariation",
29+
"crop": "example"
30+
}
31+
```

‎docs/references/schemas/Check link (detailed).md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
# Check link (detailed)
3+
4+
Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.
5+
6+
## Referenced In
7+
8+
- [checkLink](/docs/references/schemas/checkLink)
9+
10+
## Fields
11+
12+
Field | Type | Description | Default
13+
:-- | :-- | :-- | :--
14+
url | string | Required. URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified.<br/><br/>Pattern: `(^(http://|https://|/).*|\$[A-Za-z0-9_]+)` |
15+
origin | string | Optional. Protocol and domain to navigate to. Prepended to `url`. |
16+
statusCodes | one of:<br/>- integer<br/>- array of integer | Optional. Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails. | ``[200,301,302,307,308]``
17+
18+
## Examples
19+
20+
```json
21+
{
22+
"url": "example",
23+
"origin": "example",
24+
"statusCodes": [
25+
200,
26+
301,
27+
302,
28+
307,
29+
308
30+
]
31+
}
32+
```

‎docs/references/schemas/Click element (detailed).md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,8 @@
55

66
## Referenced In
77

8-
- [fileTypes-anyOf[0]-array-anyOf[1]-markup-array-actions-anyOf[1]-array-anyOf[1]-anyOf[1]-allOf[1]-13cd754d](/docs/references/schemas/filetypes-anyof-0--array-anyof-1--markup-array-actions-anyof-1--array-anyof-1--anyof-1--allof-1--13cd754d)
8+
- [click](/docs/references/schemas/click)
99
- [Find element (detailed)](/docs/references/schemas/Find element (detailed))
10-
- [tests-array-anyOf[0]-steps-array-anyOf[1]-allOf[1]-13cd754d](/docs/references/schemas/tests-array-anyof-0--steps-array-anyof-1--allof-1--13cd754d)
11-
- [tests-array-anyOf[0]-contexts-array-steps-array-anyOf[1]-allOf[1]-13cd754d](/docs/references/schemas/tests-array-anyof-0--contexts-array-steps-array-anyof-1--allof-1--13cd754d)
12-
- [anyOf[1]-allOf[1]-13cd754d](/docs/references/schemas/anyof-1--allof-1--13cd754d)
1310

1411
## Fields
1512

‎docs/references/schemas/Common.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
# Common
3+
4+
5+
6+
## Referenced In
7+
8+
- [Markup definition](/docs/references/schemas/Markup definition)
9+
- [test](/docs/references/schemas/test)
10+
- [Resolved context](/docs/references/schemas/Resolved context)
11+
12+
## Fields
13+
14+
Field | Type | Description | Default
15+
:-- | :-- | :-- | :--
16+
stepId | string | Optional. ID of the step. |
17+
description | string | Optional. Description of the step. |
18+
outputs | object(Outputs (step)) | Optional. Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence. | ``{}``
19+
variables | object(Variables (step)) | Optional. Environment variables to set from user-defined expressions. | ``{}``
20+
21+
## Examples
22+
23+
```json
24+
{
25+
"stepId": "example",
26+
"description": "example",
27+
"outputs": {},
28+
"variables": {}
29+
}
30+
```

‎docs/references/schemas/Crop by element (detailed).md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,15 @@ Crop the screenshot to a specific element.
55

66
## Referenced In
77

8-
- [fileTypes-anyOf[0]-array-anyOf[1]-markup-array-actions-anyOf[1]-array-anyOf[1]-anyOf[8]-allOf[1]-screenshot-anyOf[1]-34b48f9b](/docs/references/schemas/filetypes-anyof-0--array-anyof-1--markup-array-actions-anyof-1--array-anyof-1--anyof-8--allof-1--screenshot-anyof-1--34b48f9b)
9-
- [anyOf[1]-34b48f9b](/docs/references/schemas/anyof-1--34b48f9b)
10-
- [tests-array-anyOf[0]-steps-array-anyOf[8]-allOf[1]-screenshot-anyOf[1]-34b48f9b](/docs/references/schemas/tests-array-anyof-0--steps-array-anyof-8--allof-1--screenshot-anyof-1--34b48f9b)
11-
- [tests-array-anyOf[0]-contexts-array-steps-array-anyOf[8]-allOf[1]-screenshot-anyOf[1]-34b48f9b](/docs/references/schemas/tests-array-anyof-0--contexts-array-steps-array-anyof-8--allof-1--screenshot-anyof-1--34b48f9b)
12-
- [anyOf[8]-allOf[1]-screenshot-anyOf[1]-34b48f9b](/docs/references/schemas/anyof-8--allof-1--screenshot-anyof-1--34b48f9b)
8+
- [Capture screenshot (detailed)](/docs/references/schemas/Capture screenshot (detailed))
139

1410
## Fields
1511

1612
Field | Type | Description | Default
1713
:-- | :-- | :-- | :--
1814
elementText | string | Optional. Display text of the element to screenshot. |
1915
selector | string | Optional. Selector of the element to screenshot. |
20-
padding | one of:<br/>- number<br/>- object | Optional. No description provided. |
16+
padding | one of:<br/>- number<br/>- object([Padding (detailed)](/docs/references/schemas/Padding (detailed))) | Optional. No description provided. |
2117

2218
## Examples
2319

‎docs/references/schemas/Environment details.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
# Environment details
3+
4+
Environment information for the system running Doc Detective.
5+
6+
## Referenced In
7+
8+
- [config](/docs/references/schemas/config)
9+
10+
## Fields
11+
12+
Field | Type | Description | Default
13+
:-- | :-- | :-- | :--
14+
workingDirectory | string | Optional. The current working directory of the process running Doc Detective. |
15+
platform | string | Required. The operating system type running Doc Detective.<br/><br/>Accepted values: `linux`, `mac`, `windows` |
16+
arch | string | Optional. The processor architecture of the system running Doc Detective.<br/><br/>Accepted values: `arm32`, `arm64`, `x32`, `x64` |
17+
18+
## Examples
19+
20+
```json
21+
{
22+
"workingDirectory": "example",
23+
"platform": "linux",
24+
"arch": "arm32"
25+
}
26+
```

‎docs/references/schemas/File type (custom).md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
# File type (custom)
3+
4+
5+
6+
## Referenced In
7+
8+
- [config](/docs/references/schemas/config)
9+
10+
## Fields
11+
12+
Field | Type | Description | Default
13+
:-- | :-- | :-- | :--
14+
name | string | Optional. Name of the file type. |
15+
extends | string | Optional. Base template to extend.<br/><br/>Accepted values: `markdown`, `asciidoc`, `html` |
16+
extensions | one of:<br/>- string<br/>- array of string | Required. File extensions to use with type. |
17+
inlineStatements | object([Inline statement definition](/docs/references/schemas/Inline statement definition)) | Optional. Statements to include tests and steps inside the content of the file, such as within Markdown. |
18+
markup | array of object([Markup definition](/docs/references/schemas/Markup definition)) | Optional. Markup definitions for the file type. |
19+
20+
## Examples
21+
22+
```json
23+
{
24+
"name": "example",
25+
"extends": "markdown",
26+
"inlineStatements": {},
27+
"markup": []
28+
}
29+
```

0 commit comments

Comments
 (0)