Morph MORPH
SIGN IN SIGN UP
OpenAPITools / openapi-generator UNCLAIMED

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

0 0 12 Java
Normal View History Raw
[feat][docs][website] Initial docusaurus based site (#1770) * Iniital docusaurus based site * Remove error about default local being used by String.format * Change pinned users to represent global presence rather than alphabetical order pinning * Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README) * Add Font Awesome attribution footer * Remove feature callout until it is completed * Include NPM try it out section * Improve "Getting Started" type docs * Include new custom template documentation * Updating templating and customization docs * Add vendor extension docs * Cleanup templating page(s). * Move users to yaml file for easy edit. * travis configuration, and baseUrl mods to image URLs * [docs] Migrate FAQ, release summary from wiki FAQ has been split into multiple smaller documents to better categorize and allow users to find what they're looking for (in docs folder or in new website). Release summary information (versioning strategy and cadence) has been migrated from the Wiki and clarified a bit. Also adds copy button for all code snippets in website. * Copy current contributing/code of conduct to website * [docs] Creating a new generator
2019-01-18 04:39:33 -05:00
---
Improves generator docs, adds metadata section (#11262) * 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
2022-01-09 14:10:47 -08:00
title: Documentation for the python Generator
[feat][docs][website] Initial docusaurus based site (#1770) * Iniital docusaurus based site * Remove error about default local being used by String.format * Change pinned users to represent global presence rather than alphabetical order pinning * Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README) * Add Font Awesome attribution footer * Remove feature callout until it is completed * Include NPM try it out section * Improve "Getting Started" type docs * Include new custom template documentation * Updating templating and customization docs * Add vendor extension docs * Cleanup templating page(s). * Move users to yaml file for easy edit. * travis configuration, and baseUrl mods to image URLs * [docs] Migrate FAQ, release summary from wiki FAQ has been split into multiple smaller documents to better categorize and allow users to find what they're looking for (in docs folder or in new website). Release summary information (versioning strategy and cadence) has been migrated from the Wiki and clarified a bit. Also adds copy button for all code snippets in website. * Copy current contributing/code of conduct to website * [docs] Creating a new generator
2019-01-18 04:39:33 -05:00
---
Improves generator docs, adds metadata section (#11262) * 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
2022-01-09 14:10:47 -08:00
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | python | pass this to the generate command after -g |
Improves generator docs: stability + language version added (#11270) * Adds generatorLanguageVersion and uses it in python generators * Regenerates docs * Adds stability to generator docs * Triple braces generatorLanguageVersion * Regenerates samples * Fixes the python-experimental setup.py file so it works with generatorLanguageVersion * Updates generators readme
2022-01-10 18:16:53 -08:00
| generator stability | STABLE | |
Improves generator docs, adds metadata section (#11262) * 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
2022-01-09 14:10:47 -08:00
| generator type | CLIENT | |
Adds generatorLanguage to all generators (#11268) * Adds generatorLanguage to all generators * Adds all generator languages and info to docs * Docs updated
2022-01-10 12:13:35 -08:00
| generator language | Python | |
Drop python 3.8 support python 3.13 in python generator (#20909) * Drop support for python 3.8 and add support for 3.13 in python generator templates * Update docs * Test samples without python 3.8 and with 3.13 * Generate samples
2025-03-23 11:10:32 +01:00
| generator language version | 3.9+ | |
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
| generator default templating engine | mustache | |
| helpTxt | Generates a Python client library. | |
Improves generator docs, adds metadata section (#11262) * 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
2022-01-09 14:10:47 -08:00
## CONFIG OPTIONS
[docs] Add clarity around configuration options (#7547)
2020-09-30 20:56:28 -04:00
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.
[feat][docs][website] Initial docusaurus based site (#1770) * Iniital docusaurus based site * Remove error about default local being used by String.format * Change pinned users to represent global presence rather than alphabetical order pinning * Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README) * Add Font Awesome attribution footer * Remove feature callout until it is completed * Include NPM try it out section * Improve "Getting Started" type docs * Include new custom template documentation * Updating templating and customization docs * Add vendor extension docs * Cleanup templating page(s). * Move users to yaml file for easy edit. * travis configuration, and baseUrl mods to image URLs * [docs] Migrate FAQ, release summary from wiki FAQ has been split into multiple smaller documents to better categorize and allow users to find what they're looking for (in docs folder or in new website). Release summary information (versioning strategy and cadence) has been migrated from the Wiki and clarified a bit. Also adds copy button for all code snippets in website. * Copy current contributing/code of conduct to website * [docs] Creating a new generator
2019-01-18 04:39:33 -05:00
| Option | Description | Values | Default |
| ------ | ----------- | ------ | ------- |
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
|dateFormat|date format for query parameters| |%Y-%m-%d|
|datetimeFormat|datetime format for query parameters| |%Y-%m-%dT%H:%M:%S%z|
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
|generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false|
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
|library|library template (sub-template) to use: asyncio, tornado (deprecated), urllib3| |urllib3|
|mapNumberTo|Map number to Union[StrictFloat, StrictInt], StrictStr or float.| |Union[StrictFloat, StrictInt]|
[feat][docs][website] Initial docusaurus based site (#1770) * Iniital docusaurus based site * Remove error about default local being used by String.format * Change pinned users to represent global presence rather than alphabetical order pinning * Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README) * Add Font Awesome attribution footer * Remove feature callout until it is completed * Include NPM try it out section * Improve "Getting Started" type docs * Include new custom template documentation * Updating templating and customization docs * Add vendor extension docs * Cleanup templating page(s). * Move users to yaml file for easy edit. * travis configuration, and baseUrl mods to image URLs * [docs] Migrate FAQ, release summary from wiki FAQ has been split into multiple smaller documents to better categorize and allow users to find what they're looking for (in docs folder or in new website). Release summary information (versioning strategy and cadence) has been migrated from the Wiki and clarified a bit. Also adds copy button for all code snippets in website. * Copy current contributing/code of conduct to website * [docs] Creating a new generator
2019-01-18 04:39:33 -05:00
|packageName|python package name (convention: snake_case).| |openapi_client|
|packageUrl|python package URL.| |null|
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
|packageVersion|python package version.| |1.0.0|
|projectName|python project name in setup.py (e.g. petstore-api).| |null|
Add option to set recursion limit (#7491) * add option to set recursion limit * fix test failure * update doc * add tests * add missing import * rename option to recursionLimit
2020-09-25 02:47:22 +08:00
|recursionLimit|Set the recursion limit. If not set, use the system default value.| |null|
[python] Add an option to add ensure_ascii=False to json.dumps (#18888) * Added ensure ascii * add option to add ensure_ascii=False in jsom.dumps * remove option * update workflow --------- Co-authored-by: Emile Girard <Emile.Girard@opal-rt.com>
2024-06-15 18:39:06 +08:00
|setEnsureAsciiToFalse|When set to true, add `ensure_ascii=False` in json.dumps when creating the HTTP request body.| |false|
add oneOf lookup option in python client generator (#16154)
2023-07-22 15:29:04 +08:00
|useOneOfDiscriminatorLookup|Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.| |false|
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
## IMPORT MAPPING
| Type/Alias | Imports |
| ---------- | ------- |
## INSTANTIATION TYPES
| Type/Alias | Instantiated By |
| ---------- | --------------- |
## LANGUAGE PRIMITIVES
[docs] Upgrade to Docusaurus 2 (#5271) * [docs] Upgrade to Docusaurus 2 Due to formatting issues with Docusaurus 1 and code blocks, and upcoming 4.3 and 5.0 releases, this is an upgrade to have more control over formatting and other functionality. This adds behavior to have light/dark themes. As a consequence of upgrading, columnar format on ul element in generated generator docs had to be moved to css. This will not impact users viewing the markdown on GitHub because it didn't display the column format. This upgrade should improve syntax highlighting and performance. * Fix user page layout, choose theme with clear diff colors
2020-02-11 08:22:58 -05:00
<ul class="column-ul">
Add a new Python client generator - python-nextgen (#14157) * add python-nextgen generator * remove client_side_validation from model * remove configuraiton import from models * add inheritance support * update test requirements, tox * add typings, pydanic to models * add test model * minor improvements * add enum support * add typing for parameters, remove validations * add oneof, anyof support * fix default value * fix deserialization, api tests passed * private variable naming, update tests, all tests passed * remove six * remove nose * update doc * remove sortParamsByRequiredFlag option * add parameter validation * add validation tests * simplify Field() * remove previous required parameter validation * improve parameter handling * support discriminator mapping * better typing discriminator mapping * format test code * fix tests * fix oneOf from_dict, add test * add set validation test * fix nested oneof serialization, add tests * add model import * remove models. prefix * remove import models * remove model import from api * simplify from_dict * add typing for return * skip pydantic import in return type * fix tests, fix enum * restore more enum schema tests * uncomment enum integer test * clean up getfullargspec import in model * clean up getfullargspec import * fix deserilizatoin for nested oneof * minor fixes, add tests * fix regular expression * add aiohttp samples, add tests * remove default content type to json * update template * fix select accept, content-type * move tests * move tests * fix url query parameters * fix list * fix samples * fix param pydantic, add list as reserved word * fix auto-generated doc * fix readme * fix list, fix special variable name with var_ * fix Literal in python 3.7 * fix default configuration * fix aiohttp tests * set default api client instance * deprecate get_default_copy method * fix enum model * fix enum serializatio/deserialization * add github workflow support * add regular expression validator * add enum validator * better model import * fix file, remove x-py-import-models * rename local var * better model example * fix regular expression warning, add special_name test, whitelist schema * skip self import * update samples * various fixes * add base64, json as reserved word * add http signature support * add http signature test * add additioanl properties support in python client * add decimal support * use strictstr instead of constr * fix test with virtualenv * add nullable support * add readonly support * add model name caching * fix circular reference import * add onelook discriminator lookup * add tests * update samples * fix locale * Fix client legacy generator asyncio README code example * test python-nextgen in circleci * fix pom.xml * update python to 3.7.15 * test with python 3.7.12 * various updates * fix python legacy
2022-12-17 16:05:47 +08:00
<li>Dict</li>
<li>List</li>
[docs] Upgrade to Docusaurus 2 (#5271) * [docs] Upgrade to Docusaurus 2 Due to formatting issues with Docusaurus 1 and code blocks, and upcoming 4.3 and 5.0 releases, this is an upgrade to have more control over formatting and other functionality. This adds behavior to have light/dark themes. As a consequence of upgrading, columnar format on ul element in generated generator docs had to be moved to css. This will not impact users viewing the markdown on GitHub because it didn't display the column format. This upgrade should improve syntax highlighting and performance. * Fix user page layout, choose theme with clear diff colors
2020-02-11 08:22:58 -05:00
<li>bool</li>
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
<li>bytearray</li>
[Python] Fix Python UTF-8 Encoding Issue (#5679) * Try decoding but don't bail on error * Switch binary and ByteArray to bytes * Read content type and parse appropriately * Remove response parsing * Remove response parsing and just return the data * Update petshop examples w/ new generator code * Fix copy/paste error with naming * Update petstore examples * Move response decoding to inside _preload_content block * Update the clients again * Use a raw string for the regex pattern * Regenerate petstore clients * Add bytes to python primitives as it's supported in 2.7 and 3 * Add bytes to the exports from model_utils * Import bytes from model_utils * Add conditional typing for regex pattern to match variable type * Regenerate petstore clients * Use read() instead of text() for asyncio * Regenerate petstore clients * Remove unused six import * Regenerate petstore clients * Add newline to kick Circle to re-run * Remove whitespace from tox.ini * Update more examples after ensure_updated * Add sample updates that didn't run with the --batch flag * Remove extra bracket in regex to remove warning * Stop printing debug messages * Add bytes examples to python doc generators * Update generated FakeApi docs * Regenerate api_client.py * Remove print statements from generated clients * Update bytes example in FakeApi.md. Again. I swear. * Add yet another seemingly missing doc update * Catch the error, decode the body, and re-throw * Remove the updates now that the change is non-breaking * Regenerate client * Add bytes deserialization test * Update exception parsing * Add exception parsing for python-experimental * Regenerate client with minor changes * Revert test changes * Regenerate model_utils.py * Update confusing test name * Remove bytes from mapping and examples * Add back in the old binary/ByteArray to str mapping * Update docs and api_client template * Add experimental api_client changes * Regenerate samples again * Add Tornado handling to early return * Try fixing Tornado python returns * More documentation changes * Re-generate the client code * Remove bytes from test_format_test * Remove more leftover bytes usages * Switch bytes validation back to string * Fix format_test template and regenerate * Remove unused bytes var * Remove bytes import from models and regenerate * Remove bytes import from test_deserialization * Reduce nested ifs * Remove byte logic for now * Regenerate client after latest changes * Remove another bytes usage * Regenerate after removing dangling byte string usage * Reduce the scope of the try/catch in api_client * Regenerate after try/catch cleanup * Swap catch for except * Regenerate Python client after api_client change * Fix lint error on the generated api_client * Add binary format test back in w/ string * Add decoding to python-experimental and regenerate * Import re into python-experimental api_client * Ensure file upload json response is utf-8 encoded bytes
2020-04-26 16:33:42 -04:00
<li>bytes</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>date</li>
<li>datetime</li>
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
<li>decimal.Decimal</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>dict</li>
<li>float</li>
<li>int</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>list</li>
[python] Renames python generators (#7965) * python->python-legacy, python-experimental->python * test with openjdk8 * test with openjdk11 * comment out rm * move kotlin tests to circleci * move kotlin tests * move tests to circleci * fix circleci * rearrange test * move tests * use wrapper Co-authored-by: Justin Black <justin.a.black@gmail.com>
2020-11-18 14:34:00 +08:00
<li>none_type</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>object</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>str</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
</ul>
## RESERVED WORDS
[docs] Upgrade to Docusaurus 2 (#5271) * [docs] Upgrade to Docusaurus 2 Due to formatting issues with Docusaurus 1 and code blocks, and upcoming 4.3 and 5.0 releases, this is an upgrade to have more control over formatting and other functionality. This adds behavior to have light/dark themes. As a consequence of upgrading, columnar format on ul element in generated generator docs had to be moved to css. This will not impact users viewing the markdown on GitHub because it didn't display the column format. This upgrade should improve syntax highlighting and performance. * Fix user page layout, choose theme with clear diff colors
2020-02-11 08:22:58 -05:00
<ul class="column-ul">
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>all_params</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>and</li>
<li>as</li>
<li>assert</li>
<li>async</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>auth_settings</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>await</li>
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
<li>base64</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>body_params</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>break</li>
<li>class</li>
<li>continue</li>
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
<li>date</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>def</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>del</li>
<li>elif</li>
<li>else</li>
<li>except</li>
<li>exec</li>
<li>false</li>
[python] Add field as a reserved word (#18279) * add field as a reserved word * remove tabs * update
2024-04-03 16:43:51 +08:00
<li>field</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>finally</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>float</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>for</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>form_params</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>from</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>global</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>header_params</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>if</li>
<li>import</li>
<li>in</li>
<li>is</li>
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
<li>json</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>lambda</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>local_var_files</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>none</li>
<li>nonlocal</li>
<li>not</li>
<li>or</li>
<li>pass</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>path_params</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>print</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>property</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>query_params</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>raise</li>
[Python] add `float` to reserved word list (#16689) * add float as reserved world * clean up * update samples * Update modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java Co-authored-by: Jonathan Ballet <jon@multani.info> * update doc * uncomment test --------- Co-authored-by: Jonathan Ballet <jon@multani.info>
2023-10-01 20:41:54 +08:00
<li>resource_path</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>return</li>
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
<li>schema</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>self</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>true</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
<li>try</li>
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs
2020-01-19 20:19:11 -05:00
<li>while</li>
<li>with</li>
<li>yield</li>
[doc] full generator details (#4941)
2020-01-08 21:54:05 -05:00
</ul>
[docs] Initial FeatureSet generator documentation (#5188) * Flatten feature sets for display * [cli] Add feature set output to config-help This includes markdown and plain text outputs for config-help. * [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00
## FEATURE SET
### Client Modification Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|BasePath|✗|ToolingExtension
|Authorizations|✗|ToolingExtension
|UserAgent|✗|ToolingExtension
Add Mock Server client modification feature (#6747)
2020-07-05 23:58:43 +03:00
|MockServer|✗|ToolingExtension
[docs] Initial FeatureSet generator documentation (#5188) * Flatten feature sets for display * [cli] Add feature set output to config-help This includes markdown and plain text outputs for config-help. * [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00
### Data Type Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|Custom|✗|OAS2,OAS3
|Int32|✓|OAS2,OAS3
|Int64|✓|OAS2,OAS3
|Float|✓|OAS2,OAS3
|Double|✓|OAS2,OAS3
|Decimal|✓|ToolingExtension
|String|✓|OAS2,OAS3
|Byte|✓|OAS2,OAS3
|Binary|✓|OAS2,OAS3
|Boolean|✓|OAS2,OAS3
|Date|✓|OAS2,OAS3
|DateTime|✓|OAS2,OAS3
|Password|✓|OAS2,OAS3
|File|✓|OAS2
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
|Uuid|✗|
[docs] Initial FeatureSet generator documentation (#5188) * Flatten feature sets for display * [cli] Add feature set output to config-help This includes markdown and plain text outputs for config-help. * [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00
|Array|✓|OAS2,OAS3
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
|Null|✗|OAS3
|AnyType|✗|OAS2,OAS3
Adds UUID to python-experimental (#12153) * Adds UUID to python-exp, allows uuid models to be generated * Adds test_UUIDString uuid model test * Fixes uuid properties in python-exp, changes maps to object data type, adds uuid data type * Adds maps data type back in * Adds missing Null and AnyType definitions and adds them to python-experimental * Generator docs updated, added missing uuid, null, anytype, and object * Adds uuid support description * Docs updated
2022-04-16 14:55:49 -07:00
|Object|✓|OAS2,OAS3
[docs] Initial FeatureSet generator documentation (#5188) * Flatten feature sets for display * [cli] Add feature set output to config-help This includes markdown and plain text outputs for config-help. * [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00
|Maps|✓|ToolingExtension
|CollectionFormat|✓|OAS2
|CollectionFormatMulti|✓|OAS2
|Enum|✓|OAS2,OAS3
|ArrayOfEnum|✓|ToolingExtension
|ArrayOfModel|✓|ToolingExtension
|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
|ArrayOfCollectionOfModel|✓|ToolingExtension
|ArrayOfCollectionOfEnum|✓|ToolingExtension
|MapOfEnum|✓|ToolingExtension
|MapOfModel|✓|ToolingExtension
|MapOfCollectionOfPrimitives|✓|ToolingExtension
|MapOfCollectionOfModel|✓|ToolingExtension
|MapOfCollectionOfEnum|✓|ToolingExtension
### Documentation Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|Readme|✓|ToolingExtension
|Model|✓|ToolingExtension
|Api|✓|ToolingExtension
### Global Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|Host|✓|OAS2,OAS3
|BasePath|✓|OAS2,OAS3
|Info|✓|OAS2,OAS3
|Schemes|✗|OAS2,OAS3
|PartialSchemes|✓|OAS2,OAS3
|Consumes|✓|OAS2
|Produces|✓|OAS2
|ExternalDocumentation|✓|OAS2,OAS3
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
|ParameterizedServer|✗|OAS3
|ParameterStyling|✗|OAS3
[docs] Initial FeatureSet generator documentation (#5188) * Flatten feature sets for display * [cli] Add feature set output to config-help This includes markdown and plain text outputs for config-help. * [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
### Parameter Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|Path|✓|OAS2,OAS3
|Query|✓|OAS2,OAS3
|Header|✓|OAS2,OAS3
|Body|✓|OAS2
|FormUnencoded|✓|OAS2
|FormMultipart|✓|OAS2
|Cookie|✗|OAS3
### Schema Support Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|Simple|✓|OAS2,OAS3
|Composite|✓|OAS2,OAS3
Switches python-experimental in as the primary python client (#13501) * Changes python to python-prior * python -> python-prior, python-experimental->python * Renames sample spec directories * Samples regnerated * Regenerates docs * Fixes test * Samples regenerated * Updates renerators list * Fixes made to python paths in pom.xml * Fixes node4 sh file paths
2022-09-24 01:19:38 -07:00
|Polymorphism|✓|OAS2,OAS3
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
|Union|✗|OAS3
Switches python-experimental in as the primary python client (#13501) * Changes python to python-prior * python -> python-prior, python-experimental->python * Renames sample spec directories * Samples regnerated * Regenerates docs * Fixes test * Samples regenerated * Updates renerators list * Fixes made to python paths in pom.xml * Fixes node4 sh file paths
2022-09-24 01:19:38 -07:00
|allOf|✓|OAS2,OAS3
|anyOf|✓|OAS3
|oneOf|✓|OAS3
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
|not|✗|OAS3
[docs] Initial FeatureSet generator documentation (#5188) * Flatten feature sets for display * [cli] Add feature set output to config-help This includes markdown and plain text outputs for config-help. * [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00
### Security Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|BasicAuth|✓|OAS2,OAS3
|ApiKey|✓|OAS2,OAS3
|OpenIDConnect|✗|OAS3
|BearerToken|✓|OAS3
|OAuth2_Implicit|✓|OAS2,OAS3
|OAuth2_Password|✗|OAS2,OAS3
|OAuth2_ClientCredentials|✗|OAS2,OAS3
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
[Python] fix security features listed in documentation (#15755)
2023-06-06 04:49:01 +02:00
|SignatureAuth|✓|OAS3
add security feature AWSV4Signature to documentation (#15603)
2023-12-13 08:07:18 +01:00
|AWSV4Signature|✗|ToolingExtension
[docs] Initial FeatureSet generator documentation (#5188) * Flatten feature sets for display * [cli] Add feature set output to config-help This includes markdown and plain text outputs for config-help. * [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00
### Wire Format Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|JSON|✓|OAS2,OAS3
rename python-nextgen to python (#15504)
2023-05-16 13:54:07 +08:00
|XML|✓|OAS2,OAS3
[docs] Initial FeatureSet generator documentation (#5188) * Flatten feature sets for display * [cli] Add feature set output to config-help This includes markdown and plain text outputs for config-help. * [docs] FeatureSet on generator docs
2020-02-01 20:51:55 -05:00
|PROTOBUF|✗|ToolingExtension
|Custom|✓|OAS2,OAS3
Reference in New Issue Copy Permalink