From a62d342d3f4614e9c3826b69734ae92b8ce2b3b0 Mon Sep 17 00:00:00 2001 From: patrickthornton <70873350+patrickthornton@users.noreply.github.com> Date: Fri, 22 Aug 2025 16:40:20 +0000 Subject: [PATCH] update changelogs --- .../cli-changelog/2025-04-09.mdx | 4 ++-- .../cli-changelog/2025-04-12.mdx | 2 +- .../cli-changelog/2025-04-21.mdx | 6 +++--- .../cli-changelog/2025-04-22.mdx | 6 +++--- .../cli-changelog/2025-04-24.mdx | 4 ++-- .../cli-changelog/2025-04-26.mdx | 6 +++--- .../cli-changelog/2025-04-27.mdx | 8 ++++---- .../cli-changelog/2025-04-29.mdx | 6 +++--- .../cli-changelog/2025-04-30.mdx | 8 ++++---- .../cli-changelog/2025-05-01.mdx | 6 +++--- .../cli-changelog/2025-05-02.mdx | 10 +++++----- .../cli-changelog/2025-05-03.mdx | 8 ++++---- .../cli-changelog/2025-05-09.mdx | 4 ++-- .../cli-changelog/2025-05-14.mdx | 2 +- .../cli-changelog/2025-05-15.mdx | 2 +- .../cli-changelog/2025-05-16.mdx | 8 ++++---- .../cli-changelog/2025-05-17.mdx | 4 ++-- .../cli-changelog/2025-05-21.mdx | 4 ++-- .../cli-changelog/2025-06-03.mdx | 2 +- .../cli-changelog/2025-06-11.mdx | 16 ++++++++-------- .../cli-changelog/2025-06-12.mdx | 4 ++-- .../cli-changelog/2025-06-19.mdx | 2 +- .../cli-changelog/2025-06-25.mdx | 4 ++-- .../cli-changelog/2025-06-27.mdx | 4 ++-- .../cli-changelog/2025-07-08.mdx | 2 +- .../cli-changelog/2025-07-12.mdx | 4 ++-- .../cli-changelog/2025-07-30.mdx | 10 +++++----- .../cli-changelog/2025-07-31.mdx | 4 ++-- .../cli-changelog/2025-08-01.mdx | 2 +- .../cli-changelog/2025-08-18.mdx | 18 +++++++++--------- .../cli-changelog/2025-08-22.mdx | 3 +++ 31 files changed, 88 insertions(+), 85 deletions(-) diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-09.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-09.mdx index 56557ce71..01736a03b 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-09.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-09.mdx @@ -3,12 +3,12 @@ ## 0.57.19 -**`(fix):`** Fix an issue in the OpenAPI parser where array references were not being properly resolved. The parser now correctly resolves references +**`(fix):`** Fix an issue in the OpenAPI parser where array references were not being properly resolved. The parser now correctly resolves references within array schemas, ensuring that arrays of referenced types are properly handled throughout the API definition. ## 0.57.18 -**`(fix):`** Improve the ReadMe migrator to respect the original navigation structure when creating the file hierarchy. Previously, nested navigation groups were +**`(fix):`** Improve the ReadMe migrator to respect the original navigation structure when creating the file hierarchy. Previously, nested navigation groups were flattened, but now the file structure will mirror the navigation hierarchy, preserving the original organization of documentation. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-12.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-12.mdx index 00bdfa31d..7b99ca42a 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-12.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-12.mdx @@ -1,5 +1,5 @@ ## 0.57.24 -**`(fix):`** Fix an issue in the OpenAPI importer where discriminated unions with literal discriminant values in the variants would render the discriminant property twice. +**`(fix):`** Fix an issue in the OpenAPI importer where discriminated unions with literal discriminant values in the variants would render the discriminant property twice. The importer now correctly checks if union variants contain the discriminant property as a literal value and handles them appropriately. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-21.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-21.mdx index 04c2da0a4..714274517 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-21.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-21.mdx @@ -6,13 +6,13 @@ Single element type arrays will resolve to the single element in the example. ## 0.57.33 -**`(feat):`** Improve OpenRPC response example generation by wrapping example payloads in JSON-RPC 2.0 format with metadata +**`(feat):`** Improve OpenRPC response example generation by wrapping example payloads in JSON-RPC 2.0 format with metadata (jsonrpc version and request id). This ensures generated examples match the actual JSON-RPC response format. ## 0.57.32 -**`(feat):`** Improve server handling in OpenAPI imports by exploding servers with enum variables into multiple servers, -one for each enum value. For example, a server with URL "https://{region}.example.com" where region +**`(feat):`** Improve server handling in OpenAPI imports by exploding servers with enum variables into multiple servers, +one for each enum value. For example, a server with URL "https://{region}.example.com" where region is an enum ["us", "eu"] will be exploded into two servers: "https://us.example.com" and "https://eu.example.com". diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-22.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-22.mdx index a395899c3..16fe7fc0b 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-22.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-22.mdx @@ -1,7 +1,7 @@ ## 0.57.35 -**`(feat):`** Improve OpenAPI response handling for 204 status codes by respecting schema definitions. -When a 204 (No Content) response includes a schema, the importer now properly processes -and preserves this schema information, ensuring accurate API documentation and SDK generation +**`(feat):`** Improve OpenAPI response handling for 204 status codes by respecting schema definitions. +When a 204 (No Content) response includes a schema, the importer now properly processes +and preserves this schema information, ensuring accurate API documentation and SDK generation even for endpoints that don't return content in successful responses. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-24.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-24.mdx index 3c7f3cf5c..0bda5e8f4 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-24.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-24.mdx @@ -8,8 +8,8 @@ multiple API Definitions that have overlapping schema names or operation names. ## 0.57.37 -**`(feat):`** Improve OpenRPC request example generation by not wrapping request payloads in JSON-RPC 2.0 format. -This ensures generated request examples match the expected format for the API's method parameters +**`(feat):`** Improve OpenRPC request example generation by not wrapping request payloads in JSON-RPC 2.0 format. +This ensures generated request examples match the expected format for the API's method parameters without the additional JSON-RPC envelope. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-26.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-26.mdx index 01bf1d797..6eef84178 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-26.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-26.mdx @@ -1,7 +1,7 @@ ## 0.58.2 -**`(feat):`** Enhance example generation to consider default values when generating examples for primitive types. -When a string primitive type has a default value specified, the example generator now uses this -default value instead of a generic example. This produces more realistic and contextually +**`(feat):`** Enhance example generation to consider default values when generating examples for primitive types. +When a string primitive type has a default value specified, the example generator now uses this +default value instead of a generic example. This produces more realistic and contextually appropriate examples in generated SDKs and documentation. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-27.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-27.mdx index 46c561d1e..6f4057af7 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-27.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-27.mdx @@ -1,8 +1,8 @@ ## 0.58.3 -**`(feat):`** Enhance OpenAPI security scheme handling in the parser to support both global and endpoint-level security requirements. -The parser now properly converts security schemes from OpenAPI's `securitySchemes` component into appropriate authentication -headers, supporting bearer tokens, basic auth, and custom API key headers. Global security requirements defined at the -document level are applied to all endpoints, while endpoint-specific security requirements override or supplement the +**`(feat):`** Enhance OpenAPI security scheme handling in the parser to support both global and endpoint-level security requirements. +The parser now properly converts security schemes from OpenAPI's `securitySchemes` component into appropriate authentication +headers, supporting bearer tokens, basic auth, and custom API key headers. Global security requirements defined at the +document level are applied to all endpoints, while endpoint-specific security requirements override or supplement the global configuration, ensuring accurate authentication representation in generated SDKs. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-29.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-29.mdx index 723199a16..244334bdb 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-29.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-29.mdx @@ -3,7 +3,7 @@ ## 0.59.1 -**`(feat):`** Enhance OpenAPI -> IR parser to better handle inlined oneOf schemas. The parser now uses the schema ID when +**`(feat):`** Enhance OpenAPI -> IR parser to better handle inlined oneOf schemas. The parser now uses the schema ID when generating names for oneOf variants, resulting in more predictable and consistent type names in the generated SDKs. @@ -13,8 +13,8 @@ This command is in-development; changes are expected. ## 0.58.6 -**`(feat):`** Add support for schema conversion in OpenRPC importer. The importer now properly converts schemas defined in the -OpenRPC document's components section into Fern types, enabling full type definitions for request and response +**`(feat):`** Add support for schema conversion in OpenRPC importer. The importer now properly converts schemas defined in the +OpenRPC document's components section into Fern types, enabling full type definitions for request and response objects. This enhancement allows for more complete and accurate SDK generation from OpenRPC specifications. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-04-30.mdx b/fern/products/cli-api-reference/cli-changelog/2025-04-30.mdx index 53dc11836..8d82887cf 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-04-30.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-04-30.mdx @@ -1,12 +1,12 @@ ## 0.59.4 -**`(fix):`** Enhance OpenAPI -> IR conversion to properly handle default values in schemas. The converter now correctly extracts -and preserves default values from OpenAPI schemas, ensuring they are properly represented in the generated SDKs. +**`(fix):`** Enhance OpenAPI -> IR conversion to properly handle default values in schemas. The converter now correctly extracts +and preserves default values from OpenAPI schemas, ensuring they are properly represented in the generated SDKs. This improvement allows API providers to specify meaningful defaults that will be respected in client implementations. ## 0.59.3 -**`(fix):`** Improve OpenRPC importer to generate more unique schema IDs for request parameters by combining method name, -"Param" keyword, and parameter name. This prevents naming conflicts when different methods have parameters +**`(fix):`** Improve OpenRPC importer to generate more unique schema IDs for request parameters by combining method name, +"Param" keyword, and parameter name. This prevents naming conflicts when different methods have parameters with the same name, resulting in more reliable and consistent type generation in the SDKs. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-01.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-01.mdx index c4f8dd2f9..5274cf97f 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-01.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-01.mdx @@ -16,9 +16,9 @@ parameters are properly handled during example generation, resulting in cleaner ## 0.59.6 -**`(fix):`** Add support for local SDK generation with a Fern token. When a valid Fern token is provided, -users can now generate complete SDKs locally using Docker, without requiring remote generation. -This enhancement improves the development workflow by allowing for faster iteration and testing +**`(fix):`** Add support for local SDK generation with a Fern token. When a valid Fern token is provided, +users can now generate complete SDKs locally using Docker, without requiring remote generation. +This enhancement improves the development workflow by allowing for faster iteration and testing of SDK changes in local environments. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-02.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-02.mdx index b8a10fb95..dc0cc5e05 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-02.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-02.mdx @@ -1,6 +1,6 @@ ## 0.60.7 -**`(feat):`** Add support for auth descriptions in generated documentation. Auth schemes can now include descriptive text that explains authentication requirements, -which is properly displayed in the generated documentation. This enhancement improves API usability by providing clearer guidance on authentication +**`(feat):`** Add support for auth descriptions in generated documentation. Auth schemes can now include descriptive text that explains authentication requirements, +which is properly displayed in the generated documentation. This enhancement improves API usability by providing clearer guidance on authentication methods directly within the documentation. @@ -13,9 +13,9 @@ methods directly within the documentation. ## 0.60.4 -**`(feat):`** Add support for custom parameters in OpenRPC through the `x-fern-parameters` extension. This extension allows OpenRPC -definitions to specify path parameters, query parameters, and headers that aren't natively supported in the OpenRPC -specification. Parameters defined with this extension are properly converted to the Fern IR format and included in +**`(feat):`** Add support for custom parameters in OpenRPC through the `x-fern-parameters` extension. This extension allows OpenRPC +definitions to specify path parameters, query parameters, and headers that aren't natively supported in the OpenRPC +specification. Parameters defined with this extension are properly converted to the Fern IR format and included in endpoint definitions, enabling more complete API representations when importing from OpenRPC sources. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-03.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-03.mdx index d6b348066..a941841d8 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-03.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-03.mdx @@ -1,8 +1,8 @@ ## 0.60.8 -**`(feat):`** Add support for environment and auth overrides from generators.yml in the OpenAPI parser. When importing OpenAPI specifications, -the parser now checks for environment and auth configurations in the generators.yml file and uses these settings to override -the environments and authentication schemes defined in the OpenAPI document. This enhancement provides more flexibility in -customizing imported APIs without modifying the original OpenAPI specification, allowing for environment-specific configurations +**`(feat):`** Add support for environment and auth overrides from generators.yml in the OpenAPI parser. When importing OpenAPI specifications, +the parser now checks for environment and auth configurations in the generators.yml file and uses these settings to override +the environments and authentication schemes defined in the OpenAPI document. This enhancement provides more flexibility in +customizing imported APIs without modifying the original OpenAPI specification, allowing for environment-specific configurations and standardized authentication schemes across different API versions. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-09.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-09.mdx index 0b4c61947..5192b78b8 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-09.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-09.mdx @@ -3,12 +3,12 @@ ## 0.60.28 -**`(fix):`** Fixed an issue where local generation could produce invalid build files (like pyproject.toml) when +**`(fix):`** Fixed an issue where local generation could produce invalid build files (like pyproject.toml) when GitHub configuration was missing a repository URL. The CLI now ensures a repository URL is always set when possible. ## 0.60.27 -**`(fix):`** Added support for using Podman as a container runner with `fern generate --runner podman`. +**`(fix):`** Added support for using Podman as a container runner with `fern generate --runner podman`. This allows users to run generators locally using Podman instead of Docker. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-14.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-14.mdx index 730008f9c..b232e8260 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-14.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-14.mdx @@ -7,7 +7,7 @@ ## 0.61.8 -**`(fix):`** Fix a bug where the broken link checker would incorrectly flag links to llms.txt and llms-full.txt files as broken. +**`(fix):`** Fix a bug where the broken link checker would incorrectly flag links to llms.txt and llms-full.txt files as broken. The checker now properly recognizes these file paths as valid. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-15.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-15.mdx index 933caf2e7..be846bee5 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-15.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-15.mdx @@ -1,5 +1,5 @@ ## 0.61.16 -**`(fix):`** Fix docs preview server by properly killing the Next.js process on exit and setting +**`(fix):`** Fix docs preview server by properly killing the Next.js process on exit and setting a memory limit (--max-old-space-size=2048) to prevent out-of-memory errors during development. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-16.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-16.mdx index df9783b65..9c23bc2fe 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-16.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-16.mdx @@ -4,14 +4,14 @@ AsyncAPI endpoints now have the correct associated path parameters. ## 0.61.18 -**`(fix):`** Fix OpenRPC converter to use proper breadcrumbs when generating request and response schemas. -This ensures that schemas with the same name but different contexts (such as parameters and results) +**`(fix):`** Fix OpenRPC converter to use proper breadcrumbs when generating request and response schemas. +This ensures that schemas with the same name but different contexts (such as parameters and results) don't overwrite each other during conversion, maintaining the integrity of the API definition. ## 0.61.17 -**`(fix):`** Add support for preserving `maxLines` and `focus` attributes when using `` components in docs. -These attributes are now properly carried over to the generated code blocks, allowing you to control +**`(fix):`** Add support for preserving `maxLines` and `focus` attributes when using `` components in docs. +These attributes are now properly carried over to the generated code blocks, allowing you to control the display of referenced code snippets with features like line limits and syntax highlighting focus. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-17.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-17.mdx index 34267b119..84f691d65 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-17.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-17.mdx @@ -1,6 +1,6 @@ ## 0.61.20 -**`(fix):`** Add logging of filepaths when markdown parsing fails to help with debugging. This includes logging the -absolute filepath of the markdown file being parsed and any associated image paths that were +**`(fix):`** Add logging of filepaths when markdown parsing fails to help with debugging. This includes logging the +absolute filepath of the markdown file being parsed and any associated image paths that were being processed when the error occurred. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-05-21.mdx b/fern/products/cli-api-reference/cli-changelog/2025-05-21.mdx index b1ca9b139..bc72f3f90 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-05-21.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-05-21.mdx @@ -4,7 +4,7 @@ ```yaml - name: fernapi/fern-typescript-sdk version: 0.48.5 - api: + api: auth: bearer ``` @@ -20,7 +20,7 @@ This will override the auth configuration for that specific generator while keep ## 0.62.7 -**`(fix):`** Remove `respect-readonly-schemas` for the legacy OpenAPI parser since it can block docs +**`(fix):`** Remove `respect-readonly-schemas` for the legacy OpenAPI parser since it can block docs generation. Anyone who wants to enable this can turn it on in `generators.yml` or upgrade to the latest OpenAPI parser. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-06-03.mdx b/fern/products/cli-api-reference/cli-changelog/2025-06-03.mdx index 065be8db1..02657de94 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-06-03.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-06-03.mdx @@ -1,5 +1,5 @@ ## 0.63.29 -**`(fix):`** The v3 OpenAPI parser now appropriately creates inlined types for references to +**`(fix):`** The v3 OpenAPI parser now appropriately creates inlined types for references to inlined schemas like `$ref: /components/schemas/MySchema/properties/foo` diff --git a/fern/products/cli-api-reference/cli-changelog/2025-06-11.mdx b/fern/products/cli-api-reference/cli-changelog/2025-06-11.mdx index e09fbc613..a667187c9 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-06-11.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-06-11.mdx @@ -3,22 +3,22 @@ ## 0.64.3 -**`(fix):`** The OpenAPI v3 Parser now uniquely stores schemas across endpoint parameters to prevent overwriting. Previously, -schemas with the same name across different parameters would overwrite each other, leading to potential data loss -and incorrect type definitions. This fix ensures that each parameter's schema is properly preserved and referenced +**`(fix):`** The OpenAPI v3 Parser now uniquely stores schemas across endpoint parameters to prevent overwriting. Previously, +schemas with the same name across different parameters would overwrite each other, leading to potential data loss +and incorrect type definitions. This fix ensures that each parameter's schema is properly preserved and referenced throughout the API specification. ## 0.64.2 -**`(fix):`** The AsyncAPI v3 importer now properly detects query parameters by analyzing the channel address specification. -When a channel address contains a parameter reference in the format `={paramName}`, the importer will automatically -identify it as a query parameter. This allows for more accurate parameter type detection and better handling of +**`(fix):`** The AsyncAPI v3 importer now properly detects query parameters by analyzing the channel address specification. +When a channel address contains a parameter reference in the format `={paramName}`, the importer will automatically +identify it as a query parameter. This allows for more accurate parameter type detection and better handling of WebSocket channel parameters in AsyncAPI v3 specifications. ## 0.64.1 -**`(fix):`** The AsyncAPI importer now supports parameter references and computing location of the parameter based on the address. -This allows for more flexible parameter definitions in AsyncAPI specifications, where parameters can be referenced from other +**`(fix):`** The AsyncAPI importer now supports parameter references and computing location of the parameter based on the address. +This allows for more flexible parameter definitions in AsyncAPI specifications, where parameters can be referenced from other parts of the specification and their location can be dynamically determined based on the channel address. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-06-12.mdx b/fern/products/cli-api-reference/cli-changelog/2025-06-12.mdx index c6c3a0e7e..d7094a04d 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-06-12.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-06-12.mdx @@ -3,8 +3,8 @@ ## 0.64.6 -**`(fix):`** The Readme importer now downloads MDX files from the source documentation. -This allows for better handling of React components and dynamic content in the imported documentation. +**`(fix):`** The Readme importer now downloads MDX files from the source documentation. +This allows for better handling of React components and dynamic content in the imported documentation. The importer will preserve the MDX syntax and structure while converting the content to a format compatible with Fern's documentation system. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-06-19.mdx b/fern/products/cli-api-reference/cli-changelog/2025-06-19.mdx index 4a14ead89..c9170a00e 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-06-19.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-06-19.mdx @@ -3,7 +3,7 @@ ## 0.64.13 -**`(fix):`** Respect additional properties in docs example generation by preserving them in generated examples instead of +**`(fix):`** Respect additional properties in docs example generation by preserving them in generated examples instead of stripping unknown properties. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-06-25.mdx b/fern/products/cli-api-reference/cli-changelog/2025-06-25.mdx index a41340aca..ce8812fa3 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-06-25.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-06-25.mdx @@ -1,6 +1,6 @@ ## 0.64.23 -**`(fix):`** Global headers are now used to create endpoint examples. When building endpoint examples, global headers -are automatically included in the headers section of each example. This ensures that all endpoints have consistent +**`(fix):`** Global headers are now used to create endpoint examples. When building endpoint examples, global headers +are automatically included in the headers section of each example. This ensures that all endpoints have consistent header examples that match the global header configuration. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-06-27.mdx b/fern/products/cli-api-reference/cli-changelog/2025-06-27.mdx index e5043e2f9..f2da48356 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-06-27.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-06-27.mdx @@ -3,8 +3,8 @@ ## 0.64.24 -**`(feat):`** Added Server-Sent Events (SSE) support to Java stream implementation. The Java SDK generator now -supports SSE streaming alongside existing JSON streaming, enabling real-time incremental responses +**`(feat):`** Added Server-Sent Events (SSE) support to Java stream implementation. The Java SDK generator now +supports SSE streaming alongside existing JSON streaming, enabling real-time incremental responses for chat applications and live data feeds. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-07-08.mdx b/fern/products/cli-api-reference/cli-changelog/2025-07-08.mdx index 1084d2c1d..9d4c32386 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-07-08.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-07-08.mdx @@ -1,6 +1,6 @@ ## 0.65.4 **`(fix):`** Previously if the OpenAPI parser v3 was enabled where the CLI would skip parsing any additional Fern Definitions -along the OpenAPI spec. With the fix, you can use whatever combination of OpenAPI Spec(s) and Fern Definitions that +along the OpenAPI spec. With the fix, you can use whatever combination of OpenAPI Spec(s) and Fern Definitions that you would like. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-07-12.mdx b/fern/products/cli-api-reference/cli-changelog/2025-07-12.mdx index 9566cd63f..6d21574aa 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-07-12.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-07-12.mdx @@ -1,6 +1,6 @@ ## 0.65.11 -**`(feat):`** The extension `x-fern-global-headers` now supports a type field that can point to -arbitrary schemas. For example you can do the following to describe a header +**`(feat):`** The extension `x-fern-global-headers` now supports a type field that can point to +arbitrary schemas. For example you can do the following to describe a header that is an enum. ```yml diff --git a/fern/products/cli-api-reference/cli-changelog/2025-07-30.mdx b/fern/products/cli-api-reference/cli-changelog/2025-07-30.mdx index a4d813ae8..d59514329 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-07-30.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-07-30.mdx @@ -3,13 +3,13 @@ ## 0.65.37 -**`(feat):`** Add support for snippet.json output as part of self hosted SDK generation. The following config in -`generators.yml` will generate a `snippet.json` file in the relevant director: +**`(feat):`** Add support for snippet.json output as part of self hosted SDK generation. The following config in +`generators.yml` will generate a `snippet.json` file in the relevant director: ``` -groups: - ts-sdk: +groups: + ts-sdk: - name: fernapi/fern-typescript-sdk - snippets: + snippets: path: ../snippets.json ``` diff --git a/fern/products/cli-api-reference/cli-changelog/2025-07-31.mdx b/fern/products/cli-api-reference/cli-changelog/2025-07-31.mdx index 0774de606..5748b6e43 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-07-31.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-07-31.mdx @@ -7,8 +7,8 @@ ## 0.65.39 -**`(fix):`** Fix snippet generation for local file system output mode. Snippets configured with `snippets.path` -in generators.yml were not being generated when using `--local` flag due to missing Docker volume +**`(fix):`** Fix snippet generation for local file system output mode. Snippets configured with `snippets.path` +in generators.yml were not being generated when using `--local` flag due to missing Docker volume mounting for the downloadFiles output mode. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-08-01.mdx b/fern/products/cli-api-reference/cli-changelog/2025-08-01.mdx index 991299d71..b0343734f 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-08-01.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-08-01.mdx @@ -1,5 +1,5 @@ ## 0.65.44 -**`(feat):`** Escape $ signs when converting from OpenAPI -> Fern Definition (for enums), because the Fern Definition treats +**`(feat):`** Escape $ signs when converting from OpenAPI -> Fern Definition (for enums), because the Fern Definition treats $ sign examples as references. diff --git a/fern/products/cli-api-reference/cli-changelog/2025-08-18.mdx b/fern/products/cli-api-reference/cli-changelog/2025-08-18.mdx index fef478b13..2d9ca92b7 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-08-18.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-08-18.mdx @@ -1,16 +1,16 @@ ## 0.66.21 -**`(feat):`** Introduce an OpenAPI setting called `inline-all-of-schemas` which recursively -visits the scheme definitions of allOf schemas and inlines them into the child. +**`(feat):`** Introduce an OpenAPI setting called `inline-all-of-schemas` which recursively +visits the scheme definitions of allOf schemas and inlines them into the child. -The benefit of doing this is that a child schema can modify whether or not a parent -property is required. Without this setting, Fern would ignore the child schema's -declaration of optional and prefer the parent schema's instead. +The benefit of doing this is that a child schema can modify whether or not a parent +property is required. Without this setting, Fern would ignore the child schema's +declaration of optional and prefer the parent schema's instead. -Add the following to your `generators.yml`: +Add the following to your `generators.yml`: -```yml generators.yml -api: - settings: +```yml generators.yml +api: + settings: inline-all-of-schemas: true ``` diff --git a/fern/products/cli-api-reference/cli-changelog/2025-08-22.mdx b/fern/products/cli-api-reference/cli-changelog/2025-08-22.mdx index 7626aadcf..49da7efad 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-08-22.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-08-22.mdx @@ -1,3 +1,6 @@ +## 0.66.23 +**`(feat):`** Add support for `const` JSON schema keyword, which parses to a single-valued enum. + ## 0.66.22 **`(fix):`** Nested protobuf types have correct type ids in converted ir.