🌿 ✨ [Scheduled] Upgrade Fern CLI

[fern-api]

Upgrading from 0.45.0-rc12 to 0.46.20 - Changelog

0.46.20

• feat: The fern init command now supports a --mintlify option. You can pass in
  the path to your mint.json and the Fern CLI will generate a fern documentation
  website.

0.46.19

• fix: If a schema in OpenAPI or AsyncAPI has additionalProperties: true then the Fern CLI will now respect bringing in
  example properties that are not defined in the schema. Previously, the CLI would skip them.

0.46.18

• fix: If an object or request is annotated with extra-properties: true then the user can provide an example that includes
  extra properties that are no longer in the schema.

  For example, check out this fern definition

  types:
    Item: 
      extra-properties: true
      properties:
        id: string
  
  
  service:
    auth: false
    base-path: ""
    endpoints:
      create:
        method: POST
        path: /item
        request:
          name: CreateItemRequest
          body:
            extra-properties: true
            properties:
              id: string
        response:
          type: Item
        examples:
          - name: "Item"
            request:
              id: "123"
              foo: "bar" # extra property in the example
            response:
              body:
                id: "123"
                foo: "bar" # extra property in the example

0.46.17

• fix: Support parsing string values for boolean defaults in OpenAPI schemas.

  • String values like "true" and "false" are now correctly parsed as boolean defaults.

0.46.16

• fix: Improve parsing of OpenAPI schemas with an array in the type property.

  • If the array contains "null", it is interpreted as nullable, and removed from the array.
  • If there is only a single item in the array (after removing "null"), it previously defaulted to unknown, but now the specified type is used.
69 additional updates, see more




0.46.15

fix: Fixed issue where user specified examples would be omitted in favor of autogenerated examples.

0.46.14

fix: Boolean default values are now propagated from the Fern Definition through to docs generation.

0.46.13

fix: Correctly omits readOnly query parameters during openapi to fern definition generation.

0.46.12

fix: The CLI now handles parsing service level path parameters with descriptions.
This fixes a regression introduced in the CLI since versions 0.45.x.

0.46.11

fix: Allow for configuring the depth of example generation in API Docs. For example,
if you want to generate optional properties that are 5 levels deep, you can add
the following configuration in your generators.yml

api:
  specs:
    - openapi: ./openapi.json
      settings:
        example-generation:
          response:
            max-depth: 10

0.46.10

fix: Correctly support AdditionalProperties on object schemas.

0.46.9

fix: SDK generation no longer hard-fails on single example generation errors.

0.46.8

fix: The CLI now auto generates SSE and JSON Streaming examples even if those are
not provided in the OpenAPI Spec or Fern Definition.

0.46.7

fix: The generated Fern Definition now properly supports default values for query parameters.

0.46.6

fix: The audiences property on WebSocket channels is now respected when filtering
the IR graph based on configured audiences.

0.46.5

fix: The OpenAPI parser now deduplicates headers that appear in both security schemes and
operation-level headers to avoid duplicate header declarations.

0.46.4

fix: The generated SSE examples always have data and event keys so that they are correct.

0.46.3

fix: The Fern CLI now supports generating examples for streaming SSE (server-sent-event)
endpoints.

0.46.2

feat: The Fern CLI now supports parsing a logo option from your frontmatter. If
you would like to override logo on a specific page you can do so by adding
the following:

---
logo: /path/to/my/logo
---

or

---
logo:
  light: /path/to/my/light/logo
  dark: /path/to/my/dark/logo
---

0.46.1

fix: Add support for setting the User-Agent header value for Go generators.

0.46.0

internal: No changes; promote 0.46.0-rc1 release candidate to minor version.

0.46.0-rc1

fix: * Set inline: true for inline enums imported from OpenAPI.

• Set inline: true for maps generated from OpenAPI additionalProperties.

0.46.0-rc0

feat: The Fern Definition now supports bytes as a response type.

  endpoints:
    download:
      response: bytes

0.45.4

fix: Defaults are no longer set on datetimes when converting to docs shapes.

0.45.4-rc1

chore: Unknown schemas are no longer incorrectly marked as additionalProperties: true.

0.45.4-rc0

fix: The CLI prompts the user to confirm output directory overwrites on fern generate.

0.45.3

fix: Unknown schemas are no longer incorrectly marked as additionalProperties: true.

0.45.2

fix: Example generation now respects read-only schemas when generating request examples.

0.45.1

internal: Add inline field to type declarations in the Fern definition and IR.
Add support for importing inline types from OpenAPI into Fern definition and IR.

0.45.1-rc0

fix: Generate valid examples using spec validation information; respect null entries during example generation.

0.45.0

internal: Several improvements to docs, conjure importer, and the cli.

0.45.0-rc55

internal: Docs generation now preserves original model schema names.

0.45.0-rc54

internal: Removes errant minimum and maximums for 'float' types for docs.

0.45.0-rc53

internal: Add support for the smart-casing flags in the IR commands.

0.45.0-rc52

fix: Fix bug where max length validation for strings were incorrectly plumbed.

0.45.0-rc51

feat: Add support for the inline-path-parameters setting in the OpenAPI
importer.

0.45.0-rc50

fix: Increase max recursive depth allowed for example validation.

0.45.0-rc49

fix: Add 'list' to reserved keywords for use in PHP generator.

0.45.0-rc48

feat: OAuth Client Credential Auth Scheme now supports the ability to optionally
set token header and prefix fields for use with docs playground.

auth-schemes:
  OAuth:
    scheme: oauth
    type: client-credentials
    token-header: Fern-Authorization
    token-prefix: Fern-Bearer
    ...

0.45.0-rc47

fix: Support SDK generation provided comma-delineated content-type values in OpenAPI specs.

0.45.0-rc46

fix: The IR handles converting example unions that are aliases.

0.45.0-rc45

fix: The IR handles converting example unions that are aliases.

0.45.0-rc44

fix: Update the IR's ServiceTypeReferenceInfo to include all transitive types
referenced by a service.

0.45.0-rc43

fix: Support non-standard HTTP code 498; Validate x-fern-examples during schema parsing.

0.45.0-rc42

fix: Log error message logging when encountering doc errors during preview server initiation.

0.45.0-rc41

fix: Fixes bug introduced in 0.45.0-rc33 where version slugs were not being generated correctly.

0.45.0-rc40

fix: Fixed bug in the Conjure importer where query parameters were overwritten during endpoint parameter parsing.

0.45.0-rc39

fix: The OpenAPI importer now supports correlating request and response examples by name. When an example name is shared
between a request body and response, they will be paired together in the generated Fern definition.

0.45.0-rc38

fix: The OpenAPI importer now supports respecting readonly properties in schemas. When enabled, readonly properties will be excluded from request bodies for
POST/PUT/PATCH endpoints. To enable this, configure the setting in your generators.yml:

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

0.45.0-rc37

internal: Support parsing alpha and beta version numbers of Fern generators

0.45.0-rc36

fix: The OpenAPI importer now supports importing deep object query parameters. To do this, you will
need to configure a setting in your generators.yml

api:
 specs:
   - openapi: ./path/to/openapi.yml
     settings:
       object-query-paramaters: true

0.45.0-rc35

fix: The OpenAPI importer now supports importing deep object query parameters. To do this, you will
need to configure a setting in your generators.yml

api: 
 specs: 
   - openapi: ./path/to/openapi.yml
     settings: 
       object-query-paramaters: true

0.45.0-rc34

internal: The CLI now recognizes the versions of the Go generator that require IRv53.

0.45.0-rc33

feat: The Fern CLI now supports roles and viewers in your docs configuration, if you are on the enteprise plan for docs:

roles:
  - internal
  - beta-users
  - enterprise-users

navigation:
  - section: Internal Section
    viewers:
      - internal
    contents:
      - page: Internal Page
        path: ./internal/page.mdx

0.45.0-rc32

fix: The OpenAPI importer now supports reading endpoints that have application/x-www-form-urlencoded requests

0.45.0-rc31

fix: The OpenAPI importer now parses webhook examples and generates examples for webhooks when none are provided.

0.45.0-rc30

fix: The OpenAPI importer now parses the examples field for primitive schema types like string, number, array and boolean.

0.45.0-rc29

feat: The OpenAPI importer now parses the examples field that may be present on OpenAPI 3.1 schemas.

0.45.0-rc28

feat: The OpenAPI importer now skips headers in a case-insensitive way (e.g. both "Content-Type" and "content-type" are skipped).

0.45.0-rc27

feat: The Conjure importer now brings in endpoint level descriptions.

0.45.0-rc26

feat: fern check handles validating unions that contain base properties.

0.45.0-rc25

internal: The Fern CLI temporarily does not support RBAC/Audiences (they will be added in again shortly).

0.45.0-rc24

fix: fern docs dev now runs in Node 16 - Node 22 environments.

0.45.0-rc23

fix: The docs dev server now correctly handles base paths.

0.45.0-rc22

fix: Fixes bug introduced in 0.45.0-rc20 where section children were dropped from the docs definition.

0.45.0-rc21

feat: The Fern CLI now supports orphaned pages in your docs configuration.

fix: The RBAC config model is now renamed to roles and viewers:

roles:
  - internal

navigation:
  - section: Internal Section
    viewers:
      - internal
    contents:
      - page: Internal Page
        path: ./internal/page.mdx

0.45.0-rc20

feat: The Fern CLI now supports audiences in your docs configuration:

# all audiences must be declared at the top level
audiences:
  - internal

navigation:
  - section: Internal Section
    audience: internal # audience is optional
    contents:
      - page: Internal Page
        path: ./internal/page.mdx

0.45.0-rc19

fix: - Respect x-fern-ignore extension in OpenAPI parameters.

0.45.0-rc18

fix: - Add additional debug logging to the CLI when downloading docs preview bundle

0.45.0-rc17

fix: - Improved union example generation by increasing depth for better handling of recursive structures.

• Updated Conjure importer to represent binary types as bytes for requests and file for responses in Fern.
• Added detailed error messages when 'fern docs dev' fails, accessible with --log-level debug.

0.45.0-rc16

fix: The Conjure importer now correctly keys the union subvariant by the property of the discriminant.

union:
  discriminant: type
  union:
    square: Square
    circle: Circle

is equal to the following Fern Definition:

union:
  discriminant: type
  types:
    square:
      type: Square
      key: square
    circle:
      type: Circle
      key: circle

0.45.0-rc15

fix: The Conjure importer now correctly imports base-path and docs from your conjure definition.

0.45.0-rc14

fix: The Fern CLI now uses a longer timeout to make HTTP requests, which should fix some flakyness with the docs registration process.

0.45.0-rc13

fix: The Fern CLI now uses a longer timeout to make HTTP requests, which should fix some flakyness with the docs registration process.

[github-actions]

🌿 Preview your docs: https://ssoready-preview-7924b6a4-f98b-4aea-84f4-1cc9d7000e06.docs.buildwithfern.com/docs

[github-actions]

🌿 Preview your docs: https://ssoready-preview-723b3812-d9f3-420a-bbbb-2b472e799140.docs.buildwithfern.com/docs

[github-actions]

🌿 Preview your docs: https://ssoready-preview-948892e9-b392-4170-b1fe-85442b7d8094.docs.buildwithfern.com/docs

[github-actions]

🌿 Preview your docs: https://ssoready-preview-c3408608-6423-4799-897c-ea8224a88ddc.docs.buildwithfern.com/docs

[github-actions]

🌿 Preview your docs: https://ssoready-preview-b227d2cd-9f67-4287-8fe9-0b68134d3a70.docs.buildwithfern.com/docs

[github-actions]

🌿 Preview your docs: https://ssoready-preview-bd80229e-2e98-4ba9-974a-22a1c8f2f6da.docs.buildwithfern.com/docs

[github-actions]

🌿 Preview your docs: https://ssoready-preview-69bc1bc7-f843-480c-ad57-cfb390ede6a8.docs.buildwithfern.com/docs