Skip to content

Commit 2ea7ccb

Browse files
📖 [Docs]: Backtick literal API paths in Invoke-ConfluenceRestMethod help
The Build-Docs job's NATURAL_LANGUAGE (textlint terminology) linter flagged the lowercase 'api' path segment in '/wiki/rest/api,' in the generated docs (outputs/docs/API/Invoke-ConfluenceRestMethod.md:111), suggesting 'API'. That segment is a literal Confluence REST v1 path and must stay lowercase. Wrapping the /wiki/... paths in the -ApiEndpoint and -ApiVersion parameter help in backticks renders them as inline code, which textlint skips - matching how the already-passing backticked URLs in other command help are handled.
1 parent f9542c2 commit 2ea7ccb

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/functions/public/API/Invoke-ConfluenceRestMethod.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ function Invoke-ConfluenceRestMethod {
3838
[CmdletBinding()]
3939
[OutputType([object])]
4040
param(
41-
# The API path beginning with '/wiki/', e.g. '/wiki/api/v2/pages'.
41+
# The API path beginning with `/wiki/`, e.g. `/wiki/api/v2/pages`.
4242
# A full absolute URL is also accepted (used when following pagination links).
4343
# When -ApiVersion is supplied this is treated as a path relative to that
4444
# API family's root (e.g. -ApiVersion v2 -ApiEndpoint 'spaces').
4545
[Parameter(Mandatory)]
4646
[string]$ApiEndpoint,
4747

4848
# Optional API family. Uses the internal map to prepend the version prefix
49-
# (v1 -> /wiki/rest/api, v2 -> /wiki/api/v2) to a relative -ApiEndpoint.
49+
# (v1 -> `/wiki/rest/api`, v2 -> `/wiki/api/v2`) to a relative -ApiEndpoint.
5050
[ValidateSet('v1', 'v2')]
5151
[string]$ApiVersion,
5252

0 commit comments

Comments
 (0)