Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Upgrading from
0.33.1
to0.41.13
- Changelog0.41.13
fix:
fern generate --local
no longer crashes on large API Definitions because westream 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:
OpenAPI:
0.41.11
feat:
Adds availability and display-names to discriminated union values. Now, in your docs, you can mark your union valueswith custom names and show their availability. You can do so by adding the following to your API definition:
0.41.10
feat:
Adds availability and display-names to discriminated union values. Now, in your docs, you can mark your union valueswith custom names and show their availability. You can do so by adding the following to your API definition:
0.41.9
internal:
Adds abundle-path
hidden parameter forfern docs dev
for use withfern-platform
testing. You can pass thepath on the command line as an optional parameter.
68 additional updates, see more
0.41.8
feat:
The Fern generators.yml configuration now supports a new format for namespacing APIs for additional flexibility: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 CLIawaits 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:
More Information
Docs configuration:
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 thetype
key.0.41.3
feat:
Allow referencing by method and path. For example, when configuring anoauth scheme you can now do:
0.41.2
fix:
Fixes an issue introduced in0.41.1
that ignored server urls for docs generation.feat:
Adds aauth-schemes
andauth
block where you can override auth for an existing spec.See below:
0.41.1
feat:
Adds a V2 configuration for theapi
block that is more flexible and allowsOpenAPI users to consume Fern Definition features.
For example, now you can override environments directly in the api configuration:
If you want to define, multi-url environments, those can be done by configuring the following generators.yml:
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,0.41.0
feat:
Adds generic object declarations to the fern definition. Now we can define generics anduse them in alias declarations to minimize code duplication:
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 substitutedwhen running fern generate.
0.41.0-rc0
break:
Every fern folder that is using OpenAPI must configure an explicit location to theOpenAPI spec. The location can be configured in your
generators.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 followingwould be valid:
0.40.3
fix:
Nowfern 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 thefern 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 circularoneOf
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 SDKs0.39.16
chore:
Support running 0.2.x versions of the Postman Generator with IR V53 or above.0.39.15
internal:
Introducegenerator list
andorganization
commands to faciliate actions taken byfern-bot
0.39.14
fix:
Format validation is enforced ondate
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 parsingx-fern-parameter-name
on path parameters in an OpenAPI spec.0.39.10
chore:
Release 0.39.100.39.9
chore:
Release 0.39.90.39.7
chore:
## What's ChangedFull Changelog: fern-api/fern@0.39.6...0.39.7
0.39.6
chore:
## What's ChangedFull Changelog: fern-api/fern@0.39.5...0.39.6
0.39.5
chore:
## What's ChangedFull Changelog: fern-api/fern@0.39.4...0.39.5
0.39.4
chore:
## What's ChangedFull Changelog: fern-api/fern@0.39.3...0.39.4
0.39.3
chore:
## What's ChangedFull Changelog: fern-api/fern@0.39.2...0.39.3
0.39.2
chore:
## What's Changed.dict
speed by limiting dict calls by @armandobelardo in improvement: improve.dict
speed by limiting dict calls fern-api/fern#4302New Contributors
Full Changelog: fern-api/fern@0.39.1...0.39.2
0.39.1
chore:
## What's ChangedFull Changelog: fern-api/fern@0.38.1...0.39.1
0.38.1
chore:
## What's Changedapi.yml
and environment audiences by @dsinghvi in (feat, docs): add docs onapi.yml
and environment audiences fern-api/fern#4292Full Changelog: fern-api/fern@0.38.0...0.38.1
0.38.0
chore:
## What's ChangedFull Changelog: fern-api/fern@0.38.0-rc1...0.38.0
0.38.0-rc1
chore:
## What's ChangedhasNextPage
property for offset pagination by @dsinghvi in (feat, typescript): supporthasNextPage
property for offset pagination fern-api/fern#4288Full Changelog: fern-api/fern@0.38.0-rc0...0.38.0-rc1
0.38.0-rc0
chore:
## What's Changedhas-next-page
property to IR by @dsinghvi in (feat, cli): addhas-next-page
property to IR fern-api/fern#4241fern check
by @dsinghvi in (feat): refactor how pagination properties are checked infern check
fern-api/fern#4250internal
+ client classespartial
by @dcb6 in c#, improvements: small improvements including marking filesinternal
+ client classespartial
fern-api/fern#4248FluentAssertions
in unit tests by @dcb6 in c#, improvement: UseFluentAssertions
in unit tests fern-api/fern#4254pnpm
migration by @dsinghvi in (internal):pnpm
migration fern-api/fern#4261shape
toExampleQueryParameter
by @dcb6 in ir: addshape
toExampleQueryParameter
fern-api/fern#4222Full Changelog: fern-api/fern@0.37.16...0.38.0-rc0
0.37.16
chore:
## What's ChangedNew Contributors
Full Changelog: fern-api/fern@0.37.15...0.37.16
0.37.15
chore:
## What's Changed.proto
inputs by @amckinney in (feature): Add support for.proto
inputs fern-api/fern#4223Full Changelog: fern-api/fern@0.37.14...0.37.15
0.37.14
chore:
## What's Changed<package>/<version>
by @dsinghvi in (feat, typescript): send user agent header<package>/<version>
fern-api/fern#4234Full Changelog: fern-api/fern@0.37.13...0.37.14
0.37.14-rc0
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.13...0.37.14-rc0
0.37.13
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.12...0.37.13
0.37.12
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.11...0.37.12
0.37.11
chore:
## What's ChangedNew Contributors
Full Changelog: fern-api/fern@0.37.10...0.37.11
0.37.10
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.9...0.37.10
0.37.9
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.8...0.37.9
0.37.8
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.7...0.37.8
0.37.7
chore:
## What's Changedurl
field of auto-generatedEndpointExampleCall
s by @dcb6 in fix, ir-generation: put fully substituted path inurl
field of auto-generatedEndpointExampleCall
s fern-api/fern#4211Full Changelog: fern-api/fern@0.37.6...0.37.7
0.37.6
chore:
## What's ChangednoScripts
into a PersistedProject and introduce a test by @dsinghvi in (fix, typescript): wirenoScripts
into a PersistedProject and introduce a test fern-api/fern#4185Full Changelog: fern-api/fern@0.37.5...0.37.6
0.37.5
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.4...0.37.5
0.37.4
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.3...0.37.4
0.37.3
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.2...0.37.3
0.37.2
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.1...0.37.2
0.37.1
chore:
## What's ChangedFull Changelog: fern-api/fern@0.37.0...0.37.1
0.37.0
chore:
## What's Changedset
instead ofinit
field accessors in types by @dcb6 in c#, improvement:set
instead ofinit
field accessors in types fern-api/fern#4151Full Changelog: fern-api/fern@0.36.0...0.37.0
0.36.0
chore:
## What's ChangedRawClient
constructor parameters by @dcb6 in c#, improvement: Add header suppliers toRawClient
constructor parameters fern-api/fern#4119Full Changelog: fern-api/fern@0.35.0...0.36.0
0.36.0-rc1
chore:
## What's ChangedFull Changelog: fern-api/fern@0.36.0-rc0...0.36.0-rc1
0.36.0-rc0
chore:
## What's ChangedRawClient
constructor parameters by @dcb6 in c#, improvement: Add header suppliers toRawClient
constructor parameters fern-api/fern#4119Full Changelog: fern-api/fern@0.35.0...0.36.0-rc0
0.35.0
chore:
## What's Changeddefault-url
and url override on imports by @dsinghvi in (feat): supportdefault-url
and url override on imports fern-api/fern#4116Full Changelog: fern-api/fern@0.34.0...0.35.0
0.35.0-rc0
chore:
## What's Changeddefault-url
and url override on imports by @dsinghvi in (feat): supportdefault-url
and url override on imports fern-api/fern#4116Full Changelog: fern-api/fern@0.34.0...0.35.0-rc0
0.34.0
chore:
## What's Changedexpected_types
to tuple to satisfy mypy by @armandobelardo in fix: update typing ofexpected_types
to tuple to satisfy mypy fern-api/fern#4100zurg
unit tests to the generated SDK by @williamluer in (feat, typescript): copy overzurg
unit tests to the generated SDK fern-api/fern#4045auth
andfetcher
utilities by @dsinghvi in (feat, typescript): generate tests forauth
andfetcher
utilities fern-api/fern#4115Full Changelog: fern-api/fern@0.33.5...0.34.0
0.33.6-rc0
chore:
## What's Changedexpected_types
to tuple to satisfy mypy by @armandobelardo in fix: update typing ofexpected_types
to tuple to satisfy mypy fern-api/fern#4100Full Changelog: fern-api/fern@0.33.5...0.33.6-rc0
0.33.5
chore:
## What's ChangedFull Changelog: fern-api/fern@0.33.4...0.33.5
0.33.4
chore:
## What's ChangedFull Changelog: fern-api/fern@0.33.3...0.33.4
0.33.3
chore:
## What's Changedjest-specific-snapshot
by @dsinghvi in (fix): removejest-specific-snapshot
fern-api/fern#4088Full Changelog: fern-api/fern@0.33.2...0.33.3
0.33.2
chore:
## What's Changedfs.CreateReadStream
on Node 19+ form data uploads by @dsinghvi in (feat): supportfs.CreateReadStream
on Node 19+ form data uploads fern-api/fern#4073Full Changelog: fern-api/fern@0.33.1...0.33.2
0.33.2-rc0
chore:
## What's Changedfs.CreateReadStream
on Node 19+ form data uploads by @dsinghvi in (feat): supportfs.CreateReadStream
on Node 19+ form data uploads fern-api/fern#4073Full Changelog: fern-api/fern@0.33.1...0.33.2-rc0