Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌿 ✨ [Scheduled] Upgrade Fern CLI #172

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

fern-api[bot]
Copy link
Contributor

@fern-api fern-api bot commented Sep 30, 2024

Upgrading from 0.42.14 to 0.44.6 - Changelog

    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.

  • 12 additional updates, see more

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants