Fix URL encoding in schema reference links

Copilot · hawkeyexl · Copilot · commit e40757ad5787 · 2025-05-24T13:22:14.000Z
Co-authored-by: hawkeyexl &lt;5209367+hawkeyexl@users.noreply.github.com&gt;
diff --git a/.scripts/buildSchemaReferencesV4.js b/.scripts/buildSchemaReferencesV4.js
@@ -417,7 +417,9 @@ async function main() {
         // For top-level schemas or schemas with titles
         fileName = `${schemaId}.md`;
       }
-      schemaPaths.set(schemaId, `/docs/references/schemas/${fileName.replace('.md', '')}`);
+      const pathWithoutExt = fileName.replace('.md', '');
+      const encodedPath = encodeURIComponent(pathWithoutExt);
+      schemaPaths.set(schemaId, `/docs/references/schemas/${encodedPath}`);
     }
   }
   
diff --git a/docs/references/schemas/Browser.md b/docs/references/schemas/Browser.md
@@ -6,16 +6,16 @@ Browser configuration.
 ## Referenced In
 
 - [context](/docs/references/schemas/context)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
 name | string | Required. Name of the browser.<br/><br/>Accepted values: `chrome`, `firefox`, `safari`, `webkit` | 
 headless | boolean | Optional. If `true`, runs the browser in headless mode. | `true`
-window | object([Browser Window](/docs/references/schemas/Browser Window)) | Optional. Browser dimensions. | 
-viewport | object([Browser Viewport](/docs/references/schemas/Browser Viewport)) | Optional. Viewport dimensions. | 
+window | object([Browser Window](/docs/references/schemas/Browser%20Window)) | Optional. Browser dimensions. | 
+viewport | object([Browser Viewport](/docs/references/schemas/Browser%20Viewport)) | Optional. Viewport dimensions. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/Capture screenshot (detailed).md b/docs/references/schemas/Capture screenshot (detailed).md
@@ -16,7 +16,7 @@ directory | string | Optional. Directory of the PNG file. If the directory doesn
 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`
 overwrite | string | Optional. If `true`, overwrites the existing screenshot at `path` if it exists.
 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`
-crop | one of:<br/>- string<br/>- object([Crop by element (detailed)](/docs/references/schemas/Crop by element (detailed))) | Optional. No description provided. | 
+crop | one of:<br/>- string<br/>- object([Crop by element (detailed)](/docs/references/schemas/Crop%20by%20element%20(detailed))) | Optional. No description provided. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/Click element (detailed).md b/docs/references/schemas/Click element (detailed).md
@@ -6,7 +6,7 @@
 ## Referenced In
 
 - [click](/docs/references/schemas/click)
-- [Find element (detailed)](/docs/references/schemas/Find element (detailed))
+- [Find element (detailed)](/docs/references/schemas/Find%20element%20(detailed))
 
 ## Fields
 
diff --git a/docs/references/schemas/Common.md b/docs/references/schemas/Common.md
@@ -5,9 +5,9 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
diff --git a/docs/references/schemas/Crop by element (detailed).md b/docs/references/schemas/Crop by element (detailed).md
@@ -5,15 +5,15 @@ Crop the screenshot to a specific element.
 
 ## Referenced In
 
-- [Capture screenshot (detailed)](/docs/references/schemas/Capture screenshot (detailed))
+- [Capture screenshot (detailed)](/docs/references/schemas/Capture%20screenshot%20(detailed))
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
 elementText | string | Optional. Display text of the element to screenshot. | 
 selector | string | Optional. Selector of the element to screenshot. | 
-padding | one of:<br/>- number<br/>- object([Padding (detailed)](/docs/references/schemas/Padding (detailed))) | Optional. No description provided. | 
+padding | one of:<br/>- number<br/>- object([Padding (detailed)](/docs/references/schemas/Padding%20(detailed))) | Optional. No description provided. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/File type (custom).md b/docs/references/schemas/File type (custom).md
@@ -14,8 +14,8 @@ Field | Type | Description | Default
 name | string | Optional. Name of the file type. | 
 extends | string | Optional. Base template to extend.<br/><br/>Accepted values: `markdown`, `asciidoc`, `html` | 
 extensions | one of:<br/>- string<br/>- array of string | Required. File extensions to use with type. | 
-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. | 
-markup | array of object([Markup definition](/docs/references/schemas/Markup definition)) | Optional. Markup definitions for the file type. | 
+inlineStatements | object([Inline statement definition](/docs/references/schemas/Inline%20statement%20definition)) | Optional. Statements to include tests and steps inside the content of the file, such as within Markdown. | 
+markup | array of object([Markup definition](/docs/references/schemas/Markup%20definition)) | Optional. Markup definitions for the file type. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/File type (executable).md b/docs/references/schemas/File type (executable).md
@@ -12,6 +12,6 @@
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
 extensions | one of:<br/>- string<br/>- array of string | Required. File extensions to use with type. | 
