🌿 ✨ [Scheduled] Upgrade Fern CLI

[fern-api]

Upgrading from 0.39.1 to 0.41.13 - Changelog

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.

33 additional updates, see more




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

[github-actions]

🌿 Preview your docs: https://ssoready-preview-9e1e57d9-5cef-4847-a557-7ef29c0b2a72.docs.buildwithfern.com/docs

[ucarion]

you got it, robot!