diff --git a/fern/products/api-def/pages/overrides.mdx b/fern/products/api-def/pages/overrides.mdx index ce538ccf4..5b4bfd19d 100644 --- a/fern/products/api-def/pages/overrides.mdx +++ b/fern/products/api-def/pages/overrides.mdx @@ -3,13 +3,15 @@ title: Overrides description: Customize your API definition using a separate overrides file. --- -Use an overrides file to customize your API definition without modifying the original spec. This is useful when: +Use an overrides file to customize your OpenAPI, AsyncAPI, OpenRPC, or gRPC definition without modifying the original spec. This is useful when: * Your API specification is auto-generated from server code * You need different configurations for SDKs versus documentation +Overrides are available for OpenAPI, AsyncAPI, OpenRPC, and gRPC specifications. They are not needed for [Fern Definition](/api-definitions/ferndef/overview) since you can directly edit those files. + -While you can also embed Fern extensions directly in your API specification, using overrides files is the recommended approach as it keeps your original spec clean and separates concerns. +While you can also embed [Fern extensions](/api-definitions/overview/overrides#definition-specific-extensions) directly in your API specification, using overrides files is the recommended approach as it keeps your original spec clean and separates concerns. ## Implement overrides @@ -31,7 +33,9 @@ fern/ The format of the overrides file is independent from the spec. For example, even if your OpenAPI spec is in JSON format, you can write the overrides in yaml. - + + +For OpenAPI, AsyncAPI, and OpenRPC, and gRPC, you can use [Fern's extensions](/api-definitions/overview/overrides#definition-specific-extensions) to apply customizations. ```yml title="overrides.yml" {4-5} paths: @@ -159,9 +163,9 @@ groups: version: 0.8.8 ``` -## Definition-specific customizations +## Definition-specific extensions -Learn more about the customizations you can make for each definition: +Learn more about the Fern extensions you can use to customize your definition: @@ -172,4 +176,4 @@ Learn more about the customizations you can make for each definition: - \ No newline at end of file +