Skip to content

Commit d7d9e82

Browse files
committed
Update README.md with support details and bump version to 0.1.3 in pyproject.toml
1 parent 9628973 commit d7d9e82

2 files changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,23 @@ A bidirectional Python code generator that converts between AsyncAPI 3.0 specifi
1919
```bash
2020
pip install zen-generator
2121
```
22+
> [!IMPORTANT]
23+
>
24+
> Currently, only model and function definitions in the `components` block of the AsyncAPI file are supported.
25+
> Inline definitions are not supported.
26+
27+
> [!NOTE]
28+
>
29+
This code snippet includes a custom definition for > declaring required parameters in model/function > definitions.
30+
Specifically, the `required` keyword is used to specify mandatory fields, as shown below:
31+
32+
```yaml
33+
required:
34+
- user_id
35+
```
36+
> This ensures that the `user_id` parameter is always provided when the model or function is utilized.
37+
38+
2239

2340
## Quick Start 🏃
2441

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "zen-generator"
3-
version = "0.1.2"
3+
version = "0.1.3"
44
description = "A bidirectional Python code generator that converts between AsyncAPI 3.0 specifications and Python code (pure Python or FastAPI implementations)."
55
authors = [{ name = "Carlo Bertini [WaYdotNET]", email = "waydotnet@gmail.com" }]
66
readme = "README.md"

0 commit comments

Comments
 (0)