First implementation of schema reference builder changes for v3 schemas

Co-authored-by: hawkeyexl <[email protected]>

Author: Copilot

.scripts/buildSchemaReferencesV3.js

@@ -7,9 +7,10 @@
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-url | string |  Optional. URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified. | 
-origin | string |  Optional. Protocol and domain to navigate to. Prepended to `url`. | 
-statusCodes | One of<br/>-&nbsp;integer<br/>-&nbsp;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]``
+url | string | Required. URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified. | 
+origin | string | Optional. Protocol and domain to navigate to. Prepended to `url`. | 
+statusCodes | integer | Optional. No description provided. | 
+statusCodes | array of integer | Optional. No description provided. | 
 
 ## Examples
 

docs/references/schemas/checkLink.md

@@ -7,9 +7,9 @@ Click or tap an element.
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-button | string |  Optional. Kind of click to perform.<br/><br/>Accepted values: `left`, `right`, `middle` | 
-elementText | string |  Optional. Display text of the element to click. If combined with `selector`, the element must match both the text and the selector. | 
-selector | string |  Optional. Selector of the element to click. If combined with `elementText`, the element must match both the text and the selector. | 
+button | string | Optional. Kind of click to perform.<br/><br/>Accepted values: `left`, `right`, `middle` | 
+elementText | string | Optional. Display text of the element to click. If combined with `selector`, the element must match both the text and the selector. | 
+selector | string | Optional. Selector of the element to click. If combined with `elementText`, the element must match both the text and the selector. | 
 
 ## Examples
 

docs/references/schemas/click.md

@@ -7,24 +7,26 @@ Configuration options for Doc Detective operations.
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-configId | string |  Optional. Identifier for the configuration. | Generated UUID
-input | unknown |  Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | `.`
-output | string |  Optional. Path of the directory in which to store the output of Doc Detective commands. If a file path is specified, Doc Detective attempts to honor the file name specified, but file path behavior is controlled by the configured reporters. | `.`
-recursive | boolean |  Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files. | `true`
-relativePathBase | string |  Optional. Whether paths should be interpreted as relative to the current working directory (`cwd`) or to the file in which they're specified (`file`).<br/><br/>Accepted values: `cwd`, `file` | `file`
-loadVariables | string |  Optional. Load environment variables from the specified `.env` file. | 
-origin | string |  Optional. Default protocol and domain to use for relative URLs. | 
-beforeAny | One of<br/>-&nbsp;string<br/>-&nbsp;array of string |  Optional. Path(s) to test specifications to perform before those specified by `input`. Useful for setting up testing environments. | 
-afterAll | One of<br/>-&nbsp;string<br/>-&nbsp;array of string |  Optional. Path(s) to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments. | 
-detectSteps | boolean |  Optional. Whether or not to detect steps in input files based on defined markup. | `true`
-logLevel | string |  Optional. Amount of detail to output when performing an operation.<br/><br/>Accepted values: `silent`, `error`, `warning`, `info`, `debug` | `info`
-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. | 
-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. | []
-integrations | object |  Optional. Options for connecting to external services. | 
-integrations.openApi | array of unknown |  Optional. No description provided. | 
-telemetry | object |  Optional. Options around sending telemetry for Doc Detective usage. | ``{"send":true}``
-telemetry.send | boolean |  Required. If `true`, sends Doc Detective telemetry. | `true`
-telemetry.userId | string |  Optional. Identifier for the organization, group, or individual running Doc Detective. | 
+configId | string | Optional. Identifier for the configuration. | 
+input | unknown | Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | `.`
+output | string | Optional. Path of the directory in which to store the output of Doc Detective commands. If a file path is specified, Doc Detective attempts to honor the file name specified, but file path behavior is controlled by the configured reporters. | `.`
+recursive | boolean | Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files. | `true`
+relativePathBase | string | Optional. Whether paths should be interpreted as relative to the current working directory (`cwd`) or to the file in which they're specified (`file`).<br/><br/>Accepted values: `cwd`, `file` | `file`
+loadVariables | string | Optional. Load environment variables from the specified `.env` file. | 
+origin | string | Optional. Default protocol and domain to use for relative URLs. | 
+beforeAny | string | Optional. No description provided. | 
+beforeAny | array of string | Optional. No description provided. | 
+afterAll | string | Optional. No description provided. | 
+afterAll | array of string | Optional. No description provided. | 
+detectSteps | boolean | Optional. Whether or not to detect steps in input files based on defined markup. | `true`
+logLevel | string | Optional. Amount of detail to output when performing an operation.<br/><br/>Accepted values: `silent`, `error`, `warning`, `info`, `debug` | `info`
+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. | 
+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. No description provided. | 
+integrations | object | Optional. Options for connecting to external services. | 
+integrations.openApi | array of unknown | Optional. No description provided. | 
+telemetry | object | Optional. Options around sending telemetry for Doc Detective usage. | ``{"send":true}``
+telemetry.send | boolean | Required. If `true`, sends Doc Detective telemetry. | `true`
+telemetry.userId | string | Optional. Identifier for the organization, group, or individual running Doc Detective. | 
 
 ## Examples
 

