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 #102

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

fern-api[bot]
Copy link
Contributor

@fern-api fern-api bot commented Nov 25, 2024

Upgrading from 0.45.0-rc12 to 0.45.0 - Changelog

    0.45.0
  • internal: Several improvements to docs, conjure importer, and the cli.

  • 0.45.0-rc55

  • internal: Docs generation now preserves original model schema names.

  • 0.45.0-rc54

  • internal: Removes errant minimum and maximums for 'float' types for docs.

  • 0.45.0-rc53

  • internal: Add support for the smart-casing flags in the IR commands.

  • 0.45.0-rc52

  • fix: Fix bug where max length validation for strings were incorrectly plumbed.

  • 39 additional updates, see more

    0.45.0-rc51

  • feat: Add support for the inline-path-parameters setting in the OpenAPI
    importer.

  • 0.45.0-rc50

  • fix: Increase max recursive depth allowed for example validation.

  • 0.45.0-rc49

  • fix: Add 'list' to reserved keywords for use in PHP generator.

  • 0.45.0-rc48

  • feat: OAuth Client Credential Auth Scheme now supports the ability to optionally
    set token header and prefix fields for use with docs playground.

    auth-schemes:
      OAuth:
        scheme: oauth
        type: client-credentials
        token-header: Fern-Authorization
        token-prefix: Fern-Bearer
        ...
  • 0.45.0-rc47

  • fix: Support SDK generation provided comma-delineated content-type values in OpenAPI specs.

  • 0.45.0-rc46

  • fix: The IR handles converting example unions that are aliases.

  • 0.45.0-rc45

  • fix: The IR handles converting example unions that are aliases.

  • 0.45.0-rc44

  • fix: Update the IR's ServiceTypeReferenceInfo to include all transitive types
    referenced by a service.

  • 0.45.0-rc43

  • fix: Support non-standard HTTP code 498; Validate x-fern-examples during schema parsing.

  • 0.45.0-rc42

  • fix: Log error message logging when encountering doc errors during preview server initiation.

  • 0.45.0-rc41

  • fix: Fixes bug introduced in 0.45.0-rc33 where version slugs were not being generated correctly.

  • 0.45.0-rc40

  • fix: Fixed bug in the Conjure importer where query parameters were overwritten during endpoint parameter parsing.

  • 0.45.0-rc39

  • fix: The OpenAPI importer now supports correlating request and response examples by name. When an example name is shared
    between a request body and response, they will be paired together in the generated Fern definition.

  • 0.45.0-rc38

  • fix: The OpenAPI importer now supports respecting readonly properties in schemas. When enabled, readonly properties will be excluded from request bodies for
    POST/PUT/PATCH endpoints. To enable this, configure the setting in your generators.yml:

    api:
     specs:
       - openapi: ./path/to/openapi.yml
         settings:
           respect-readonly-schemas: true
  • 0.45.0-rc37

  • internal: Support parsing alpha and beta version numbers of Fern generators

  • 0.45.0-rc36

  • fix: The OpenAPI importer now supports importing deep object query parameters. To do this, you will
    need to configure a setting in your generators.yml

    api:
     specs:
       - openapi: ./path/to/openapi.yml
         settings:
           object-query-paramaters: true
  • 0.45.0-rc35

  • fix: The OpenAPI importer now supports importing deep object query parameters. To do this, you will
    need to configure a setting in your generators.yml

    api: 
     specs: 
       - openapi: ./path/to/openapi.yml
         settings: 
           object-query-paramaters: true
  • 0.45.0-rc34

  • internal: The CLI now recognizes the versions of the Go generator that require IRv53.

  • 0.45.0-rc33

  • feat: The Fern CLI now supports roles and viewers in your docs configuration, if you are on the enteprise plan for docs:

    roles:
      - internal
      - beta-users
      - enterprise-users
    
    navigation:
      - section: Internal Section
        viewers:
          - internal
        contents:
          - page: Internal Page
            path: ./internal/page.mdx
  • 0.45.0-rc32

  • fix: The OpenAPI importer now supports reading endpoints that have application/x-www-form-urlencoded requests

  • 0.45.0-rc31

  • fix: The OpenAPI importer now parses webhook examples and generates examples for webhooks when none are provided.

  • 0.45.0-rc30

  • fix: The OpenAPI importer now parses the examples field for primitive schema types like string, number, array and boolean.

  • 0.45.0-rc29

  • feat: The OpenAPI importer now parses the examples field that may be present on OpenAPI 3.1 schemas.

  • 0.45.0-rc28

  • feat: The OpenAPI importer now skips headers in a case-insensitive way (e.g. both "Content-Type" and "content-type" are skipped).

  • 0.45.0-rc27

  • feat: The Conjure importer now brings in endpoint level descriptions.

  • 0.45.0-rc26

  • feat: fern check handles validating unions that contain base properties.

  • 0.45.0-rc25

  • internal: The Fern CLI temporarily does not support RBAC/Audiences (they will be added in again shortly).

  • 0.45.0-rc24

  • fix: fern docs dev now runs in Node 16 - Node 22 environments.

  • 0.45.0-rc23

  • fix: The docs dev server now correctly handles base paths.

  • 0.45.0-rc22

  • fix: Fixes bug introduced in 0.45.0-rc20 where section children were dropped from the docs definition.

  • 0.45.0-rc21

  • feat: The Fern CLI now supports orphaned pages in your docs configuration.

  • fix: The RBAC config model is now renamed to roles and viewers:

    roles:
      - internal
    
    navigation:
      - section: Internal Section
        viewers:
          - internal
        contents:
          - page: Internal Page
            path: ./internal/page.mdx
  • 0.45.0-rc20

  • feat: The Fern CLI now supports audiences in your docs configuration:

    # all audiences must be declared at the top level
    audiences:
      - internal
    
    navigation:
      - section: Internal Section
        audience: internal # audience is optional
        contents:
          - page: Internal Page
            path: ./internal/page.mdx
  • 0.45.0-rc19

  • fix: - Respect x-fern-ignore extension in OpenAPI parameters.

  • 0.45.0-rc18

  • fix: - Add additional debug logging to the CLI when downloading docs preview bundle

  • 0.45.0-rc17

  • fix: - Improved union example generation by increasing depth for better handling of recursive structures.

    • Updated Conjure importer to represent binary types as bytes for requests and file for responses in Fern.
    • Added detailed error messages when 'fern docs dev' fails, accessible with --log-level debug.
  • 0.45.0-rc16

  • fix: The Conjure importer now correctly keys the union subvariant by the property of the discriminant.

    union:
      discriminant: type
      union:
        square: Square
        circle: Circle
    

    is equal to the following Fern Definition:

    union:
      discriminant: type
      types:
        square:
          type: Square
          key: square
        circle:
          type: Circle
          key: circle
  • 0.45.0-rc15

  • fix: The Conjure importer now correctly imports base-path and docs from your conjure definition.

  • 0.45.0-rc14

  • fix: The Fern CLI now uses a longer timeout to make HTTP requests, which should fix some flakyness with the docs registration process.

  • 0.45.0-rc13

  • fix: The Fern CLI now uses a longer timeout to make HTTP requests, which should fix some flakyness with the docs registration process.

Copy link

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