Update docs

artsmolin · Oct 2, 2023 · cce055d · cce055d
1 parent 4a147e3
commit cce055d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -21,11 +21,11 @@ Check documentation to see more details about the features. All documentation is
 - [Sync](/examples/petstore/client_sync.py) and [async](/examples/petstore/client_async.py) clients for [Petstore OpenAPI](/examples/petstore/openapi.yaml)
 
 ## Installation
-Pip
+You can install the library
 ```shell
 pip install pythogen
 ```
-Docker
+or use Docker
 ```shell
 docker pull artsmolin/pythogen
 ```
@@ -34,12 +34,12 @@ docker pull artsmolin/pythogen
 - `path/to/input` — path to the directory with openapi.yaml;
 - `path/to/output` — the path to the directory where the generated client will be saved;
 
-Pip
+Generate a client using the installed library
 ```shell
 pythogen path/to/input/openapi.yaml path/to/output/client.py
 ```
 
-Docker
+or via Docker
 ```shell
 docker run \
 -v ./path/to/input:/opt/path/to/input \

diff --git a/docs/README.md b/docs/README.md
@@ -42,7 +42,7 @@ Generate a client using the installed library
 ```shell
 pythogen path/to/input/openapi.yaml path/to/output/client.py
 ```
-or via docker Docker
+or via Docker
 ```shell
 docker run \
 -v ./path/to/input:/opt/path/to/input \
@@ -175,12 +175,7 @@ client = Client(
 ```
 
 ### Discriminator
-Pythogen is able to generate a base class in which the logic of the discriminator is implemented by the value of the specified field. To do this, the desired field in the "description" parameter must contain a text
-```
-__discriminator__(BaseClassName.field)
-```
-- `BaseClassName` — desired name of the base class
-- `field` — discriminator field
+Generate [pydantic classes with discriminators](https://docs.pydantic.dev/latest/api/standard_library_types/#discriminated-unions-aka-tagged-unions) based on [OpenAPI discriminators](https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/). The original OpenAPI specification must have the propertyName and mapping fields.
 
 ## Examples
 - [Sync](/examples/petstore/client_sync.py) and [async](/examples/petstore/client_async.py) clients for [Petstore OpenAPI](/examples/petstore/openapi.yaml)