Skip to content

docs: document respect-operation-id-word-boundaries OpenAPI setting #6937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document respect-operation-id-word-boundaries OpenAPI setting #6937

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions fern/snippets/openapi-specs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ api:
inline-all-of-schemas: true
prefer-undiscriminated-unions-with-literals: true
respect-parameter-content: true
respect-operation-id-word-boundaries: true
filter:
endpoints: ["POST /users", "GET /users/{id}"]
example-generation:
Expand Down Expand Up @@ -138,6 +139,12 @@ api:
Enables respecting forward compatible enums in OpenAPI specifications.
</ParamField>

<ParamField path="settings.respect-operation-id-word-boundaries" type="boolean" default="false" toc={true}>
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.

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.
</ParamField>

<ParamField path="settings.use-bytes-for-binary-response" type="boolean" toc={true}>
Enables using the `bytes` type for binary responses. Defaults to file stream.
</ParamField>
Expand Down
Loading