loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-20 18:17:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improves generator docs, adds metadata section (#11262)

Browse Source 
* Refactors generator md creation, adds generateMdMetadata

* Removes extra space

* Adds docs updates

* Fixes table definition for metadata

* Docs update

* Docs update

* Updates title, removes sidebar_label because it was not doing anything on pages like https://openapi-generator.tech/docs/generators/android

* Docs updated
This commit is contained in:
Justin Black
2022-01-09 14:10:47 -08:00
committed by GitHub
parent 478219744e
commit d813d04f46
145 changed files with 1567 additions and 375 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/generators/python-experimental.md
View File

@@ -1,8 +1,16 @@
---
title: Config Options for python-experimental
sidebar_label: python-experimental
title: Documentation for the python-experimental Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | python-experimental | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Python client library<br><br>Features in this generator:<br>- type hints on endpoints and model creation<br>- model parameter names use the spec defined keys and cases<br>- robust composition (oneOf/anyOf/allOf) where paload data is stored in one instance only<br>- endpoint parameter names use the spec defined keys and cases<br>- inline schemas are supported at any location including composition<br>- multiple content types supported in request body and response bodies<br>- run time type checking<br>- quicker load time for python modules (a single endpoint can be imported and used without loading others)<br>- all instances of schemas dynamically inherit from all matching schemas so one can use isinstance to check if validation passed<br>- composed schemas with type constraints supported (type:object + oneOf/anyOf/allOf)<br>- schemas are not coerced/cast. For example string + date are both stored as string, and there is a date accessor<br> - Exceptions: int/float is stored as Decimal, When receiving data from headers it will start as str and may need to be cast for example to int | |
## CONFIG OPTIONS
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
| Option | Description | Values | Default |