🌿 ✨ [Scheduled] Upgrade Fern CLI #2
Open
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.51.34to0.56.13- Changelog0.56.13fix:Correctly parse channel descriptions in AsyncAPI v2 and v3 specs.0.56.12fix:Updated the OpenAPI parser to:0.56.11fix:Addx-fern-addressextension for AsyncAPI v2.x.x specs to specify the channel address.0.56.10fix:Enable correct environment generation when only provided an AsyncAPI spec.0.56.9fix:Fix an issue where default values for query parameters would occasionally be omitted during parsing.57 additional updates, see more
0.56.8feat:OpenAPI file properties can now support descriptions.0.56.7internal:The CLI now recognizes that the latest C# SDK uses IRv57.0.56.6internal:The CLI now recognizes that the latest PHP SDK uses IRv57.0.56.5fix:Updated the CLI to gracefully handle unsupported security schemes (e.g. cookie-based auth) by skipping theminstead of throwing an error. This allows the CLI to continue processing the rest of the API definition even when
it encounters security schemes it cannot convert.
0.56.4fix:Re-releasing the Fern CLI to fix an issue with the published package.0.56.3internal:Make the latest C# SDK generator consume IR v56.0.56.2fix:Re-releasing the Fern CLI to fix an issue with the published package.0.56.1fix:Re-releasing the Fern CLI to fix an issue with the published package.0.56.0fix:Fixed several issues with broken link detection in docs:Running
fern docs broken-linkswill now scan your docs site and log any broken internal links.0.56.0-rc6fix:Hidden sections are now removed from the docs sitemap.0.56.0-rc5fix:Fixed duplicate validation messages in docs validation by deduplicating violationsthat have the same message, node path, file path, and severity.
This prevents showing the same broken link error multiple times.
0.56.0-rc4feat:If experimental.openapi-parser-v3 is enabled in docs.yml, OpenAPI documents will now beconverted directly to IR, bypassing the intermediate Fern Definition step.
This makes sure that the old code path is completely ignored if the flag is enabled.
0.56.0-rc3feat:You can now specify custom pagination on your API and endpoints.This lets you implement your own pagination strategy in the generated SDKs.
0.56.0-rc2fix:Fix an issue where channel binding parameters with complex schemas were generated with conflicting names.0.56.0-rc1internal:Add support for a new option--from-openapito thefern ircommand. This commandwill allow you to test early versions of the new OpenAPI parser which goes directly from
OpenAPI to IR.
0.56.0-rc0feat:Improve thefern docs broken-linksoutput to make it easier tounderstand. Logged violations now include clickable links to the
affected source files (in supported terminals).
Added a
--broken-linksflag to thefern checkandfern docs devcommands. If set, broken links will be logged.
0.55.1fix:The Conjure Importer now correctly handles theauthproperty in endpoint definitions.0.55.0feat:The Fern definition now supports specifying object properties asread-onlyorwrite-only.0.54.1feat:Add support for thex-fern-enumextension in the AsyncAPI v3 parser.0.54.0-rc12feat:Add support for specifying C# snippets in thegenerators.ymlfile.0.54.0-rc11fix:Improve error logging in AsyncAPI v3 parser when parsing location headers.0.54.0-rc10chore:Migrate generators.yml without any specs.0.54.0-rc9chore:Detect swagger as OpenAPI files when migrating to specs configuration in generators.yml.0.54.0-rc8chore:Migration to specs configuration handles yaml/json files and checks for file existence.0.54.0-rc7chore:Add Java generator versions to migrations file from v55 to v540.54.0-rc6fix:Improve generators.yml migration toapi.specssyntax.0.54.0-rc5feat:Bumpdocs-resolversto0.0.64to fix an issue with endpoint-level server parsing.0.54.0-rc4fix:Handle comments that include '*/' literal values. This previously caused any generator that uses c-style comments to fail.0.54.0-rc3feat:Modify thex-fern-examplesextension to support Websocket session examples for AsyncAPI v3 specs.0.54.0-rc2feat:Add thex-fern-optionalextension to the AsyncAPI v3 parser to allow for optional channel parameters.chore:Improve the violations summary displayed byfern checkand include elapsed time when available.0.54.0-rc1fix:Update CLI-side markdown parsing to detect more hrefs and srcs (where src files are automatically uploaded),enabling the Download me pattern to work.
fix:Updatefern docs broken-linksto handle links within the current directory.0.54.0-rc0fix:Fix issue where the CLI would not parse asyncapi specs within theapi.specsarray in generators.yml.feat:Migrate old spec configuration in generators.yml to theapi.specs[]format.feat:Log warnings when old generators.yml syntax is used during parsing.0.53.18fix:Fix an issue where de-conflicting message names in AsyncAPI v3 parser would only update subsequent message names,but not the first occurrence.
0.53.17fix:Fix an issue with the OpenAPI v2 parser where recursive subpackage slugs would not generate correctly.0.53.16fix:Enablex-fern-sdk-group-nameextension in AsyncAPI v3 parser.0.53.15fix:Disable broken link checker until it is ready to release.0.53.14fix:Fixes an issue with the OpenAPI v2 parser where docs configs with no navigation structure would generate incorrect slugs.0.53.13fix:Resolve error wherefern docs devfailed in Windows environments.0.53.12fix:Dynamically deconflict AsyncAPI message names when generating Fern Definition Types to preserve original namingwherever possible.
0.53.11fix:Fix an issue with the OpenAPI v2 parser where schemas with single value arrays were being incorrectly parsed.0.53.10fix:Support differentiated server URLs in WebSocket channels and correctly generate multi-url environments.0.53.9fix:Fix an issue with the OpenAPI v2 parser where incorrect slugs were being generated.0.53.8fix:Fix noindex behavior for section overview pages.0.53.7fix:Regenerate changelog.0.53.6fix:Correctly parse out channel address for v3 AsyncAPI specs.0.53.5fix:Support validation schemas in detailed Union types.0.53.4fix:Improve error logging ondownloadLocalDocsBundlefailure.0.53.3fix:noindexproperty in the frontmatter of a page is now implemented for site navigation +llms.txt.0.53.2fix:The OpenAPI parser now prefers thesourceextension set in the OpenAPI spec, and only writesit if it is not already set.
0.53.1fix:The OpenAPI v2 parser now parses Server specifications with variables.0.53.0feat:Users can now specify theidiomatic-request-namesoption in thegenerators.ymlto adapt the behavior of theautogenerated request names. The verb is now in front of the noun (e.g.
UsersListRequestbecomesListUsersRequest).This is disabled by default (for backwards compatibility), and can be enabled with the following:
0.52.0fix:Introduce the AsyncAPI 3.0.0 parser, which enables conditional parsing of both 2.x and 3.x AsyncAPI specs.0.51.39fix:The OpenAPI v2 parser now respects object properties as optional, generates display names for undiscriminated union objecttypes, and fixes minor issues with docs dev when using specific navigation locators in docs.yml specification.
0.51.38fix:The OpenAPI v2 parser now ignores optional parameters when generating requests. It also improves upon generation withbetter fallback logic for sparse requests.
0.51.37fix:Fixed handling of Windows filepaths in the docs generator by ensuring consistent path separators and proper absolute path handling.0.51.36fix:Type reference example generation now handles extends and base properties correctly, as well as in-lined Alias types.0.51.35fix:The cli will now respect examples withnullvalues in OpenAPI specs. This will allow for null properties to show up when usingOpenAPI parser v2.