🌿 ✨ [Scheduled] Upgrade Fern CLI

[fern-api]

Upgrading from 0.37.0 to 0.46.10 - Changelog

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.

175 additional updates, see more




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.

0.45.0-rc12

fix: Undiscriminated unions are now represented using anyOf in the generated JSON Schema
Nullable properties are now correctly propagated to the JSON Schema

0.45.0-rc11

fix: Improved JSON Schema generation for object inheritance:

• Removed the use of allOf for representing object extensions
• Properties from parent objects are now directly added to the child object in the JSON Schema

0.45.0-rc10

fix: Added support for additionalProperties on export to JSON Schema.

0.45.0-rc9

fix: Improved JSON Schema generation for object extensions and const values:

• Object extensions are now properly represented using allOf in the JSON Schema
• Literal values (string and boolean) are now correctly represented using const in the JSON Schema

0.45.0-rc8

internal: Add #!/usr/bin/env node to the CLI to prevent runtime errors.

0.45.0-rc7

internal: Stop minifying the CLI to prevent javascript runtime errors.

0.45.0-rc6

fix: Update the CLI package.json to include the correct files.

0.45.0-rc5

feat: Introduce a new command fern jsonschema <output-file> --type <type-name>
that outputs the JSON Schema for a given type in your Fern Definition.

fern jsonschema ./schema.json --type MyType

0.45.0-rc4

chore: SCIM has been added as a common initialism.

0.45.0-rc3

fix: Numerous fixes to the Conjure API Importer such as reading in request bodies and query parameters.

0.45.0-rc2

fix: The CLI now generates endpoint examples for undiscriminated unions that are recusive.

0.45.0-rc1

fix: The OpenAPI importer now generates streaming examples based on OpenAPI examples.

0.45.0-rc0

fix: The Docs now support rendering additionalProperties in the API Playground so that users can send out arbitrary key,value pairs.

0.44.11

fix: Several improvements to the conjure importer.

0.44.10

fix: API update now supports consuming the API origin from spec V2 configurations.

0.44.9

feat: The fern definition now supports descriptions supplied on request and response bodies.
You can enable this by simply supplying docs in your fern definition, or description
in your OpenAPI spec.

0.44.8

fix: API Configuration V2 schema now takes in origin as well, allowing fern api update to function as expected in the new config.

0.44.7

internal: The Fern CLI command fern generator list now accepts filters for the output mode, for example, you may now specify fern generator list --excluded-modes local-file-system
in order to filter any generators from the list that are outputting locally.

0.44.6

fix: The Fern Definition respects endpoint level base-path overrides when validating examples.

0.44.5

feat: The Fern Definition now supports overriding base-path at the endpoint level.
This is useful if you have subset of endpoints that do not live at the
configured base-path.

service:
  endpoints:
    getMovie:
      method: POST
      base-path: "latest/" # overrides the base-path configured in api.yml
      path: "movies/{movieId}"

0.44.4

fix: Fern's OpenAPI importer will now handle generating examples for declared
errors so that they show up in the generated documentation.

0.44.3

feat: Fern's OpenAPI importer can now handle readOnly properties in the top level
request schema. Note that Fern does not handle nested readOnly properties
just yet; please file a GitHub issue if this is important!

0.44.2

fix: Fern's OpenAPI importer can now handle multiple error schemas for the
same status code.

0.44.1

feat: The OpenAPI importer used to try and coerce all enums into a literals.
In some cases this is not desirable, so we now expose an option called
coerce-enums-to-literals in your generators.yml.

api:
  specs:
    - openapi: ../openapi.json
      overrides: ../openapi-overrides.yml
      settings:
        title-as-schema-name: false
        coerce-enums-to-literals: false

0.44.0-rc0

feat: The Fern CLI now supports parsing Conjure, Palantir's
home-grown API Definition format.

If you know a company that is using Conjure that wants API Docs + SDKs, send them our way!

0.43.8

fix: Any markdown files that have custom components are also pushed up to the Fern Docs
platform.

0.43.7

fix: The valid-markdown rule has been updated to try and parse the markdown file into a
valid AST. If the file fails to parse, fern check will log an error as well
as the path to the markdown.

0.43.6

fix: The OpenAPI importer now appropriately brings in responses that are under the text/event-stream
Content-Type if your endpoint is annotated with x-fern-streaming.
If your endpoint is not annotated with x-fern-streaming, then the response will be ignored.

0.43.5

fix: If you use the x-fern-streaming extension and want to provide different descriptions
for the streaming endpoint, then you can now specify streaming-description.

x-fern-streaming:
  stream-condition: $request.stream
  stream-description: The streaming version of this endpoint returns a series of chunks ...
  response:
    $ref: #/components/schemas/Response
  stream-response:
    $ref: #/components/schemas/ResponseChunk

0.43.4

fix: The OpenAPI parser now respects the content type in your OpenAPI spec, instead of always sending
application/json. With this upgrade, your SDKs will also start to send the correct content type.

0.43.3

chore: The CLI now passes in the API definition ID once again, this is necessary so that generated snippet templates
may reference schemas within the API. This was a regression that was recently introduced.

0.43.2

fix: The CLI now prints which API cannot be registered if fern generate --docs fails.

0.43.1

feat: The CLI now supports running OpenAPI generator 0.1.0 with IR version 53.

0.43.0

feat: The CLI now recognizes the fern-php-sdk generator.

0.42.15

internal: The documentation resolver now approrpiately creates a unique identifier for changelog sections. Previously, if you had multiple
changelogs within the same section, despite their title and slug being different, they would be treated as the same section since the ID
only took into account the parents' slug, appended the word "changelog" and that was all.

As a result previously all changelogs within the same section would get highlighted when one was selected, now only the selected changelog
is highlighted.

0.42.14

fix: The OpenAPI importer now correctly propagates the title field on oneof schemas.

0.42.13

fix: Example generation now intelligently truncates container examples, for example if the depth limit will be reached on a list of objects,
the list will be returned as an empty list, as opposed the previous behavior where an unknown object would be created.

0.42.12

fix: Previously, deploying docs from Windows machines led to bad asset paths.
Now, the CLI respects Windows paths during run and web paths for retrieving
assets.

0.42.11

fix: The API V2 configuration now supports disabling using titles as schema
names. You may want to disable this flag if your OpenAPI adds the same
title to multiple schemas.

api:
  specs:
    - openapi: /path/to/openapi
      settings:
        use-title-as-schema-name: false

0.42.10

fix: Previously, the OpenAPI converter would bring over title on every
single property. This field is extraneous, so now we ignore it.

0.42.9

fix: Previously, the OpenAPI importer would ignore skip parsing arbitrary
content types "/". Now it treats this content type as application/json.

"responses": {
  "200": {
    "description": "Success reply",
    "content": {
      "*/*": {

0.42.8

fix: The API V2 configuration (in beta) now supports global header overrides.
This fixes a bug where those header overrides were getting dropped in
certain cases.

api:
  headers:
    X-API-VERSION: string
  specs:
    - openapi: /path/to/openapi
      overrides: /path/to/overrides

0.42.7

feat: The API V2 configuration (in beta) now supports global header
overrides. To specify global headers that are not in your
OpenAPI spec, simply add the following block in your generators.yml:

api:
  headers:
    X-API-VERSION: string
  specs:
    - openapi: /path/to/openapi
      overrides: /path/to/overrides

0.42.6

fix: Removes extraneous conditional error within namespacing configuration

0.42.5

feat: Adds additional metadata retrievable by fern generator get so you can now get the langauage and the target repo.

0.42.4

fix: Namespaced APIs now:

• No longer contain duplicative nesting of some endpoint within another package of the same name as the namespace
• Respect the x-fern-sdk-group-name annotation for endpoints

0.42.3

fix: The OpenAPI importer now supports handling encoding on multipart requests.
Previously, the generators would not respect the contentType field for
each form input. But, now they do.

requestBody:
  content:
    multipart/form-data:
      schema:
        type: object
        properties:
          file:
            type: string
            format: binary
            description: The file to upload
      encoding:
        file:
          contentType: "application/octet-stream"

fix: The OpenAPI importer now correctly parses descriptions of multipart
form requests. Previously these descriptions would be ignored.

For example, previously the description The file to upload would be
ignored in the example below.

requestBody:
  content:
    multipart/form-data:
      schema:
        type: object
        properties:
          file:
            type: string
            format: binary
            description: The file to upload

0.42.2

fix: Error bodies are now appropriately namespaced as well!

0.42.1

fix: Make sure to check for optionality when parsing stdout and stderr in CLI. This
removes the error: Cannot read properties of undefined (reading 'includes').

0.42.0

fix: If you merge multiple OpenAPI specs with namespaces, fern check will no longer
complain about duplicate schema names across namespaces.
In the example below, both OpenAPI specs can have duplicative schema names and
that is okay.

api:
  specs:
    - openapi: openapi-bar.yml
      namespace: bar
    - openapi: opneapi-foo.yml
      namespace: foo

0.42.0-rc0

feat: The Fern Definition now supports conten-type on multipart request properties.
For example, to specify an application/octet-stream and application/json
contnet types, use the snippet below:

service:
  endpoints:
    upload:
      request:
        body:
          properties:
            file:
              type: file
              content-type: application/octet-stream
            metadata:
              type: unknown
              content-type: application/json

0.41.16

fix: Previously the OpenAPI converter would incorrectly mark
the values of additionalProperties as optional. Now, we have
introduced a feature flag to turn this behavior off.

The feature flag can be configured in generators.yml:

api:
  specs:
    - openapi: /path/to/openapi
      settings:
        optional-additional-properties: false

0.41.15

internal: Performance improvements for stringifiying large Intermediate Representations. If
you have a large OpenAPI spec or Fern Definition, this can potentially shave off
minutes from fern generate.

0.41.14-rc2

internal: Remove bang operator and fix eslint warning in compatible-ir-versions.ts.

0.41.14-rc1

feat: Running fern check will now check to confirm that the generator versions you are running are compatible with your Fern CLI version.

Each version of SDK generators depends on a version of a libary that is exported by the Fern CLI, and as a result, each generator has a minimum
compatible version of the Fern CLI. As an example, if you were to run fern check while leveraging fernapi/fern-python-sdk version 2.0.0, on CLI version 0.1.3, you'd receive the following error:

The generator fernapi/fern-python-sdk requires CLI version 0.23.0-rc4 or later (current version: 0.1.3-rc0).

Indicating that you must upgrade your CLI in order to leverage the current generator.

0.41.14-rc0

fix: The Fern CLI now safely handles a npx file exists error by retrying the command on failure.
This error typically happens when two or more instances of the Fern CLI are running npx
at the same time.

0.41.13

fix: fern generate --local no longer crashes on large API Definitions because we
stream the JSON to file instead of calling JSON.stringify. See PR 4640.

0.41.12

feat: Adds availability to inlined properties for HTTP Requests, Webhooks, and WebSockets for Fern Definition and OpenAPI.
You can add availability like so:

Fern Definition:

Request:
  name: InlineRequest
  properties:
    random:
      type: string
      availability: pre-release

OpenAPI:

requestBody:
content:
  application/json:
    schema:
      type: object
      properties:
        random:
          type: string
          x-fern-availability: beta

0.41.11

feat: Adds availability and display-names to discriminated union values. Now, in your docs, you can mark your union values
with custom names and show their availability. You can do so by adding the following to your API definition:

MyUnionType:
  union:
    UnionValue1:
      docs: The first union value
      type: string
      display-name: Union Value One
      availability: beta
    UnionValue2:
      docs: The second union value
      type: integer
      display-name: Union Value Two
      availability: deprecated

0.41.10

feat: Adds availability and display-names to discriminated union values. Now, in your docs, you can mark your union values
with custom names and show their availability. You can do so by adding the following to your API definition:

MyUnionType:
  union:
    UnionValue1:
      docs: The first union value
      type: string
      display-name: Union Value One
      availability: beta
    UnionValue2:
      docs: The second union value
      type: integer
      display-name: Union Value Two
      availability: deprecated

0.41.9

internal: Adds a bundle-path hidden parameter for fern docs dev for use with fern-platform testing. You can pass the
path on the command line as an optional parameter.

0.41.8

feat: The Fern generators.yml configuration now supports a new format for namespacing APIs for additional flexibility:

api:
  specs:
    - openapi: path/to/v1/openapi
      overrides: path/to/v1/overrides
      namespace: v1
    - openapi: path/to/v2/openapi
      overrides: path/to/v2/overrides
      namespace: v2

Through namespacing your API, you can have multiple objects and endpoints with the same name across different namespaces. You can think of them
as the equivalent to Python modules or TypeScript packages.

0.41.7

fix: Previously we weren't always awaiting PostHog API calls directly. Now the CLI
awaits these calls so that we can ensure that events are sent.

0.41.6

feat: The Fern Docs CLI now supports OAuth 2.0 Client Credentials injection in API playgrounds.
To enable this feature, you can define the OAuth Authorization Scheme in your API configuration,
and enable the feature in your docs configuration.

API configuration:

api:
  auth-schemes:
    OAuth:
      scheme: oauth
      type: client-credentials
      get-token:
        endpoint: endpoint.authorization

More Information

Docs configuration:

navigation:
  section: API Reference
    playground:
      oauth: true

More Information

0.41.5

fix: Fix an issue with non-deterministic file ordering when OpenAPI is used as input.

0.41.4

feat: The Fern OpenAPI importer now handles importing an array for the type key.

User:
  properties:
    name:
      type: ["string"]
    id:
      type: ["string", "number"]

0.41.3

feat: Allow referencing by method and path. For example, when configuring an
oauth scheme you can now do:

auth-schemes:
  OAuth:
    scheme: oauth
    type: client-credentials
    get-token:
      endpoint: POST /oauth/token
api:
  auth: OAuth

0.41.2

fix: Fixes an issue introduced in 0.41.1 that ignored server urls for docs generation.

feat: Adds a auth-schemes and auth block where you can override auth for an existing spec.
See below:

auth-schemes:
  Oauth:
    scheme: oauth
    type: client-credentials
    get-token:
      endpoint: auth.get-token
api:
  auth: Oauth # overrides auth scheme
  specs:
    - openapi: path/to/openapi

0.41.1

feat: Adds a V2 configuration for the api block that is more flexible and allows
OpenAPI users to consume Fern Definition features.

For example, now you can override environments directly in the api configuration:

api:
  environments:
    Production: https://prod.com
    Staging: https://staging.com
  specs:
    - openapi: path/to/openapi
      overrides: path/to/overrides

If you want to define, multi-url environments, those can be done by configuring the following generators.yml:

api:
  environments:
    Production:
      urls:
        api: https://api.com
        auth: https://auth.com
    Staging:
        api: https://stagingapi.com
        auth: https://stagingauth.com
  specs:
    - openapi: path/to/openapi
      overrides: path/to/overrides

Note that you will need to use the x-fern-server-name annotation on each endpoint to assign it to a relevant server. For example,

paths:
  /api/users/:
    get:
      x-fern-server-name: api
  /token:
    post:
      x-fern-server-name: auth

0.41.0

feat: Adds generic object declarations to the fern definition. Now we can define generics and
use them in alias declarations to minimize code duplication:

types:
  GenericTest<T>:
    properties:
      value: T
      other-value: string

  GenericApplication:
    type: GenericTest<string>

More information can be found here: https://buildwithfern.com/learn/api-definition/fern/types#generics.

0.41.0-rc1

fix: Fix an issue where some postman environment variables (e.g. API key) were not substituted
when running fern generate.

0.41.0-rc0

break: Every fern folder that is using OpenAPI must configure an explicit location to the
OpenAPI spec. The location can be configured in your generators.yml:

api:
  path: path/to/openapi.yml

If you run fern upgrade, the CLI will automatically run a migration for you to
ensure that you are compliant!

0.40.4

fix: fern check allows the service base-path to be a slash. For example, the following
would be valid:

service:
  base-path: "/"

0.40.3

fix: Now fern generator upgrade respects the --group flag and only upgrades generators within a particular group.

0.40.2

internal: Release IR v53.9.0 which includes a publishing configuration.

0.40.1

feat: Enable specifying whether redirect in docs.yml is permanent or temporary.

0.40.0

feat: Update the fern generator upgrade command to leverage the Generator registry API as opposed to Docker and dockerode.

0.39.19

fix: The OpenAPI importer now appropriately generates examples for circular oneOf schemas.

0.39.18

fix: Produce IR v53.8.0 with raw datetime examples.

0.39.17

fix: object declarations with extends and no properties now has examples propagating in the Docs and SDKs

0.39.16

chore: Support running 0.2.x versions of the Postman Generator with IR V53 or above.

0.39.15

internal: Introduce generator list and organization commands to faciliate actions taken by fern-bot

0.39.14

fix: Format validation is enforced on date fields that are specified in examples specified in an api defintion.

0.39.13

fix: Generated examples in the Intermediate Representation not respect root level path parameter examples.

0.39.12

fix: The mock folder now includes source files, and the CLI no longer hard fails if it cannot resolve source files that are of OpenAPI type.

0.39.11

fix: The Fern CLI now handles parsing x-fern-parameter-name on path parameters in an OpenAPI spec.

0.39.10

chore: Release 0.39.10

0.39.9

chore: Release 0.39.9

0.39.7

chore: ## What's Changed

• (feature, csharp): Generate well-known types by @amckinney in (feature, csharp): Generate well-known types fern-api/fern#4319
• fix: fix seed, move unit test to right CoreUtility by @RohinBhargava in fix: fix seed, move unit test to right CoreUtility fern-api/fern#4324
• fix(openapi): generate examples with latest schemas by @dsinghvi in fix(openapi): generate examples with latest schemas fern-api/fern#4329

Full Changelog: fern-api/fern@0.39.6...0.39.7

0.39.6

chore: ## What's Changed

• fix (ir): upgrade pydantic generator by @dsinghvi in fix (ir): upgrade pydantic generator fern-api/fern#4320
• fix(ir): autogenerate ir sdks on version bump by @dsinghvi in fix(ir): autogenerate ir sdks on version bump fern-api/fern#4321
• fix(python): upgrade ir sdk to handle null unknown types by @dsinghvi in fix(python): upgrade ir sdk to handle null unknown types fern-api/fern#4322
• fix: add names to form data files by @RohinBhargava in fix: add names to form data files fern-api/fern#4323
• fix(docs): global path parameter examples are respected by @dsinghvi in fix(docs): global path parameter examples are respected fern-api/fern#4325

Full Changelog: fern-api/fern@0.39.5...0.39.6

0.39.5

chore: ## What's Changed

• (fix): add docs for webhook inlining by @dsinghvi in (fix): add docs for webhook inlining fern-api/fern#4314
• (chore): add any-auth test definition by @dsinghvi in (chore): add any-auth test definition fern-api/fern#4297
• (docs): hide a page from sidebar nav and search by @dannysheridan in (docs): hide a page from sidebar nav and search fern-api/fern#4312
• (fix): fdr test update snapshots by @dsinghvi in (fix): fdr test update snapshots fern-api/fern#4318
• feat: add schema definitions for popular analytics providers to the docs generator config by @pujitm in feat: add schema definitions for popular analytics providers to the docs generator config fern-api/fern#4291

Full Changelog: fern-api/fern@0.39.4...0.39.5

0.39.4

chore: ## What's Changed

• (fix): update ete test snapshots by @dsinghvi in (fix): update ete test snapshots fern-api/fern#4311
• bump Python generator versions by @armandobelardo in bump Python generator versions fern-api/fern#4308
• fix: add in asyncapi tagging with namespaces by @armandobelardo in fix: add in asyncapi tagging with namespaces fern-api/fern#4313

Full Changelog: fern-api/fern@0.39.3...0.39.4

0.39.3

chore: ## What's Changed

• (fix, docs): docs now respect ir base path by @dsinghvi in (fix, docs): docs now respect ir base path fern-api/fern#4310

Full Changelog: fern-api/fern@0.39.2...0.39.3

0.39.2

chore: ## What's Changed

• feat: allow namespacing an API from generators.yml by @armandobelardo in feat: allow namespacing an API from generators.yml fern-api/fern#4290
• fix: unions with utils re-force update refs by @armandobelardo in fix: unions with utils re-force update refs fern-api/fern#4296
• (feature, csharp): Generate gRPC core utilities by @amckinney in (feature, csharp): Generate gRPC core utilities fern-api/fern#4298
• Update publish-docs command post-migration by @armandobelardo in Update publish-docs command post-migration fern-api/fern#4300
• Run publish-docs.yml if it's updated by @armandobelardo in Run publish-docs.yml if it's updated fern-api/fern#4301
• document redirects by @chdeskur in document redirects fern-api/fern#4299
• (docs): add to our Welcome page that this docs site is built with Fern by @dannysheridan in (docs): add to our Welcome page that this docs site is built with Fern fern-api/fern#4307
• add information on regex redirects by @chdeskur in add information on regex redirects fern-api/fern#4306
• fix: read templated env vars in the docs generator config by @pujitm in fix: read templated env vars in the docs generator config fern-api/fern#4287
• improvement: improve .dict speed by limiting dict calls by @armandobelardo in improvement: improve .dict speed by limiting dict calls fern-api/fern#4302
• improvement: python handles arrays of deep object query parameters by @armandobelardo in improvement: python handles arrays of deep object query parameters fern-api/fern#4304
• (fix): docs take into account global path params and now we add tests by @dsinghvi in (fix): docs take into account global path params and now we add tests fern-api/fern#4309

New Contributors

• @pujitm made their first contribution in fix: read templated env vars in the docs generator config fern-api/fern#4287

Full Changelog: fern-api/fern@0.39.1...0.39.2

0.39.1

chore: ## What's Changed

• chore: update fern logo by @dannysheridan in chore: update fern logo fern-api/fern#4295
• fix (mock server): make date comparison against true dates as opposed to string comp by @armandobelardo in fix (mock server): make date comparison against true dates as opposed to string comp fern-api/fern#4278

Full Changelog: fern-api/fern@0.38.1...0.39.1

0.38.1

chore: ## What's Changed

• (feat, docs): add docs on api.yml and environment audiences by @dsinghvi in (feat, docs): add docs on api.yml and environment audiences fern-api/fern#4292
• (fix): ir generation respects disable examples by @dsinghvi in (fix): ir generation respects disable examples fern-api/fern#4293
• (fix, python): check autogenerated examples before indexing by @dsinghvi in (fix, python): check autogenerated examples before indexing fern-api/fern#4294

Full Changelog: fern-api/fern@0.38.0...0.38.1

0.38.0

chore: ## What's Changed

• (fix): retrigger typescript sdk publishing by @dsinghvi in (fix): retrigger typescript sdk publishing fern-api/fern#4289

Full Changelog: fern-api/fern@0.38.0-rc1...0.38.0

0.38.0-rc1

chore: ## What's Changed

• (feat, typescript): support hasNextPage property for offset pagination by @dsinghvi in (feat, typescript): support hasNextPage property for offset pagination fern-api/fern#4288
• (feature, cli): Upload source files to S3 by @amckinney in (feature, cli): Upload source files to S3 fern-api/fern#4286

Full Changelog: fern-api/fern@0.38.0-rc0...0.38.0-rc1

0.38.0-rc0

chore: ## What's Changed

• (feat, python): move to ruff for formatting by @dsinghvi in (feat, python): move to ruff for formatting fern-api/fern#4219
• improvement: improve discriminated union object naming by @armandobelardo in improvement: improve discriminated union object naming fern-api/fern#4243
• (feature): Add encoding and source nodes by @amckinney in (feature): Add encoding and source nodes fern-api/fern#4240
• (feat, cli): add has-next-page property to IR by @dsinghvi in (feat, cli): add has-next-page property to IR fern-api/fern#4241
• feat (wip): add playground settings for API playground by @RohinBhargava in feat (wip): add playground settings for API playground fern-api/fern#4245
• fix: remove wraps from fastapi validators by @armandobelardo in fix: remove wraps from fastapi validators fern-api/fern#4246
• fix: make model_validator take kwargs by @armandobelardo in fix: make model_validator take kwargs fern-api/fern#4247
• (feat): refactor how pagination properties are checked in fern check by @dsinghvi in (feat): refactor how pagination properties are checked in fern check fern-api/fern#4250
• (feature): Add support for x-fern-encoding by @amckinney in (feature): Add support for x-fern-encoding fern-api/fern#4249
• (chore): Remove fhir.json by @amckinney in (chore): Remove fhir.json fern-api/fern#4253
• c#, improvements: small improvements including marking files internal + client classes partial by @dcb6 in c#, improvements: small improvements including marking files internal + client classes partial fern-api/fern#4248
• c#, improvement: Use FluentAssertions in unit tests by @dcb6 in c#, improvement: Use FluentAssertions in unit tests fern-api/fern#4254
• (feat): wire through api workspaces to docs validator by @dsinghvi in (feat): wire through api workspaces to docs validator fern-api/fern#4255
• (feat): upgrade to yarn v4 by @dsinghvi in (feat): upgrade to yarn v4 fern-api/fern#4257
• c#, improvements: breaking change with several small improvements by @dcb6 in c#, improvements: breaking change with several small improvements fern-api/fern#4260
• feat, python: add in true forward compat enums by @armandobelardo in feat, python: add in true forward compat enums fern-api/fern#4262
• (feature): Copy source files in seed tests by @amckinney in (feature): Copy source files in seed tests fern-api/fern#4258
• c#, improvement: use string response directly in generic exception by @dcb6 in c#, improvement: use string response directly in generic exception fern-api/fern#4264
• (internal): pnpm migration by @dsinghvi in (internal): pnpm migration fern-api/fern#4261
• Remove old documentation references from README by @armandobelardo in Remove old documentation references from README fern-api/fern#4265
• Fix typo in pr-preview.mdx by @zachkirsch in Fix typo in pr-preview.mdx fern-api/fern#4235
• (chore): Update pnpm-lock.yaml by @amckinney in (chore): Update pnpm-lock.yaml fern-api/fern#4266
• (fix): run compile on every PR by @dsinghvi in (fix): run compile on every PR fern-api/fern#4267
• (fix): live tests continue to work in the pnpm era by @dsinghvi in (fix): live tests continue to work in the pnpm era fern-api/fern#4268
• (chore): Remove all yarn files by @amckinney in (chore): Remove all yarn files fern-api/fern#4269
• (chore, ir): Use latest TypeScript generator by @amckinney in (chore, ir): Use latest TypeScript generator fern-api/fern#4271
• (chore, ruby): Remove ir-sdk from generator-commons by @amckinney in (chore, ruby): Remove ir-sdk from generator-commons fern-api/fern#4272
• (fix): bump to 53.6.x by @dsinghvi in (fix): bump to 53.6.x fern-api/fern#4273
• (fix): get seed working by deleting yarn ref by @dsinghvi in (fix): get seed working by deleting yarn ref fern-api/fern#4274
• (feature, csharp): Write Protobuf dependencies in .csproj by @amckinney in (feature, csharp): Write Protobuf dependencies in .csproj fern-api/fern#4270
• c#, fix: fix type conflicts by @dcb6 in c#, fix: fix type conflicts fern-api/fern#4244
• (fix): ir generation for examples is stable so that ete tests work by @dsinghvi in (fix): ir generation for examples is stable so that ete tests work fern-api/fern#4276
• fix: add validation around selectable environments for playground settings by @RohinBhargava in fix: add validation around selectable environments for playground settings fern-api/fern#4252
• (chore, csharp): Release 1.2.1 by @amckinney in (chore, csharp): Release 1.2.1 fern-api/fern#4284
• (followup): add tests for playground validation messages by @dsinghvi in (followup): add tests for playground validation messages fern-api/fern#4283
• ir: add shape to ExampleQueryParameter by @dcb6 in ir: add shape to ExampleQueryParameter fern-api/fern#4222
• (fix): eslint is now a required check and will pass by @dsinghvi in (fix): eslint is now a required check and will pass fern-api/fern#4285

Full Changelog: fern-api/fern@0.37.16...0.38.0-rc0

0.37.16

chore: ## What's Changed

• fix, python: make circular references more robust by @armandobelardo in fix, python: make circular references more robust fern-api/fern#4216
• improvement: allow naming for asyncapi messages to pull message name by @armandobelardo in improvement: allow naming for asyncapi messages to pull message name fern-api/fern#4228
• c#, fix: class names + namespace conflicts by @dcb6 in c#, fix: class names + namespace conflicts fern-api/fern#4229
• Add support for anonymous usage of the generate CLI by @antoniomdk in Add support for anonymous usage of the generate CLI fern-api/fern#4239
• (fix, docs): filter referenced subpackages appropriately by @dsinghvi in (fix, docs): filter referenced subpackages appropriately fern-api/fern#4242

New Contributors

• @antoniomdk made their first contribution in Add support for anonymous usage of the generate CLI fern-api/fern#4239

Full Changelog: fern-api/fern@0.37.15...0.37.16

0.37.15

chore: ## What's Changed

• improvement: respect returning nested properties in python by @armandobelardo in improvement: respect returning nested properties in python fern-api/fern#4236
• (feature): Add support for .proto inputs by @amckinney in (feature): Add support for .proto inputs fern-api/fern#4223
• custom segment write key by @abarrell in custom segment write key fern-api/fern#4238

Full Changelog: fern-api/fern@0.37.14...0.37.15

0.37.14

chore: ## What's Changed

• fix: address TS UT fetcher flakiness by @RohinBhargava in fix: address TS UT fetcher flakiness fern-api/fern#4226
• chore: bump ir sdk to new Python generator by @armandobelardo in chore: bump ir sdk to new Python generator fern-api/fern#4214
• feat: hide TOC on docs home page by @zachkirsch in feat: hide TOC on docs home page fern-api/fern#4230
• (fix, go): Required properties don't specify omitempty by @amckinney in (fix, go): Required properties don't specify omitempty fern-api/fern#4231
• (feat, in progress): ir supports user agent headers by @dsinghvi in (feat, in progress): ir supports user agent headers fern-api/fern#4232
• (fix): LaTeX by @abvthecity in (fix): LaTeX fern-api/fern#4233
• (feat, typescript): send user agent header <package>/<version> by @dsinghvi in (feat, typescript): send user agent header <package>/<version> fern-api/fern#4234

Full Changelog: fern-api/fern@0.37.13...0.37.14

0.37.14-rc0

chore: ## What's Changed

• fix: address TS UT fetcher flakiness by @RohinBhargava in fix: address TS UT fetcher flakiness fern-api/fern#4226
• chore: bump ir sdk to new Python generator by @armandobelardo in chore: bump ir sdk to new Python generator fern-api/fern#4214
• feat: hide TOC on docs home page by @zachkirsch in feat: hide TOC on docs home page fern-api/fern#4230
• (fix, go): Required properties don't specify omitempty by @amckinney in (fix, go): Required properties don't specify omitempty fern-api/fern#4231
• (feat, in progress): ir supports user agent headers by @dsinghvi in (feat, in progress): ir supports user agent headers fern-api/fern#4232
• (fix): LaTeX by @abvthecity in (fix): LaTeX fern-api/fern#4233

Full Changelog: fern-api/fern@0.37.13...0.37.14-rc0

0.37.13

chore: ## What's Changed

• (fix): reload docs preview server on specs outside of the fern folder by @dsinghvi in (fix): reload docs preview server on specs outside of the fern folder fern-api/fern#4227

Full Changelog: fern-api/fern@0.37.12...0.37.13

0.37.12

chore: ## What's Changed

• update cli to use default language by @abarrell in update cli to use default language fern-api/fern#4218
• (fix, openapi parser): generated fern definitions respect OpenAPI tag casing by @dsinghvi in (fix, openapi parser): generated fern definitions respect OpenAPI tag casing fern-api/fern#4225

Full Changelog: fern-api/fern@0.37.11...0.37.12

0.37.11

chore: ## What's Changed

• Fix issue where misconfigured directory could cause unhelpful error message by @abarrell in Fix issue where misconfigured directory could cause unhelpful error message fern-api/fern#4206

New Contributors

• @abarrell made their first contribution in Fix issue where misconfigured directory could cause unhelpful error message fern-api/fern#4206

Full Changelog: fern-api/fern@0.37.10...0.37.11

0.37.10

chore: ## What's Changed

• fix: if audience is filtering and no audiences exist on environments, add all environments by @RohinBhargava in fix: if audience is filtering and no audiences exist on environments, add all environments fern-api/fern#4220

Full Changelog: fern-api/fern@0.37.9...0.37.10

0.37.9

chore: ## What's Changed

• (fix): support base properties when filtering for audiences by @dsinghvi in (fix): support base properties when filtering for audiences fern-api/fern#4221

Full Changelog: fern-api/fern@0.37.8...0.37.9

0.37.8

chore: ## What's Changed

• (feat): cli caches api dependencies by @dsinghvi in (feat): cli caches api dependencies fern-api/fern#4201

Full Changelog: fern-api/fern@0.37.7...0.37.8

0.37.7

chore: ## What's Changed

• fix: python readme generation regression by @armandobelardo in fix: python readme generation regression fern-api/fern#4193
• fix, python: allow extending alias types by @armandobelardo in fix, python: allow extending alias types fern-api/fern#4190
• (internal): setup flamegraph generation for python generator by @dsinghvi in (internal): setup flamegraph generation for python generator fern-api/fern#4196
• fix, python: Optional and aliased literals are populated in snippets by @armandobelardo in fix, python: Optional and aliased literals are populated in snippets fern-api/fern#4184
• (feat, python): upgrade python generator to pydantic v2 by @dsinghvi in (feat, python): upgrade python generator to pydantic v2 fern-api/fern#4197
• fix: add async iterable symbol to Stream Wrapper implementations by @RohinBhargava in fix: add async iterable symbol to Stream Wrapper implementations fern-api/fern#4195
• feat: environment filter by audience by @RohinBhargava in feat: environment filter by audience fern-api/fern#4187
• (feat, python): use ruff for formatting by @dsinghvi in (feat, python): use ruff for formatting fern-api/fern#4199
• Revert "(feat, python): use ruff for formatting" by @dsinghvi in Revert "(feat, python): use ruff for formatting" fern-api/fern#4200
• fix, python + ts: additional template bugs by @armandobelardo in fix, python + ts: additional template bugs fern-api/fern#4198
• fix: remove reserved properties from function signatures by @armandobelardo in fix: remove reserved properties from function signatures fern-api/fern#4205
• fix, ir-generation: put fully substituted path in url field of auto-generated EndpointExampleCalls by @dcb6 in fix, ir-generation: put fully substituted path in url field of auto-generated EndpointExampleCalls fern-api/fern#4211
• fix, python: allow typing any to be wrapped in optional to match Pydantic v2 by @armandobelardo in fix, python: allow typing any to be wrapped in optional to match Pydantic v2 fern-api/fern#4203
• improvement: bring back wrapped aliases and custom root validators in… by @armandobelardo in improvement: bring back wrapped aliases and custom root validators in… fern-api/fern#4204
• fix: typehinting on unions with visitors has been corrected by @armandobelardo in fix: typehinting on unions with visitors has been corrected fern-api/fern#4213
• Update speakeasy.mdx by @dannysheridan in Update speakeasy.mdx fern-api/fern#4215
• improvement: allow pydantic generator to specify package name by @armandobelardo in improvement: allow pydantic generator to specify package name fern-api/fern#4217
• (feature): Add Protobuf mapper types by @amckinney in (feature): Add Protobuf mapper types fern-api/fern#4210

Full Changelog: fern-api/fern@0.37.6...0.37.7

0.37.6

chore: ## What's Changed

• fix: add literal properties back to typeddict snippets by @armandobelardo in fix: add literal properties back to typeddict snippets fern-api/fern#4173
• (fix, typescript): wire noScripts into a PersistedProject and introduce a test by @dsinghvi in (fix, typescript): wire noScripts into a PersistedProject and introduce a test fern-api/fern#4185
• (feat, fastapi): introduce endpoint specific async handlers in fastapi by @dsinghvi in (feat, fastapi): introduce endpoint specific async handlers in fastapi fern-api/fern#4188
• fix: python readme references request options correctly by @armandobelardo in fix: python readme references request options correctly fern-api/fern#4189
• fix: replace referenced markdown by @abvthecity in fix: replace referenced markdown fern-api/fern#4191

Full Changelog: fern-api/fern@0.37.5...0.37.6

0.37.5

chore: ## What's Changed

• chore, ts: generate union v2 templates by @armandobelardo in chore, ts: generate union v2 templates fern-api/fern#4169
• (feature, csharp): Add customizable exception class names by @amckinney in (feature, csharp): Add customizable exception class names fern-api/fern#4181
• (fix, typescript): introduce no scripts option by @dsinghvi in (fix, typescript): introduce no scripts option fern-api/fern#4179

Full Changelog: fern-api/fern@0.37.4...0.37.5

0.37.4

chore: ## What's Changed

• (fix, docs): validate api workspaces as in addition to docs workspaces by @dsinghvi in (fix, docs): validate api workspaces as in addition to docs workspaces fern-api/fern#4178

Full Changelog: fern-api/fern@0.37.3...0.37.4

0.37.3

chore: ## What's Changed

• (fix): handle loggable fern cli error by @dsinghvi in (fix): handle loggable fern cli error fern-api/fern#4175
• (fix): add tests for alias extends by @dsinghvi in (fix): add tests for alias extends fern-api/fern#4176
• (fix): docs preview server falls back to previous bundle by @dsinghvi in (fix): docs preview server falls back to previous bundle fern-api/fern#4177

Full Changelog: fern-api/fern@0.37.2...0.37.3

0.37.2

chore: ## What's Changed

• (feature, csharp): Add RequestOptions by @amckinney in (feature, csharp): Add RequestOptions fern-api/fern#4166
• c#, improvement: error parsing by @dcb6 in c#, improvement: error parsing  fern-api/fern#4168
• (fix): introduce extended properties into the IR by @dsinghvi in (fix): introduce extended properties into the IR fern-api/fern#4171
• fix: OSS workspace settings propogate to APIs with dependencies by @armandobelardo in fix: OSS workspace settings propogate to APIs with dependencies fern-api/fern#4147
• chore, python: generate union v2 templates by @armandobelardo in chore, python: generate union v2 templates fern-api/fern#4167
• c# improvement: text responses + inlined request body inheritance by @dcb6 in c# improvement: text responses + inlined request body inheritance fern-api/fern#4172

Full Changelog: fern-api/fern@0.37.1...0.37.2

0.37.1

chore: ## What's Changed

• make @dcb6 codeowner for java + csharp by @dcb6 in make @dcb6 codeowner for java + csharp fern-api/fern#4163
• (beta, typescript): feature flag test generation that actually works by @dsinghvi in (beta, typescript): feature flag test generation that actually works fern-api/fern#4164
• fix: add images from frontmatter as well by @RohinBhargava in fix: add images from frontmatter as well fern-api/fern#4156
• (fix, docs): ir to fdr converter sends global headers by @dsinghvi in (fix, docs): ir to fdr converter sends global headers fern-api/fern#4170

Full Changelog: fern-api/fern@0.37.0...0.37.1