docs/references/schemas/config.md

@@ -7,17 +7,24 @@ A context in which to perform tests. If no contexts are specified but a context
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-contextId | string |  Optional. Unique identifier for the context. | Generated UUID
-platforms | One of<br/>-&nbsp;string<br/>-&nbsp;array of string |  Optional. Platforms to run tests on. | 
-browsers | One of<br/>-&nbsp;string<br/>-&nbsp;object<br/>-&nbsp;array of <br/>&nbsp;&nbsp;one of:<br/>&nbsp;&nbsp;- string<br/>&nbsp;&nbsp;- object |  Optional. Browsers to run tests on. | 
-browsers.name | string |  Required. Name of the browser.<br/><br/>Accepted values: `chrome`, `firefox`, `safari`, `webkit` | 
-browsers.headless | boolean |  Optional. If `true`, runs the browser in headless mode. | `true`
-browsers.window | object |  Optional. Browser dimensions. | 
-browsers.window.width | integer |  Optional. Width of the browser window in pixels. | 
-browsers.window.height | integer |  Optional. Height of the browser window in pixels. | 
-browsers.viewport | object |  Optional. Viewport dimensions. | 
-browsers.viewport.width | integer |  Optional. Width of the viewport in pixels. | 
-browsers.viewport.height | integer |  Optional. Height of the viewport in pixels. | 
+contextId | string | Optional. Unique identifier for the context. | 
+platforms | string | Optional. No description provided.<br/><br/>Accepted values: `linux`, `mac`, `windows` | 
+platforms | array of string | Optional. No description provided. | 
+browsers | string | Optional. Name of the browser.<br/><br/>Accepted values: `chrome`, `firefox`, `safari`, `webkit` | 
+browsers | object | Optional. Browser configuration. | 
+browsers.name | string | Required. Name of the browser.<br/><br/>Accepted values: `chrome`, `firefox`, `safari`, `webkit` | 
+browsers.headless | boolean | Optional. If `true`, runs the browser in headless mode. | `true`
+browsers.window | object | Optional. Browser dimensions. | 
+browsers.window.width | integer | Optional. Width of the browser window in pixels. | 
+browsers.window.height | integer | Optional. Height of the browser window in pixels. | 
+browsers.viewport | object | Optional. Viewport dimensions. | 
+browsers.viewport.width | integer | Optional. Width of the viewport in pixels. | 
+browsers.viewport.height | integer | Optional. Height of the viewport in pixels. | 
+browsers | array of <br/>one of:<br/>- string<br/>- object | Optional. No description provided. | 
+browsers[].name | string | Required. Name of the browser.<br/><br/>Accepted values: `chrome`, `firefox`, `safari`, `webkit` | 
+browsers[].headless | boolean | Optional. If `true`, runs the browser in headless mode. | `true`
+browsers[].window | object | Optional. Browser dimensions. | 
+browsers[].viewport | object | Optional. Viewport dimensions. | 
 
 ## Examples
 

docs/references/schemas/context.md

@@ -7,12 +7,14 @@ Find an element based on display text or a selector, then optionally interact wi
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-elementText | string |  Optional. Display text of the element to find. If combined with `selector`, the element must match both the text and the selector. | 
-selector | string |  Optional. Selector of the element to find. If combined with `elementText`, the element must match both the text and the selector. | 
-timeout | integer |  Optional. Max duration in milliseconds to wait for the element to exist. | `5000`
-moveTo | boolean |  Optional. Move to the element. If the element isn't visible, it's scrolled into view. | `true`
-click | One of<br/>-&nbsp;object([click](/docs/references/schemas/click))<br/>-&nbsp;object |  Optional. Click the element. | 
-type | undefined |  Optional. Type keys after finding the element. Either a string or an object with a `keys` field as defined in [`type`](type). To type in the element, make the element active with the `click` parameter. | 
+elementText | string | Optional. Display text of the element to find. If combined with `selector`, the element must match both the text and the selector. | 
+selector | string | Optional. Selector of the element to find. If combined with `elementText`, the element must match both the text and the selector. | 
+timeout | integer | Optional. Max duration in milliseconds to wait for the element to exist. | `5000`
+moveTo | boolean | Optional. Move to the element. If the element isn't visible, it's scrolled into view. | `true`
+click | object([click](/docs/references/schemas/click)) | Optional. Click or tap an element. | 
+click | object | Optional. No description provided. | 
+click.button | string | Optional. Kind of click to perform.<br/><br/>Accepted values: `left`, `right`, `middle` | 
+type | unknown | Optional. Type keys after finding the element. Either a string or an object with a `keys` field as defined in [`type`](type). To type in the element, make the element active with the `click` parameter. | 
 
 ## Examples
 

docs/references/schemas/find.md

