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

Merged
merged 1 commit into from
Jan 6, 2025
Merged

🌿 ✨ [Scheduled] Upgrade Fern CLI #172

merged 1 commit into from
Jan 6, 2025

Conversation

fern-api[bot]
Copy link
Contributor

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

Upgrading from 0.46.4 to 0.46.20 - Changelog

    0.46.20
  • feat: The fern init command now supports a --mintlify option. You can pass in
    the path to your mint.json and the Fern CLI will generate a fern documentation
    website.

  • 0.46.19

  • fix: If a schema in OpenAPI or AsyncAPI has additionalProperties: true then the Fern CLI will now respect bringing in
    example properties that are not defined in the schema. Previously, the CLI would skip them.

  • 0.46.18

  • fix: If an object or request is annotated with extra-properties: true then the user can provide an example that includes
    extra properties that are no longer in the schema.

    For example, check out this fern definition

    types:
      Item: 
        extra-properties: true
        properties:
          id: string
    
    
    service:
      auth: false
      base-path: ""
      endpoints:
        create:
          method: POST
          path: /item
          request:
            name: CreateItemRequest
            body:
              extra-properties: true
              properties:
                id: string
          response:
            type: Item
          examples:
            - name: "Item"
              request:
                id: "123"
                foo: "bar" # extra property in the example
              response:
                body:
                  id: "123"
                  foo: "bar" # extra property in the example
  • 0.46.17

  • fix: Support parsing string values for boolean defaults in OpenAPI schemas.

    • String values like "true" and "false" are now correctly parsed as boolean defaults.
  • 0.46.16

  • fix: Improve parsing of OpenAPI schemas with an array in the type property.

    • If the array contains "null", it is interpreted as nullable, and removed from the array.
    • If there is only a single item in the array (after removing "null"), it previously defaulted to unknown, but now the specified type is used.
  • 11 additional updates, see more

    0.46.15

  • fix: Fixed issue where user specified examples would be omitted in favor of autogenerated examples.

  • 0.46.14

  • fix: Boolean default values are now propagated from the Fern Definition through to docs generation.

  • 0.46.13

  • fix: Correctly omits readOnly query parameters during openapi to fern definition generation.

  • 0.46.12

  • fix: The CLI now handles parsing service level path parameters with descriptions.
    This fixes a regression introduced in the CLI since versions 0.45.x.

  • 0.46.11

  • fix: Allow for configuring the depth of example generation in API Docs. For example,
    if you want to generate optional properties that are 5 levels deep, you can add
    the following configuration in your generators.yml

    api:
      specs:
        - openapi: ./openapi.json
          settings:
            example-generation:
              response:
                max-depth: 10
  • 0.46.10

  • fix: Correctly support AdditionalProperties on object schemas.

  • 0.46.9

  • fix: SDK generation no longer hard-fails on single example generation errors.

  • 0.46.8

  • fix: The CLI now auto generates SSE and JSON Streaming examples even if those are
    not provided in the OpenAPI Spec or Fern Definition.

  • 0.46.7

  • fix: The generated Fern Definition now properly supports default values for query parameters.

  • 0.46.6

  • fix: The audiences property on WebSocket channels is now respected when filtering
    the IR graph based on configured audiences.

  • 0.46.5

  • fix: The OpenAPI parser now deduplicates headers that appear in both security schemes and
    operation-level headers to avoid duplicate header declarations.

@fern-api fern-api bot force-pushed the fern/update/cli branch from 780a148 to 228924b Compare October 21, 2024 00:03
@fern-api fern-api bot force-pushed the fern/update/cli branch 2 times, most recently from 250bc35 to d09a4cd Compare November 4, 2024 00:03
@fern-api fern-api bot force-pushed the fern/update/cli branch from d09a4cd to 02bb88c Compare November 11, 2024 00:04
@fern-api fern-api bot force-pushed the fern/update/cli branch from 02bb88c to 215801c Compare November 18, 2024 00:04
@fern-api fern-api bot force-pushed the fern/update/cli branch from 215801c to ecab7c5 Compare November 25, 2024 00:04
@fern-api fern-api bot force-pushed the fern/update/cli branch from ecab7c5 to 1751cc5 Compare December 2, 2024 00:05
@fern-api fern-api bot force-pushed the fern/update/cli branch from 1751cc5 to d975a72 Compare December 9, 2024 00:05
@fern-api fern-api bot force-pushed the fern/update/cli branch 2 times, most recently from 5151152 to c632da9 Compare December 23, 2024 00:03
@fern-api fern-api bot force-pushed the fern/update/cli branch from c632da9 to ebf98ac Compare December 30, 2024 00:03
@fern-api fern-api bot force-pushed the fern/update/cli branch from ebf98ac to bb5c6af Compare January 6, 2025 00:03
@Eclairemoy Eclairemoy merged commit 8f2eab0 into main Jan 6, 2025
3 checks passed
@Eclairemoy Eclairemoy deleted the fern/update/cli branch January 6, 2025 17:06
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.

1 participant