Skip to content

Add fern api update prerequisite note and x-fern-sdk-namespace to exten… #6833

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
fern-api wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add fern api update prerequisite note and x-fern-sdk-namespace to exten… #6833

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions fern/products/api-def/openapi/extensions/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ The table below shows all available extensions and links to detailed documentati
| [`x-fern-sdk-method-name`](./method-names) | Customize SDK method names |
| [`x-fern-sdk-group-name`](./method-names) | Organize methods into SDK groups |
| [`x-fern-sdk-variables`](./sdk-variables) | Set common path parameters across all requests |
| `x-fern-sdk-namespace` | Namespace schemas to prevent name collisions when combining multiple API specs |
| [`x-fern-parameter-name`](./parameter-names) | Customize parameter variable names |
| [`x-fern-property-name`](./property-names) | Customize object property variable names |
| [`x-fern-retries`](./retry-behavior) | Configure retry behavior for endpoints |
Expand Down
2 changes: 2 additions & 0 deletions fern/products/cli-api-reference/pages/general-commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,8 @@ These commands apply to every Fern project, whether it publishes [docs](/learn/c
Pulls the latest OpenAPI spec from the specified `origin` in `generators.yml` and
updates the local spec. Alternatively, you can [automate this process by setting up a GitHub Action](/learn/api-definitions/openapi/sync-your-open-api-specification).

The local file referenced by the `openapi:` path in `generators.yml` must already exist before running `fern api update`. The command overwrites the file in place — it does not create a new file. If the file is missing, the command outputs `Missing file: <filename>`. To fix this, create an empty placeholder at the expected path (e.g., `touch path/to/openapi.json`) and re-run `fern api update`.

@github-actions github-actions Bot Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'doesn't' instead of 'does not'.

Suggested change
The local file referenced by the `openapi:` path in `generators.yml` must already exist before running `fern api update`. The command overwrites the file in place — it does not create a new file. If the file is missing, the command outputs `Missing file: <filename>`. To fix this, create an empty placeholder at the expected path (e.g., `touch path/to/openapi.json`) and re-run `fern api update`.
The local file referenced by the `openapi:` path in `generators.yml` must already exist before running `fern api update`. The command overwrites the file in place — it doesn't create a new file. If the file is missing, the command outputs `Missing file: <filename>`. To fix this, create an empty placeholder at the expected path (e.g., `touch path/to/openapi.json`) and re-run `fern api update`.


<CodeBlock title="terminal">
```bash
fern api update [--api <api>]
Expand Down
Loading