🌿 ✨ [Scheduled] Upgrade Fern CLI

[fern-api]

Upgrading from 0.46.22 to 0.51.17 - Changelog

0.51.17

• fix: The OpenRPC parser now handles displaying parameters as object examples.

0.51.16

• fix: The OpenRPC parser now handles displaying parameters as object examples.

0.51.15

• fix: The OpenRPC parser now handles displaying optional parameters in the request.

0.51.14

• fix: Updates whatwg so that users eliminate punycode deprecation warning.

0.51.13

• fix: OpenAPI overrides now support resolving file references from the location of the
  OpenAPI overrides file itself. Previously, relative paths were only resolved from
  the OpenAPI source file.

  Most users will experience no change, but this will enable a wider set of file
  directory layouts depending on the user's preference.

43 additional updates, see more




0.51.12

fix: The Fern Definition now allows you to declare status codes for the response without having a type.
This is useful for 204 response status codes.

service: 
  auth: false
  base-path: /users
  endpoints: 
    update: 
      path: ""
      response: 
        status-code: 204        

0.51.11

fix: The OpenAPI parser generates response examples that are {} for 204 response types.

0.51.10

fix: The OpenAPI parser generates response examples that are {} for 204 response types.

0.51.9

fix: Fixed OpenAPI importer to properly handle response status codes in documentation by propagating
the status code from the OpenAPI spec through the IR and FDR layers.

0.51.8

fix: Fixed OpenAPI importer to properly handle response status codes in documentation by propagating
the status code from the OpenAPI spec through the IR and FDR layers.

0.51.7

fix: Added better error messages when markdown files reference non-existent MDX files, showing the relative path
to the missing file rather than just indicating an invalid reference.

0.51.6

fix: Fixed OpenAPI importer to properly handle string enums that are specified as integers by coercing them to strings.

0.51.5

fix: Added a new rule to validate frontmatter parsing across markdown files, ensuring frontmatter
is properly formatted and can be parsed without errors.

0.51.4

fix: Various improvements to the Mintlify and Readme importers, including better default styling
and spec imports for Mintlify migrations.

0.51.3

fix: The OpenAPI parser now prefers the JSON Content-Type variant over
others (e.g. application/x-www-form-urlencoded).

0.51.2

fix: Improved error messages when docs.yml doesn't match schema by showing more specific
validation errors and including the path where the error occurred.

0.51.1

fix: Fixed x-fern-resolutions to properly handle escaped forward slashes ("~1") in schema references,
correctly converting them to "/" when resolving references.

0.51.0

feat: The CLI now supports a --readme flag pointing to the URL of a Readme generated docs site and
migrates existing documentation to a fern-compatible repository.

To use this feature:

fern init --readme https://url-to-readme-docs.com

0.50.17

fix: Improve performance of fern docs dev by only reloading the markdown content when
only markdown files are changed, avoiding unnecessary recompilation of the full docs.

0.50.16

fix: This PR improves the performance of fern docs dev:

• Fern does not generate examples if the user has provided them to us
• Temporarily comment out broken link checker until we make it faster

0.50.15

fix: Move example generation failure logs to trace level since they are not relevant
for users and add noise to debug logs.

0.50.14

fix: Fixes a bug where duplicate types in undiscriminated unions (oneOf in OpenAPI)
were not being deduped, which could lead to invalid generated code.

0.50.13

fix: Fixes a bug where --log-level debug does not include trace logs.

0.50.12

fix: Increase undici timeouts to make sure that fern generate --docs completes.

0.50.11

fix: The CLI now supports a --log-level trace option to filter out noise from the
debug log level.

0.50.10

fix: An addition to the broken link checker to further reduce false positives.

0.50.9

fix: The Fern CLI no longer logs the full API request when finishing docs registration,
reducing unnecessary log output.

0.50.8

fix: An additional fix to the OpenRPC parser for respecting tags when
organizing methods in the API Reference.

0.50.7

fix: The OpenRPC parser now respects method names as well as tags for
organization the navigation.

0.50.6

fix: The broken link checker is updated to reduce false positives.

0.50.5

fix: The Fern CLI is updated to create the organization if it doesn't exist when fern token is called.

0.50.4

internal: The docs.yml now supports a separate configuration for feature-flags which allows Fern to render
pieces of content depending on whether or not certain feature flags are enabled for particular user.

This feature is in alpha stage; please contact [email protected] to learn more!

navigation:
  - page: Page 1
    feature-flag: my-feature-flag-a # single boolean flag
  - page: Page 2
    feature: # multiple boolean flags
      - flag: my-feature-flag-a
      - flag: my-feature-flag-b
  - section: Section Title
    viewers: role-a
    feature-flag: # configurable match
      flag: my-feature-flag-a
      fallback-value: "ga"
      match: "beta"
    layout: []

0.50.3

internal: Fixes an issue where optional, nullable properties resulted in a double optional in the
IRv55 -> IRv54 migration.

0.50.2

fix: The docs now includes alpha support for parsing openrpc specs. To leverage this feature,
simply define an API section in your docs.yml and point at an openrpc spec.

navigation:
  - api: API Reference
    openrpc: <path to openrpc file>

0.50.1

fix: Fixes an issue where nullable schemas were not coerced into optional values.

fix: Fixes an issue where fern check would fail for optional, nullable properties.

0.50.0

internal: The CLI is capable of migrating the latest TypeScript generator to IRv55.

0.49.1

fix: The OpenAPI v2 parser now supports x-fern-global-headers and fixes an issue with generating webhook content.

0.49.0

feat: The OpenAPI importer now supports respecting nullable properties in schemas. When enabled, nullable properties will
be preserved in the generated SDK. By default (without this setting), nullable properties are treated as optional.
To enable this, configure the setting in your generators.yml:

api:
 specs:
   - openapi: ./path/to/openapi.yml
     settings:
       respect-nullable-schemas: true

0.48.1

fix: The Mintlify docs importer now correctly generates the proper display-name key in the docs.yml file.

0.48.0

feat: Adds support for nullable types in the Fern definition, such as the following:

types:
  User:
    properties:
      name: string
      email: nullable<string>

0.47.6

feat: The IR now pulls in additional request properties from the OAuth getToken endpoint to support custom OAuth schemas.

0.47.5

feat: Fixes an issue with broken link checking in the OpenAPI v2 parser.

0.47.4

feat: Allows for creating nullable types and pass formats on strings using the OpenAPI v2 parser.

0.47.3

feat: Add the JSON schema to the generators.yml file for validation and autocomplete.

0.47.2

feat: The CLI now supports checking for broken links in your docs. You will see warnings in fern check if your docs link to any
page that can't be resolved, and the --strict-broken-links option will cause the command to fail (exit with a non-zero exit code) if
any broken links are found. You can also run the new command fern docs broken-links to only check for broken links (ignoring
other possible errors), with the --strict option to cause the command to fail if any broken links are found.

0.47.1

feat: Fixes a bug where the OpenAPI parser stopped respecting the =unions: v1 setting in your generators.yml which configures the parser to generate more
idiomatic discriminated unions.

api:
  specs:
    - openapi: ./path/to/openapi.yml
      settings:
        unions: v1

0.47.0

feat: The CLI now supports publishing docs using the improved OpenAPI v2 parser. You can set openapi-parser-v2: true
in your docs.yml to use the new parser.

0.46.23

feat: The CLI now validates that method and group name overrides in OpenAPI settings are not duplicated.

[github-actions]

Published docs preview URL: https://devrev-preview-9b20b4f6-43ae-4280-a98b-d043bd4ed035.docs.buildwithfern.com

[github-actions]

Published docs preview URL: https://devrev-preview-837d44cf-ecce-45ac-875b-e1e4a1e4b8be.docs.buildwithfern.com

[github-actions]

Published docs preview URL: https://devrev-preview-5aeee105-e3a2-4312-8bb4-f7dcd3e428e7.docs.buildwithfern.com

[github-actions]

Published docs preview URL: https://devrev-preview-e3ae43b9-79f2-4dab-86fb-4054b3390a63.docs.buildwithfern.com