Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-04-09.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Original file line number Diff line number Diff line change
@@ -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.


6 changes: 3 additions & 3 deletions fern/products/cli-api-reference/cli-changelog/2025-04-21.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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".


6 changes: 3 additions & 3 deletions fern/products/cli-api-reference/cli-changelog/2025-04-22.mdx
Original file line number Diff line number Diff line change
@@ -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.


4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-04-24.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


6 changes: 3 additions & 3 deletions fern/products/cli-api-reference/cli-changelog/2025-04-26.mdx
Original file line number Diff line number Diff line change
@@ -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.


8 changes: 4 additions & 4 deletions fern/products/cli-api-reference/cli-changelog/2025-04-27.mdx
Original file line number Diff line number Diff line change
@@ -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.


Expand Down
6 changes: 3 additions & 3 deletions fern/products/cli-api-reference/cli-changelog/2025-04-29.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand All @@ -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.


8 changes: 4 additions & 4 deletions fern/products/cli-api-reference/cli-changelog/2025-04-30.mdx
Original file line number Diff line number Diff line change
@@ -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.


6 changes: 3 additions & 3 deletions fern/products/cli-api-reference/cli-changelog/2025-05-01.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


10 changes: 5 additions & 5 deletions fern/products/cli-api-reference/cli-changelog/2025-05-02.mdx
Original file line number Diff line number Diff line change
@@ -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.


Expand All @@ -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.


8 changes: 4 additions & 4 deletions fern/products/cli-api-reference/cli-changelog/2025-05-03.mdx
Original file line number Diff line number Diff line change
@@ -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.


4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-05-09.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
Original file line number Diff line number Diff line change
@@ -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.


Expand Down
8 changes: 4 additions & 4 deletions fern/products/cli-api-reference/cli-changelog/2025-05-16.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<Code>` 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 `<Code>` 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.


4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-05-17.mdx
Original file line number Diff line number Diff line change
@@ -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.


4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-05-21.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
```yaml
- name: fernapi/fern-typescript-sdk
version: 0.48.5
api:
api:
auth: bearer
```

Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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`


Expand Down
16 changes: 8 additions & 8 deletions fern/products/cli-api-reference/cli-changelog/2025-06-11.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-06-12.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.


4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-06-25.mdx
Original file line number Diff line number Diff line change
@@ -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.


Expand Down
4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-06-27.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Original file line number Diff line number Diff line change
@@ -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.


Expand Down
4 changes: 2 additions & 2 deletions fern/products/cli-api-reference/cli-changelog/2025-07-12.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading