Skip to content

Conversation

@dbanty
Copy link
Collaborator

@dbanty dbanty commented Feb 21, 2024

This PR was created by Knope. Merging it will create a new release

Breaking Changes

For custom templates, changed type of endpoint parameters

This does not affect projects that are not using --custom-template-path

The type of these properties on Endpoint has been changed from Dict[str, Property] to List[Property]:

  • path_parameters
  • query_parameters
  • header_parameters
  • cookie_parameters

If your templates are very close to the default templates, you can probably just remove .values() anywhere it appears.

The type of iter_all_parameters() is also different, you probably want list_all_parameters() instead.

Updated generated config for Ruff v0.2

This only affects projects using the generate command, not the update command. The pyproject.toml file generated which configures Ruff for linting and formatting has been updated to the 0.2 syntax, which means it will no longer work with Ruff 0.1.

Updated naming strategy for conflicting properties

While fixing #922, some naming strategies were updated. These should mostly be backwards compatible, but there may be
some small differences in generated code. Make sure to check your diffs before pushing updates to consumers!

Features

support httpx 0.27 (#974)

Fixes

Allow parameters with names differing only by case

If you have two parameters to an endpoint named mixedCase and mixed_case, previously, this was a conflict and the endpoint would not be generated.
Now, the generator will skip snake-casing the parameters and use the names as-is. Note that this means if neither of the parameters was snake case, neither will be in the generated code.

Fixes #922 reported by @macmoritz & @benedikt-bartscher.

Fix naming conflicts with properties in models with mixed casing

If you had an object with two properties, where the names differed only by case, conflicting properties would be generated in the model, which then failed the linting step (when using default config). For example, this:

type: "object"
properties:
  MixedCase:
    type: "string"
  mixedCase:
    type: "string"

Would generate a class like this:

class MyModel:
    mixed_case: str
    mixed_case: str

Now, neither of the properties will be forced into snake case, and the generated code will look like this:

class MyModel:
    MixedCase: str
    mixedCase: str

@dbanty dbanty changed the title chore: prepare release 0.17.4 chore: prepare release 0.18.0 Feb 22, 2024
@dbanty dbanty merged commit c28226e into main Feb 22, 2024
@dbanty dbanty deleted the release branch February 22, 2024 18:08
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.

Spec errors

2 participants