-runShell | one of:<br/>- string<br/>- object([Run shell command (detailed)](/docs/references/schemas/Run shell command (detailed))) | Optional. `runShell` step to perform for this file type. Use $1 as a placeholder for the file path. | 
+runShell | one of:<br/>- string<br/>- object([Run shell command (detailed)](/docs/references/schemas/Run%20shell%20command%20(detailed))) | Optional. `runShell` step to perform for this file type. Use $1 as a placeholder for the file path. | 
 
 ## Examples
diff --git a/docs/references/schemas/Find element (detailed).md b/docs/references/schemas/Find element (detailed).md
@@ -15,7 +15,7 @@ elementText | string | Optional. Display text of the element to find. If combine
 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/>- one of:<br/>- string<br/>- object([Click element (detailed)](/docs/references/schemas/Click element (detailed)))<br/>- boolean<br/>- object([Find element and click](/docs/references/schemas/Find element and click)) | Optional. Click the element. | 
+click | one of:<br/>- one of:<br/>- string<br/>- object([Click element (detailed)](/docs/references/schemas/Click%20element%20(detailed)))<br/>- boolean<br/>- object([Find element and click](/docs/references/schemas/Find%20element%20and%20click)) | Optional. Click the element. | 
 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
diff --git a/docs/references/schemas/Find element and click.md b/docs/references/schemas/Find element and click.md
@@ -5,7 +5,7 @@
 
 ## Referenced In
 
-- [Find element (detailed)](/docs/references/schemas/Find element (detailed))
+- [Find element (detailed)](/docs/references/schemas/Find%20element%20(detailed))
 
 ## Fields
 
diff --git a/docs/references/schemas/Inline statement definition.md b/docs/references/schemas/Inline statement definition.md
@@ -5,7 +5,7 @@ Statements to include tests and steps inside the content of the file, such as wi
 
 ## Referenced In
 
-- [File type (custom)](/docs/references/schemas/File type (custom))
+- [File type (custom)](/docs/references/schemas/File%20type%20(custom))
 
 ## Fields
 
diff --git a/docs/references/schemas/Markup definition.md b/docs/references/schemas/Markup definition.md
@@ -5,7 +5,7 @@
 
 ## Referenced In
 
-- [File type (custom)](/docs/references/schemas/File type (custom))
+- [File type (custom)](/docs/references/schemas/File%20type%20(custom))
 
 ## Fields
 
diff --git a/docs/references/schemas/Padding (detailed).md b/docs/references/schemas/Padding (detailed).md
@@ -5,7 +5,7 @@ Padding in pixels to add to the bounds of the element.
 
 ## Referenced In
 
-- [Crop by element (detailed)](/docs/references/schemas/Crop by element (detailed))
+- [Crop by element (detailed)](/docs/references/schemas/Crop%20by%20element%20(detailed))
 
 ## Fields
 
diff --git a/docs/references/schemas/Request.md b/docs/references/schemas/Request.md
@@ -5,15 +5,15 @@
 
 ## Referenced In
 
-- [HTTP request (detailed)](/docs/references/schemas/HTTP request (detailed))
+- [HTTP request (detailed)](/docs/references/schemas/HTTP%20request%20(detailed))
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-headers | object([Request headers](/docs/references/schemas/Request headers)) | Optional. Headers to include in the HTTP request, in key/value format. | ``{}``
-parameters | object([Request parameters](/docs/references/schemas/Request parameters)) | Optional. URL parameters to include in the HTTP request, in key/value format. | ``{}``
-body | one of:<br/>- object([Request body object](/docs/references/schemas/Request body object))<br/>- array of unknown<br/>- string | Optional. JSON object to include as the body of the HTTP request. | ``{}``
+headers | object([Request headers](/docs/references/schemas/Request%20headers)) | Optional. Headers to include in the HTTP request, in key/value format. | ``{}``
+parameters | object([Request parameters](/docs/references/schemas/Request%20parameters)) | Optional. URL parameters to include in the HTTP request, in key/value format. | ``{}``
+body | one of:<br/>- object([Request body object](/docs/references/schemas/Request%20body%20object))<br/>- array of unknown<br/>- string | Optional. JSON object to include as the body of the HTTP request. | ``{}``
 
 ## Examples
 
diff --git a/docs/references/schemas/Response.md b/docs/references/schemas/Response.md
@@ -5,14 +5,14 @@
 
 ## Referenced In
 
