Skip to content

Commit

Permalink
Release 3.4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
tarsil committed Sep 13, 2024
1 parent 3c32a75 commit abca93e
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
34 changes: 34 additions & 0 deletions docs/en/docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,40 @@ hide:

# Release Notes

## 3.4.1

### Changed

- OpenAPI now if no `description` is provided from the handlers, it will read directly from
the docstrings.
- Internal code cleaning and organisation.

### Fixed

- OpenAPI query parameters were not rendering properly for optional `dict` or `list` types. This
was due to the internal evaluation of the `None` field which is now skipping for OpenAPI purposes.

#### Example

Now it is possible to do something like this:

```python
from typing import Dict, List, Union, Optional

from esmerald import Gateway, JSONResponse, Query, get
from esmerald.testclient import create_client


@get("/item")
async def check_item(q: Union[List[str], None]) -> JSONResponse:
return JSONResponse({"value": q})


@get("/another-item")
async def check_item(q: Optional[Dict[str, str]]) -> JSONResponse:
return JSONResponse({"value": q})
```

## 3.4.0

### Added
Expand Down
2 changes: 1 addition & 1 deletion esmerald/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "3.4.0"
__version__ = "3.4.1"


from lilya import status
Expand Down

0 comments on commit abca93e

Please sign in to comment.