docs: document multiple override files support in generators.yml#3894
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
docs: document multiple override files support in generators.yml#3894devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
Update documentation to reflect that the overrides field now accepts either a single path or an array of paths for OpenAPI, AsyncAPI, OpenRPC, and Protobuf spec types. When multiple paths are provided, overrides are applied sequentially in order. Refs: fern-api/fern#11486 Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
Requested by: judah |
Contributor
|
🌿 Preview your docs: https://fern-preview-f82aa996-bccd-4b62-b03f-c625d4460c8f.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.
docs: document multiple override files support in generators.yml
Summary
Documents the new multiple override files feature from fern-api/fern#11486. The
overridesfield ingenerators.ymlnow accepts either a single path (string) or an array of paths applied sequentially. This PR updates all documentation surfaces to reflect this:fern/apis/generators-yml/definition/generators.yml): AddedOverridesSchemaundiscriminated union type (string | list<string>) and updated all spec schemas (OpenAPI, AsyncAPI, OpenRPC, Protobuf, and legacyAPIDefinitionWithOverridesSchema) to use it.openapi-specs.mdx,grpc-specs.mdx): UpdatedoverridesParamField types and added inline YAML examples showing both single and array usage.generators-yml-reference.mdx): Updated AsyncAPI and OpenRPCoverridesParamField types with examples.overrides.mdx): Added a "Multiple override files" section explaining the feature, use cases, and examples. Also added an array example in the existing "Add a reference to generators.yml" step.Review & Testing Checklist for Human
overrides.mdxaccurately describes sequential application behavior — the claim that "later files take precedence over earlier ones for conflicting keys" should match the actual deep-merge behavior in the CLIGeneratorsOpenAPIObjectSchema(line ~119 in the schema file) intentionally still usesoptional<string>for itsoverridesfield — this is the legacy top-levelopenapikey, not V2specs, so it was left unchanged to match the CLIstring | list of stringswith working code examples and links (e.g., the/learn/api-definitions/overview/overridescross-references)Notes