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

Merged
merged 1 commit into from
Sep 25, 2024
Merged

🌿 ✨ [Scheduled] Upgrade Fern CLI #171

merged 1 commit into from
Sep 25, 2024

Conversation

fern-api[bot]
Copy link
Contributor

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

Upgrading from 0.41.13 to 0.42.14 - Changelog

    0.42.14
  • fix: The OpenAPI importer now correctly propagates the title field on oneof schemas.

  • 0.42.13

  • fix: Example generation now intelligently truncates container examples, for example if the depth limit will be reached on a list of objects,
    the list will be returned as an empty list, as opposed the previous behavior where an unknown object would be created.

  • 0.42.12

  • fix: Previously, deploying docs from Windows machines led to bad asset paths.
    Now, the CLI respects Windows paths during run and web paths for retrieving
    assets.

  • 0.42.11

  • fix: The API V2 configuration now supports disabling using titles as schema
    names. You may want to disable this flag if your OpenAPI adds the same
    title to multiple schemas.

    api: 
      specs: 
        - openapi: /path/to/openapi
          settings: 
            use-title-as-schema-name: false
    
  • 0.42.10

  • fix: Previously, the OpenAPI converter would bring over title on every
    single property. This field is extraneous, so now we ignore it.

  • 16 additional updates, see more

    0.42.9

  • fix: Previously, the OpenAPI importer would ignore skip parsing arbitrary
    content types "/". Now it treats this content type as application/json.

    "responses": {
      "200": {
        "description": "Success reply",
        "content": {
          "*/*": {
  • 0.42.8

  • fix: The API V2 configuration (in beta) now supports global header overrides.
    This fixes a bug where those header overrides were getting dropped in
    certain cases.

    api: 
      headers: 
        X-API-VERSION: string
      specs: 
        - openapi: /path/to/openapi
          overrides: /path/to/overrides
  • 0.42.7

  • feat: The API V2 configuration (in beta) now supports global header
    overrides. To specify global headers that are not in your
    OpenAPI spec, simply add the following block in your generators.yml:

    api: 
      headers: 
        X-API-VERSION: string
      specs: 
        - openapi: /path/to/openapi
          overrides: /path/to/overrides
  • 0.42.6

  • fix: Removes extraneous conditional error within namespacing configuration

  • 0.42.5

  • feat: Adds additional metadata retrievable by fern generator get so you can now get the langauage and the target repo.

  • 0.42.4

  • fix: Namespaced APIs now:

    • No longer contain duplicative nesting of some endpoint within another package of the same name as the namespace
    • Respect the x-fern-sdk-group-name annotation for endpoints
  • 0.42.3

  • fix: The OpenAPI importer now supports handling encoding on multipart requests.
    Previously, the generators would not respect the contentType field for
    each form input. But, now they do.

    requestBody:
      content:
        multipart/form-data:
          schema:
            type: object
            properties:
              file:
                type: string
                format: binary
                description: The file to upload
          encoding:
            file:
              contentType: "application/octet-stream"
  • fix: The OpenAPI importer now correctly parses descriptions of multipart
    form requests. Previously these descriptions would be ignored.

    For example, previously the description The file to upload would be
    ignored in the example below.

    requestBody:
      content:
        multipart/form-data:
          schema:
            type: object
            properties:
              file:
                type: string
                format: binary
                description: The file to upload
  • 0.42.2

  • fix: Error bodies are now appropriately namespaced as well!

  • 0.42.1

  • fix: Make sure to check for optionality when parsing stdout and stderr in CLI. This
    removes the error: Cannot read properties of undefined (reading 'includes').

  • 0.42.0

  • fix: If you merge multiple OpenAPI specs with namespaces, fern check will no longer
    complain about duplicate schema names across namespaces.
    In the example below, both OpenAPI specs can have duplicative schema names and
    that is okay.

    api:
      specs:
        - openapi: openapi-bar.yml
          namespace: bar
        - openapi: opneapi-foo.yml
          namespace: foo
  • 0.42.0-rc0

  • feat: The Fern Definition now supports conten-type on multipart request properties.
    For example, to specify an application/octet-stream and application/json
    contnet types, use the snippet below:

    service:
      endpoints:
        upload:
          request:
            body:
              properties:
                file:
                  type: file
                  content-type: application/octet-stream
                metadata:
                  type: unknown
                  content-type: application/json
  • 0.41.16

  • fix: Previously the OpenAPI converter would incorrectly mark
    the values of additionalProperties as optional. Now, we have
    introduced a feature flag to turn this behavior off.

    The feature flag can be configured in generators.yml:

    api:
      specs:
        - openapi: /path/to/openapi
          settings:
            optional-additional-properties: false
  • 0.41.15

  • internal: Performance improvements for stringifiying large Intermediate Representations. If
    you have a large OpenAPI spec or Fern Definition, this can potentially shave off
    minutes from fern generate.

  • 0.41.14-rc2

  • internal: Remove bang operator and fix eslint warning in compatible-ir-versions.ts.

  • 0.41.14-rc1

  • feat: Running fern check will now check to confirm that the generator versions you are running are compatible with your Fern CLI version.

    Each version of SDK generators depends on a version of a libary that is exported by the Fern CLI, and as a result, each generator has a minimum
    compatible version of the Fern CLI. As an example, if you were to run fern check while leveraging fernapi/fern-python-sdk version 2.0.0, on CLI version 0.1.3, you'd receive the following error:

    The generator fernapi/fern-python-sdk requires CLI version 0.23.0-rc4 or later (current version: 0.1.3-rc0).

    Indicating that you must upgrade your CLI in order to leverage the current generator.

  • 0.41.14-rc0

  • fix: The Fern CLI now safely handles a npx file exists error by retrying the command on failure.
    This error typically happens when two or more instances of the Fern CLI are running npx
    at the same time.

@Eclairemoy Eclairemoy merged commit 373639d into main Sep 25, 2024
1 check passed
@Eclairemoy Eclairemoy deleted the fern/update/cli branch September 25, 2024 16:21
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