Add fern api update prerequisite note and x-fern-sdk-namespace to exten… - #6833
Open
fern-api[bot] wants to merge 1 commit into
Open
Add fern api update prerequisite note and x-fern-sdk-namespace to exten…#6833fern-api[bot] wants to merge 1 commit into
fern-api[bot] wants to merge 1 commit into
Conversation
| 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`. |
Contributor
There was a problem hiding this comment.
🚫 [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`. |
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-09-02-fern-ai-2fbdc2-9ab99c48.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two targeted improvements: (1) In the
fern api updateaccordion on the General commands page, added a plain-prose note (inline, per AGENTS.md callout guidance) explaining that the local file referenced byopenapi:ingenerators.ymlmust already exist before running the command — it overwrites in place, not creates — and that aMissing file: <filename>error is fixed by creating an empty placeholder withtouchthen re-running. (2) In the OpenAPI extensions overview table, added a new row forx-fern-sdk-namespacewith the description "Namespace schemas to prevent name collisions when combining multiple API specs", placed after thex-fern-sdk-variablesrow, with no link since no dedicated page exists yet.