-- [HTTP request (detailed)](/docs/references/schemas/HTTP request (detailed))
+- [HTTP request (detailed)](/docs/references/schemas/HTTP%20request%20(detailed))
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-headers | object([Response headers](/docs/references/schemas/Response headers)) | 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. | ``{}``
-body | one of:<br/>- object([Response body object](/docs/references/schemas/Response body object))<br/>- array of unknown<br/>- string | Optional. JSON object expected in the response. If one or more key/value pairs aren't present in the response, the step fails. | ``{}``
+headers | object([Response headers](/docs/references/schemas/Response%20headers)) | 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. | ``{}``
+body | one of:<br/>- object([Response body object](/docs/references/schemas/Response%20body%20object))<br/>- array of unknown<br/>- string | Optional. JSON object expected in the response. If one or more key/value pairs aren't present in the response, the step fails. | ``{}``
 
 ## Examples
 
diff --git a/docs/references/schemas/Run shell command (detailed).md b/docs/references/schemas/Run shell command (detailed).md
@@ -6,7 +6,7 @@
 ## Referenced In
 
 - [runShell](/docs/references/schemas/runShell)
-- [File type (executable)](/docs/references/schemas/File type (executable))
+- [File type (executable)](/docs/references/schemas/File%20type%20(executable))
 
 ## Fields
 
diff --git a/docs/references/schemas/Type keys (detailed).md b/docs/references/schemas/Type keys (detailed).md
@@ -5,7 +5,7 @@
 
 ## Referenced In
 
-- [Find element (detailed)](/docs/references/schemas/Find element (detailed))
+- [Find element (detailed)](/docs/references/schemas/Find%20element%20(detailed))
 - [type](/docs/references/schemas/type)
 
 ## Fields
diff --git a/docs/references/schemas/checkLink.md b/docs/references/schemas/checkLink.md
@@ -5,15 +5,15 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-checkLink | one of:<br/>- string<br/>- object([Check link (detailed)](/docs/references/schemas/Check link (detailed))) | Required. No description provided. | 
+checkLink | one of:<br/>- string<br/>- object([Check link (detailed)](/docs/references/schemas/Check%20link%20(detailed))) | Required. No description provided. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/click.md b/docs/references/schemas/click.md
@@ -5,15 +5,15 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-click | one of:<br/>- string<br/>- object([Click element (detailed)](/docs/references/schemas/Click element (detailed)))<br/>- boolean | Required. Click or tap an element. | 
+click | one of:<br/>- string<br/>- object([Click element (detailed)](/docs/references/schemas/Click%20element%20(detailed)))<br/>- boolean | Required. Click or tap an element. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/config.md b/docs/references/schemas/config.md
@@ -20,10 +20,10 @@ afterAll | one of:<br/>- string<br/>- array of string | Optional. Path(s) to tes
 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 one of: string, object([File type (custom)](/docs/references/schemas/File type (custom))), object([File type (executable)](/docs/references/schemas/File type (executable))) | Optional. Configuration for file types and their markup detection. | ``["markdown","asciidoc","html"]``
-integrations | object([Integrations options](/docs/references/schemas/Integrations options)) | Optional. Options for connecting to external services. | 
-telemetry | object([Telemetry options](/docs/references/schemas/Telemetry options)) | Optional. Options around sending telemetry for Doc Detective usage. | ``{"send":true}``
-environment | object([Environment details](/docs/references/schemas/Environment details)) | ReadOnly. Environment information for the system running Doc Detective. | 
+fileTypes | array of one of: string, object([File type (custom)](/docs/references/schemas/File%20type%20(custom))), object([File type (executable)](/docs/references/schemas/File%20type%20(executable))) | Optional. Configuration for file types and their markup detection. | ``["markdown","asciidoc","html"]``
+integrations | object([Integrations options](/docs/references/schemas/Integrations%20options)) | Optional. Options for connecting to external services. | 
+telemetry | object([Telemetry options](/docs/references/schemas/Telemetry%20options)) | Optional. Options around sending telemetry for Doc Detective usage. | ``{"send":true}``
+environment | object([Environment details](/docs/references/schemas/Environment%20details)) | ReadOnly. Environment information for the system running Doc Detective. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/find.md b/docs/references/schemas/find.md
@@ -5,15 +5,15 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-find | one of:<br/>- string<br/>- object([Find element (detailed)](/docs/references/schemas/Find element (detailed))) | Required. Find an element based on display text or a selector, then optionally interact with it. | 
+find | one of:<br/>- string<br/>- object([Find element (detailed)](/docs/references/schemas/Find%20element%20(detailed))) | Required. Find an element based on display text or a selector, then optionally interact with it. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/goTo.md b/docs/references/schemas/goTo.md
@@ -5,15 +5,15 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-goTo | one of:<br/>- string<br/>- object([Go to URL (detailed)](/docs/references/schemas/Go to URL (detailed))) | Required. No description provided. | 
+goTo | one of:<br/>- string<br/>- object([Go to URL (detailed)](/docs/references/schemas/Go%20to%20URL%20(detailed))) | Required. No description provided. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/httpRequest.md b/docs/references/schemas/httpRequest.md
@@ -5,15 +5,15 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-httpRequest | one of:<br/>- string<br/>- object([HTTP request (detailed)](/docs/references/schemas/HTTP request (detailed))) | Required. Perform a generic HTTP request, for example to an API. | 
+httpRequest | one of:<br/>- string<br/>- object([HTTP request (detailed)](/docs/references/schemas/HTTP%20request%20(detailed))) | Required. Perform a generic HTTP request, for example to an API. | 
 
 ## Examples
 
diff --git a/docs/references/schemas/loadVariables.md b/docs/references/schemas/loadVariables.md
@@ -5,9 +5,9 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
diff --git a/docs/references/schemas/openApi.md b/docs/references/schemas/openApi.md
@@ -5,11 +5,11 @@ OpenAPI description and configuration.
 
 ## Referenced In
 
-- [HTTP request (detailed)](/docs/references/schemas/HTTP request (detailed))
-- [Integrations options](/docs/references/schemas/Integrations options)
+- [HTTP request (detailed)](/docs/references/schemas/HTTP%20request%20(detailed))
+- [Integrations options](/docs/references/schemas/Integrations%20options)
 - [specification](/docs/references/schemas/specification)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
diff --git a/docs/references/schemas/record.md b/docs/references/schemas/record.md
@@ -5,15 +5,15 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-record | one of:<br/>- string<br/>- object([Record (detailed)](/docs/references/schemas/Record (detailed)))<br/>- boolean | Required. Start recording the current browser viewport. Must be followed by a `stopRecord` step. Only runs in Chrome browsers when they are visible. Supported extensions: [ '.mp4', '.webm', '.gif' ] | 
+record | one of:<br/>- string<br/>- object([Record (detailed)](/docs/references/schemas/Record%20(detailed)))<br/>- boolean | Required. Start recording the current browser viewport. Must be followed by a `stopRecord` step. Only runs in Chrome browsers when they are visible. Supported extensions: [ '.mp4', '.webm', '.gif' ] | 
 
 ## Examples
 
diff --git a/docs/references/schemas/runCode.md b/docs/references/schemas/runCode.md
@@ -5,14 +5,14 @@
 
 ## Referenced In
 
-- [Markup definition](/docs/references/schemas/Markup definition)
+- [Markup definition](/docs/references/schemas/Markup%20definition)
 - [test](/docs/references/schemas/test)
-- [Resolved context](/docs/references/schemas/Resolved context)
+- [Resolved context](/docs/references/schemas/Resolved%20context)
 
 ## Fields
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-runCode | object([Run code (detailed)](/docs/references/schemas/Run code (detailed))) | Required. Assemble and run code. | 
+runCode | object([Run code (detailed)](/docs/references/schemas/Run%20code%20(detailed))) | Required. Assemble and run code. | 
 
 ## Examples
diff --git a/docs/references/schemas/runShell.md b/docs/references/schemas/runShell.md
diff --git a/docs/references/schemas/screenshot.md b/docs/references/schemas/screenshot.md
diff --git a/docs/references/schemas/stopRecord.md b/docs/references/schemas/stopRecord.md
diff --git a/docs/references/schemas/test.md b/docs/references/schemas/test.md
diff --git a/docs/references/schemas/type.md b/docs/references/schemas/type.md
diff --git a/docs/references/schemas/wait.md b/docs/references/schemas/wait.md

Original file line number	Diff line number	Diff line change
`@@ -417,7 +417,9 @@ async function main() {`
`417`	`417`	`// For top-level schemas or schemas with titles`
`418`	`418`	fileName = `${schemaId}.md`;
`419`	`419`	`}`
`420`		- schemaPaths.set(schemaId, `/docs/references/schemas/${fileName.replace('.md', '')}`);
	`420`	`+ const pathWithoutExt = fileName.replace('.md', '');`
	`421`	`+ const encodedPath = encodeURIComponent(pathWithoutExt);`
	`422`	+ schemaPaths.set(schemaId, `/docs/references/schemas/${encodedPath}`);
`421`	`423`	`}`
`422`	`424`	`}`
`423`	`425`