Skip to content

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

Open
fern-api[bot] wants to merge 1 commit into
mainfrom
2026-09-02-fern-ai-2fbdc2-9ab99c48
Open

Add fern api update prerequisite note and x-fern-sdk-namespace to exten…#6833
fern-api[bot] wants to merge 1 commit into
mainfrom
2026-09-02-fern-ai-2fbdc2-9ab99c48

Conversation

@fern-api

@fern-api fern-api Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Two targeted improvements: (1) In the fern api update accordion on the General commands page, added a plain-prose note (inline, per AGENTS.md callout guidance) explaining that the local file referenced by openapi: in generators.yml must already exist before running the command — it overwrites in place, not creates — and that a Missing file: <filename> error is fixed by creating an empty placeholder with touch then re-running. (2) In the OpenAPI extensions overview table, added a new row for x-fern-sdk-namespace with the description "Namespace schemas to prevent name collisions when combining multiple API specs", placed after the x-fern-sdk-variables row, with no link since no dedicated page exists yet.

@fern-api
fern-api Bot requested a review from devalog as a code owner September 2, 2026 21:42
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`.

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`.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants