Skip to content

Commit 62be018

Browse files
committed
feat: Updated docs
1 parent 96d39e0 commit 62be018

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The key features of the generator are:
2323
- __Support for multiple rest frameworks.__ __OpenAPI python generator__ currently supports the following:
2424
- [httpx](https://pypi.org/project/httpx/)
2525
- [requests](https://pypi.org/project/requests/)
26+
- [aiohttp](https://pypi.org/project/aiohttp/)
2627
- __Async and sync code generation support__, depending on the framework. It will automatically create both for frameworks that support both.
2728
- __Easily extendable using Jinja2 templates__. The code is designed to be easily extendable and should support even more languages and frameworks in the future.
2829
- __Fully tested__. Every generated code is automatically tested against the OpenAPI spec and we have 100% coverage.

docs/references/index.md

+23-5
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,27 @@ Arguments:
1515

1616
Options:
1717
```console
18-
--library The library to use. Defaults to `httpx`.
19-
--env-token-name The name of the environment variable to use for the API key. Defaults to `access_token`.
20-
--use-orjson Use the `orjson` library for serialization. Defaults to `false`.
21-
--custom-template-path Use a custom template path to override the built in templates.
22-
-h, --help Show this help message and exit.
18+
--library [httpx|requests|aiohttp]
19+
HTTP library to use in the generation of the client.
20+
Defaults to 'httpx'.
21+
22+
--env-token-name TEXT Name of the environment variable that contains the token.
23+
If set, code expects this environment variable and will
24+
raise an error if not set.
25+
Defaults to 'access_token'.
26+
27+
--use-orjson Use the orjson library for JSON serialization. Enables
28+
faster processing and better type support.
29+
Defaults to False.
30+
31+
--custom-template-path TEXT
32+
Custom template path to use. Allows overriding of the
33+
built in templates.
34+
35+
--pydantic-version [v1|v2]
36+
Pydantic version to use for generated models.
37+
Defaults to 'v2'.
38+
39+
--version Show the version and exit.
40+
-h, --help Show this help message and exit.
2341
```

0 commit comments

Comments
 (0)