Skip to content

Commit aede9be

Browse files
committed
docs(changelog): Added entries for #299 & #292 and ran prettier.
1 parent 13a4f8e commit aede9be

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

CHANGELOG.md

+25-15
Original file line numberDiff line numberDiff line change
@@ -5,52 +5,62 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
98
## Unreleased
9+
1010
### Additions
11+
1112
- New `--meta` command line option for specifying what type of metadata should be generated:
1213
- `poetry` is the default value, same behavior you're used to in previous versions
13-
- `setup` will generate a pyproject.toml with no Poetry information, and instead create a `setup.py` with the
14+
- `setup` will generate a pyproject.toml with no Poetry information, and instead create a `setup.py` with the
1415
project info.
1516
- `none` will not create a project folder at all, only the inner package folder (which won't be inner anymore)
16-
- Lowered the minimum version of `python-dateutil` for improved dependency compatibility with other projects
1717

18+
### Changes
19+
20+
- Lowered the minimum version of `python-dateutil` to 2.8.0 for improved compatibility (#298 & #299). Thanks @bowenwr!
21+
- The `from_dict` method on generated models is now a `@classmethod` instead of `@staticmethod` (#215 & #292). Thanks @forest-benchling!
1822

1923
## 0.7.3 - 2020-12-21
24+
2025
### Fixes
26+
2127
- Spacing and extra returns for Union types of `additionalProperties` (#266 & #268). Thanks @joshzana & @packyg!
2228
- Title of inline schemas will no longer be missing characters (#271 & #274). Thanks @kalzoo!
23-
- Handling of nulls (Nones) when parsing or constructing dates (#267). Thanks @fyhertz!
24-
29+
- Handling of nulls (Nones) when parsing or constructing dates (#267). Thanks @fyhertz!
2530

2631
## 0.7.2 - 2020-12-08
32+
2733
### Fixes
34+
2835
- A bug in handling optional properties that are themselves models (introduced in 0.7.1) (#262). Thanks @packyg!
2936

3037
## 0.7.1 - 2020-12-08
38+
3139
### Additions
40+
3241
- Support for additionalProperties attribute in OpenAPI schemas and "free-form" objects by adding an `additional_properties` attribute to generated models. **COMPATIBILITY NOTE**: this will prevent any model property with a name that would be coerced to "additional_properties" in the generated client from generating properly (#218 & #252). Thanks @packyg!
3342

3443
### Fixes
44+
3545
- Enums will once again work with query parameters (#259). Thanks @packyg!
3646
- Generated Poetry metadata in pyproject.toml will properly indicate Python 3.6 compatibility (#258). Thanks @bowenwr!
3747

3848
## 0.7.0 - 2020-11-25
3949

4050
### Breaking Changes
4151

42-
- Any request/response field that is not `required` and wasn't specified is now set to `UNSET` instead of `None`.
52+
- Any request/response field that is not `required` and wasn't specified is now set to `UNSET` instead of `None`.
4353
- Values that are `UNSET` will not be sent along in API calls
44-
- Schemas defined with `type=object` will now be converted into classes, just like if they were created as ref components.
45-
The previous behavior was a combination of skipping and using generic Dicts for these schemas.
46-
- Response schema handling was unified with input schema handling, meaning that responses will behave differently than before.
47-
Specifically, instead of the content-type deciding what the generated Python type is, the schema itself will.
48-
- As a result of this, endpoints that used to return `bytes` when content-type was application/octet-stream will now return a `File` object if the type of the data is "binary", just like if you were submitting that type instead of receiving it.
54+
- Schemas defined with `type=object` will now be converted into classes, just like if they were created as ref components.
55+
The previous behavior was a combination of skipping and using generic Dicts for these schemas.
56+
- Response schema handling was unified with input schema handling, meaning that responses will behave differently than before.
57+
Specifically, instead of the content-type deciding what the generated Python type is, the schema itself will.
58+
- As a result of this, endpoints that used to return `bytes` when content-type was application/octet-stream will now return a `File` object if the type of the data is "binary", just like if you were submitting that type instead of receiving it.
4959
- Instead of skipping input properties with no type, enum, anyOf, or oneOf declared, the property will be declared as `None`.
50-
- Class (models and Enums) names will now contain the name of their parent element (if any). For example, a property
51-
declared in an endpoint will be named like {endpoint_name}_{previous_class_name}. Classes will no longer be
52-
deduplicated by appending a number to the end of the generated name, so if two names conflict with this new naming
53-
scheme, there will be an error instead.
60+
- Class (models and Enums) names will now contain the name of their parent element (if any). For example, a property
61+
declared in an endpoint will be named like {endpoint*name}*{previous_class_name}. Classes will no longer be
62+
deduplicated by appending a number to the end of the generated name, so if two names conflict with this new naming
63+
scheme, there will be an error instead.
5464

5565
### Additions
5666

0 commit comments

Comments
 (0)