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.42.14
to0.44.11
- Changelog0.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, ordescription
in your OpenAPI spec.
0.44.8
fix:
API Configuration V2 schema now takes inorigin
as well, allowingfern api update
to function as expected in the new config.0.44.7
internal:
The Fern CLI commandfern generator list
now accepts filters for the output mode, for example, you may now specifyfern generator list --excluded-modes local-file-system
in order to filter any generators from the list that are outputting locally.
17 additional updates, see more
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 overridingbase-path
at the endpoint level.This is useful if you have subset of endpoints that do not live at the
configured base-path.
0.44.4
fix:
Fern's OpenAPI importer will now handle generating examples for declarederrors so that they show up in the generated documentation.
0.44.3
feat:
Fern's OpenAPI importer can now handlereadOnly
properties in the top levelrequest schema. Note that Fern does not handle nested
readOnly
propertiesjust 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 thesame 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.0.44.0-rc0
feat:
The Fern CLI now supports parsing Conjure, Palantir'shome-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 Docsplatform.
0.43.7
fix:
Thevalid-markdown
rule has been updated to try and parse the markdown file into avalid AST. If the file fails to parse,
fern check
will log an error as wellas the path to the markdown.
0.43.6
fix:
The OpenAPI importer now appropriately brings in responses that are under thetext/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 thex-fern-streaming
extension and want to provide different descriptionsfor the streaming endpoint, then you can now specify
streaming-description
.0.43.4
fix:
The OpenAPI parser now respects the content type in your OpenAPI spec, instead of always sendingapplication/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 templatesmay 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 iffern 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 multiplechangelogs 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.