@@ -7,8 +7,8 @@
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-url | string |  Optional. URL to navigate to. Can be a full URL or a path. If a path is provided and `origin` is specified, prepends `origin` to `url`. If a path is provided but `origin` isn't specified, attempts to navigate relative to the current URL, if any. | 
-origin | string |  Optional. Protocol and domain to navigate to. Prepended to `url`. | 
+url | string | Required. URL to navigate to. Can be a full URL or a path. If a path is provided and `origin` is specified, prepends `origin` to `url`. If a path is provided but `origin` isn't specified, attempts to navigate relative to the current URL, if any. | 
+origin | string | Optional. Protocol and domain to navigate to. Prepended to `url`. | 
 
 ## Examples
 

docs/references/schemas/goTo.md

@@ -7,23 +7,27 @@ Perform a generic HTTP request, for example to an API.
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-url | string |  Optional. URL for the HTTP request. | 
-openApi | unknown |  Optional. No description provided. | 
-statusCodes | array of integer |  Optional. Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails. | ``[200,201]``
-method | string |  Optional. Method of the HTTP request<br/><br/>Accepted values: `get`, `put`, `post`, `patch`, `delete` | `get`
-timeout | integer |  Optional. Timeout for the HTTP request, in milliseconds. | `60000`
-request | object |  Optional. No description provided. | 
-request.headers | object |  Optional. Headers to include in the HTTP request, in key/value format. | ``{}``
-request.parameters | object |  Optional. URL parameters to include in the HTTP request, in key/value format. | ``{}``
-request.body | One of<br/>-&nbsp;object<br/>-&nbsp;array of unknown<br/>-&nbsp;string |  Optional. JSON object to include as the body of the HTTP request. | ``{}``
-response | object |  Optional. No description provided. | 
-response.headers | object |  Optional. Headers expected in the response, in key/value format. If one or more `responseHeaders` entries aren't present in the response, the step fails. | ``{}``
-response.body | One of<br/>-&nbsp;object<br/>-&nbsp;array of unknown<br/>-&nbsp;string |  Optional. JSON object expected in the response. If one or more key/value pairs aren't present in the response, the step fails. | ``{}``
-allowAdditionalFields | boolean |  Optional. If `false`, the step fails when the response data contains fields not specified in the response body. | `true`
-path | string |  Optional. File path to save the command's output, relative to `directory`. Specify a file extension that matches the expected response type, such as `.json` for JSON content or `.txt` for strings. | 
-directory | string |  Optional. Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory. | 
-maxVariation | number |  Optional. Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored. | `0`
-overwrite | string |  Optional. If `true`, overwrites the existing output at `path` if it exists.
+url | string | Optional. URL for the HTTP request. | 
+openApi | unknown | Optional. No description provided. | 
+statusCodes | array of integer | Optional. Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails. | ``[200,201]``
+method | string | Optional. Method of the HTTP request<br/><br/>Accepted values: `get`, `put`, `post`, `patch`, `delete` | `get`
+timeout | integer | Optional. Timeout for the HTTP request, in milliseconds. | `60000`
+request | object | Optional. No description provided. | 
+request.headers | object | Optional. Headers to include in the HTTP request, in key/value format. | ``{}``
+request.parameters | object | Optional. URL parameters to include in the HTTP request, in key/value format. | ``{}``
+request.body | object | Optional. No description provided. | 
+request.body | array of unknown | Optional. No description provided. | 
+request.body | string | Optional. No description provided. | 
+response | object | Optional. No description provided. | 
+response.headers | object | Optional. Headers expected in the response, in key/value format. If one or more `responseHeaders` entries aren't present in the response, the step fails. | ``{}``
+response.body | object | Optional. No description provided. | 
+response.body | array of unknown | Optional. No description provided. | 
+response.body | string | Optional. No description provided. | 
+allowAdditionalFields | boolean | Optional. If `false`, the step fails when the response data contains fields not specified in the response body. | `true`
+path | string | Optional. File path to save the command's output, relative to `directory`. Specify a file extension that matches the expected response type, such as `.json` for JSON content or `.txt` for strings. | 
+directory | string | Optional. Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory. | 
+maxVariation | number | Optional. Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored. | `0`
+overwrite | string | Optional. If `true`, overwrites the existing output at `path` if it exists.
 If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.<br/><br/>Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation`
 
 ## Examples

docs/references/schemas/httpRequest.md

@@ -7,9 +7,9 @@ Start recording the current browser viewport. Must be followed by a `stopRecord`
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-path | string |  Optional. File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`. | 
-directory | string |  Optional. Directory of the file. If the directory doesn't exist, creates the directory. | 
-overwrite | string |  Optional. If `true`, overwrites the existing recording at `path` if it exists.<br/><br/>Accepted values: `true`, `false` | 
+path | string | Optional. File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`. | 
+directory | string | Optional. Directory of the file. If the directory doesn't exist, creates the directory. | 
+overwrite | string | Optional. If `true`, overwrites the existing recording at `path` if it exists.<br/><br/>Accepted values: `true`, `false` | 
 
 ## Examples