Skip to content

Commit 91a6377

Browse files
docs: document respect-operation-id-word-boundaries OpenAPI setting
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent 97f705d commit 91a6377

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

fern/snippets/openapi-specs.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ api:
1313
inline-all-of-schemas: true
1414
prefer-undiscriminated-unions-with-literals: true
1515
respect-parameter-content: true
16+
respect-operation-id-word-boundaries: true
1617
filter:
1718
endpoints: ["POST /users", "GET /users/{id}"]
1819
example-generation:
@@ -138,6 +139,12 @@ api:
138139
Enables respecting forward compatible enums in OpenAPI specifications.
139140
</ParamField>
140141

142+
<ParamField path="settings.respect-operation-id-word-boundaries" type="boolean" default="false" toc={true}>
143+
Splits an `operationId` on separators, camelCase transitions, and digits when building API Reference URL slugs, and strips the tag prefix. When `false`, an `operationId` that contains an underscore or digit is split only on separators, so `Plants_ListPlantVarieties` under the `plants` tag becomes `/plants/listplantvarieties` instead of `/plants/list-plant-varieties`. Affects API Reference URLs only; generated SDK method names are unchanged.
144+
145+
Enabling this setting moves existing API Reference URLs. Add [redirects](/learn/docs/seo/redirects) for the old paths and update hardcoded links in the same change.
146+
</ParamField>
147+
141148
<ParamField path="settings.use-bytes-for-binary-response" type="boolean" toc={true}>
142149
Enables using the `bytes` type for binary responses. Defaults to file stream.
143150
</ParamField>

0 commit comments

Comments
 (0)