loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests 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
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
145 changed files with 1567 additions and 375 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/generators/ada-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for ada-server
sidebar_label: ada-server
title: Documentation for the ada-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | ada-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates an Ada server implementation (beta). | |
## 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 |

12
docs/generators/ada.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for ada
sidebar_label: ada
title: Documentation for the ada Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | ada | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an Ada client implementation (beta). | |
## 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 |

12
docs/generators/android.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for android
sidebar_label: android
title: Documentation for the android Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | android | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an Android client library. | |
## 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 |

12
docs/generators/apache2.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for apache2
sidebar_label: apache2
title: Documentation for the apache2 Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | apache2 | pass this to the generate command after -g |
| generator type | CONFIG | |
| helpTxt | Generates an Apache2 Config file with the permissions | |
## 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 |

12
docs/generators/apex.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for apex
sidebar_label: apex
title: Documentation for the apex Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | apex | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an Apex API client library. | |
## 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 |

12
docs/generators/asciidoc.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for asciidoc
sidebar_label: asciidoc
title: Documentation for the asciidoc Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | asciidoc | pass this to the generate command after -g |
| generator type | DOCUMENTATION | |
| helpTxt | Generates asciidoc markup based documentation. | |
## 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 |

12
docs/generators/aspnetcore.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for aspnetcore
sidebar_label: aspnetcore
title: Documentation for the aspnetcore Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | aspnetcore | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates an ASP.NET Core Web API server. | |
## 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 |

12
docs/generators/avro-schema.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for avro-schema
sidebar_label: avro-schema
title: Documentation for the avro-schema Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | avro-schema | pass this to the generate command after -g |
| generator type | SCHEMA | |
| helpTxt | Generates a Avro model (beta). | |
## 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 |

12
docs/generators/bash.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for bash
sidebar_label: bash
title: Documentation for the bash Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | bash | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Bash client script based on cURL. | |
## 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 |

12
docs/generators/c.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for c
sidebar_label: c
title: Documentation for the c Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | c | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a C (libcurl) client library (beta). | |
## 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 |

12
docs/generators/clojure.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for clojure
sidebar_label: clojure
title: Documentation for the clojure Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | clojure | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Clojure client library. | |
## 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 |

12
docs/generators/cpp-pistache-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cpp-pistache-server
sidebar_label: cpp-pistache-server
title: Documentation for the cpp-pistache-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cpp-pistache-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a C++ API server (based on Pistache) | |
## 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 |

12
docs/generators/cpp-qt-client.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cpp-qt-client
sidebar_label: cpp-qt-client
title: Documentation for the cpp-qt-client Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cpp-qt-client | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Qt C++ client library. | |
## 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 |

12
docs/generators/cpp-qt-qhttpengine-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cpp-qt-qhttpengine-server
sidebar_label: cpp-qt-qhttpengine-server
title: Documentation for the cpp-qt-qhttpengine-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cpp-qt-qhttpengine-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Qt C++ Server using the QHTTPEngine HTTP Library. | |
## 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 |

12
docs/generators/cpp-restbed-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cpp-restbed-server
sidebar_label: cpp-restbed-server
title: Documentation for the cpp-restbed-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cpp-restbed-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a C++ API Server with Restbed (https://github.com/Corvusoft/restbed). | |
## 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 |

12
docs/generators/cpp-restsdk.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cpp-restsdk
sidebar_label: cpp-restsdk
title: Documentation for the cpp-restsdk Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cpp-restsdk | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a C++ API client with C++ REST SDK (https://github.com/Microsoft/cpprestsdk). | |
## 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 |

12
docs/generators/cpp-tiny.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cpp-tiny
sidebar_label: cpp-tiny
title: Documentation for the cpp-tiny Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cpp-tiny | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a C++ Arduino REST API client. | |
## 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 |

12
docs/generators/cpp-tizen.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cpp-tizen
sidebar_label: cpp-tizen
title: Documentation for the cpp-tizen Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cpp-tizen | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Samsung Tizen C++ client library. | |
## 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 |

12
docs/generators/cpp-ue4.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cpp-ue4
sidebar_label: cpp-ue4
title: Documentation for the cpp-ue4 Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cpp-ue4 | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Unreal Engine 4 C++ Module (beta). | |
## 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 |

12
docs/generators/crystal.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for crystal
sidebar_label: crystal
title: Documentation for the crystal Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | crystal | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Crystal client library (beta). | |
## 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 |

12
docs/generators/csharp-dotnet2.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for csharp-dotnet2
sidebar_label: csharp-dotnet2
title: Documentation for the csharp-dotnet2 Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | csharp-dotnet2 | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a C# .Net 2.0 client library (beta). | |
## 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 |

12
docs/generators/csharp-nancyfx.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for csharp-nancyfx
sidebar_label: csharp-nancyfx
title: Documentation for the csharp-nancyfx Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | csharp-nancyfx | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a C# NancyFX Web API server. | |
## 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 |

12
docs/generators/csharp-netcore-functions.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for csharp-netcore-functions
sidebar_label: csharp-netcore-functions
title: Documentation for the csharp-netcore-functions Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | csharp-netcore-functions | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a csharp server. | |
## 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 |

12
docs/generators/csharp-netcore.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for csharp-netcore
sidebar_label: csharp-netcore
title: Documentation for the csharp-netcore Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | csharp-netcore | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a C# client library (.NET Standard, .NET Core). | |
## 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 |

12
docs/generators/csharp.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for csharp
sidebar_label: csharp
title: Documentation for the csharp Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | csharp | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a CSharp client library. | |
## 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 |

12
docs/generators/cwiki.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for cwiki
sidebar_label: cwiki
title: Documentation for the cwiki Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | cwiki | pass this to the generate command after -g |
| generator type | DOCUMENTATION | |
| helpTxt | Generates confluence wiki markup. | |
## 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 |

12
docs/generators/dart-dio-next.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for dart-dio-next
sidebar_label: dart-dio-next
title: Documentation for the dart-dio-next Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | dart-dio-next | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Dart Dio client library with null-safety. | |
## 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 |

12
docs/generators/dart-dio.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for dart-dio
sidebar_label: dart-dio
title: Documentation for the dart-dio Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | dart-dio | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Dart Dio client library. | |
## 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 |

12
docs/generators/dart-jaguar.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for dart-jaguar
sidebar_label: dart-jaguar
title: Documentation for the dart-jaguar Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | dart-jaguar | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Dart Jaguar client library. | |
## 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 |

12
docs/generators/dart.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for dart
sidebar_label: dart
title: Documentation for the dart Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | dart | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Dart 2.x client library. | |
## 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 |

12
docs/generators/dynamic-html.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for dynamic-html
sidebar_label: dynamic-html
title: Documentation for the dynamic-html Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | dynamic-html | pass this to the generate command after -g |
| generator type | DOCUMENTATION | |
| helpTxt | Generates a dynamic HTML site. | |
## 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 |

12
docs/generators/eiffel.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for eiffel
sidebar_label: eiffel
title: Documentation for the eiffel Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | eiffel | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Eiffel client library (beta). | |
## 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 |

12
docs/generators/elixir.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for elixir
sidebar_label: elixir
title: Documentation for the elixir Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | elixir | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an elixir client library (alpha). | |
## 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 |

12
docs/generators/elm.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for elm
sidebar_label: elm
title: Documentation for the elm Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | elm | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an Elm client library. | |
## 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 |

12
docs/generators/erlang-client.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for erlang-client
sidebar_label: erlang-client
title: Documentation for the erlang-client Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | erlang-client | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an Erlang client library (beta). | |
## 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 |

12
docs/generators/erlang-proper.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for erlang-proper
sidebar_label: erlang-proper
title: Documentation for the erlang-proper Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | erlang-proper | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an Erlang library with PropEr generators (beta). | |
## 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 |

12
docs/generators/erlang-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for erlang-server
sidebar_label: erlang-server
title: Documentation for the erlang-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | erlang-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates an Erlang server library (beta) using OpenAPI Generator (https://openapi-generator.tech). By default, it will also generate service classes, which can be disabled with the `-Dnoservice` environment variable. | |
## 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 |

12
docs/generators/flash-deprecated.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for flash-deprecated
sidebar_label: flash-deprecated
title: Documentation for the flash-deprecated Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | flash-deprecated | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Flash (ActionScript) client library (beta). IMPORTANT: this generator has been deprecated in v5.x | |
## 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 |

12
docs/generators/fsharp-functions.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for fsharp-functions
sidebar_label: fsharp-functions
title: Documentation for the fsharp-functions Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | fsharp-functions | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a fsharp-functions server (beta). | |
## 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 |

12
docs/generators/fsharp-giraffe-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for fsharp-giraffe-server
sidebar_label: fsharp-giraffe-server
title: Documentation for the fsharp-giraffe-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | fsharp-giraffe-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a F# Giraffe server (beta). | |
## 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 |

12
docs/generators/go-deprecated.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for go-deprecated
sidebar_label: go-deprecated
title: Documentation for the go-deprecated Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | go-deprecated | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Go client library (beta). NOTE: this generator has been deprecated. Please use `go` client generator instead. | |
## 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 |

12
docs/generators/go-echo-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for go-echo-server
sidebar_label: go-echo-server
title: Documentation for the go-echo-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | go-echo-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a go-echo server. (Beta) | |
## 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 |

12
docs/generators/go-gin-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for go-gin-server
sidebar_label: go-gin-server
title: Documentation for the go-gin-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | go-gin-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Go server library with the gin framework using OpenAPI-Generator.By default, it will also generate service classes. | |
## 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 |

12
docs/generators/go-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for go-server
sidebar_label: go-server
title: Documentation for the go-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | go-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Go server library using OpenAPI-Generator. By default, it will also generate service classes -- which you can disable with the `-Dnoservice` environment variable. | |
## 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 |

12
docs/generators/go.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for go
sidebar_label: go
title: Documentation for the go Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | go | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Go client library. | |
## 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 |

12
docs/generators/graphql-nodejs-express-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for graphql-nodejs-express-server
sidebar_label: graphql-nodejs-express-server
title: Documentation for the graphql-nodejs-express-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | graphql-nodejs-express-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a GraphQL Node.js Express server (beta) including it's types, queries, mutations, (resolvers) | |
## 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 |

12
docs/generators/graphql-schema.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for graphql-schema
sidebar_label: graphql-schema
title: Documentation for the graphql-schema Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | graphql-schema | pass this to the generate command after -g |
| generator type | SCHEMA | |
| helpTxt | Generates GraphQL schema files (beta) | |
## 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 |

12
docs/generators/groovy.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for groovy
sidebar_label: groovy
title: Documentation for the groovy Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | groovy | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Groovy API client. | |
## 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 |

12
docs/generators/haskell-http-client.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for haskell-http-client
sidebar_label: haskell-http-client
title: Documentation for the haskell-http-client Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | haskell-http-client | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Haskell http-client library. | |
## 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 |

12
docs/generators/haskell-yesod.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for haskell-yesod
sidebar_label: haskell-yesod
title: Documentation for the haskell-yesod Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | haskell-yesod | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a haskell-yesod server. | |
## 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 |

12
docs/generators/haskell.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for haskell
sidebar_label: haskell
title: Documentation for the haskell Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | haskell | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Haskell server and client library. | |
## 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 |

12
docs/generators/html.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for html
sidebar_label: html
title: Documentation for the html Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | html | pass this to the generate command after -g |
| generator type | DOCUMENTATION | |
| helpTxt | Generates a static HTML file. | |
## 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 |

12
docs/generators/html2.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for html2
sidebar_label: html2
title: Documentation for the html2 Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | html2 | pass this to the generate command after -g |
| generator type | DOCUMENTATION | |
| helpTxt | Generates a static HTML file. | |
## 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 |

12
docs/generators/java-inflector.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java-inflector
sidebar_label: java-inflector
title: Documentation for the java-inflector Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java-inflector | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java Inflector Server application. | |
## 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 |

12
docs/generators/java-micronaut-client.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java-micronaut-client
sidebar_label: java-micronaut-client
title: Documentation for the java-micronaut-client Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java-micronaut-client | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Java Micronaut Client. | |
## 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 |

12
docs/generators/java-msf4j.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java-msf4j
sidebar_label: java-msf4j
title: Documentation for the java-msf4j Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java-msf4j | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java Micro Service based on WSO2 Microservices Framework for Java (MSF4J) | |
## 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 |

12
docs/generators/java-pkmst.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java-pkmst
sidebar_label: java-pkmst
title: Documentation for the java-pkmst Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java-pkmst | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a PKMST SpringBoot Server application using the SpringFox integration. Also enables EurekaServerClient / Zipkin / Spring-Boot admin | |
## 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 |

12
docs/generators/java-play-framework.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java-play-framework
sidebar_label: java-play-framework
title: Documentation for the java-play-framework Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java-play-framework | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java Play Framework Server application. | |
## 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 |

12
docs/generators/java-undertow-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java-undertow-server
sidebar_label: java-undertow-server
title: Documentation for the java-undertow-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java-undertow-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java Undertow Server application (beta). | |
## 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 |

12
docs/generators/java-vertx-web.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java-vertx-web
sidebar_label: java-vertx-web
title: Documentation for the java-vertx-web Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java-vertx-web | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java Vert.x-Web Server (beta). | |
## 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 |

12
docs/generators/java-vertx.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java-vertx
sidebar_label: java-vertx
title: Documentation for the java-vertx Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java-vertx | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a java-Vert.X Server library. | |
## 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 |

12
docs/generators/java.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for java
sidebar_label: java
title: Documentation for the java Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | java | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Java client library (HTTP lib: Jersey (1.x, 2.x), Retrofit (2.x), OpenFeign (10.x) and more. | |
## 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 |

12
docs/generators/javascript-apollo.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for javascript-apollo
sidebar_label: javascript-apollo
title: Documentation for the javascript-apollo Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | javascript-apollo | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a JavaScript client library (beta) using Apollo RESTDatasource. | |
## 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 |

12
docs/generators/javascript-closure-angular.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for javascript-closure-angular
sidebar_label: javascript-closure-angular
title: Documentation for the javascript-closure-angular Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | javascript-closure-angular | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Javascript AngularJS client library (beta) annotated with Google Closure Compiler annotations(https://developers.google.com/closure/compiler/docs/js-for-compiler?hl=en) | |
## 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 |

12
docs/generators/javascript-flowtyped.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for javascript-flowtyped
sidebar_label: javascript-flowtyped
title: Documentation for the javascript-flowtyped Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | javascript-flowtyped | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Javascript client library (beta) using Flow types and Fetch API. | |
## 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 |

12
docs/generators/javascript.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for javascript
sidebar_label: javascript
title: Documentation for the javascript Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | javascript | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a JavaScript client library. | |
## 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 |

12
docs/generators/jaxrs-cxf-cdi.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jaxrs-cxf-cdi
sidebar_label: jaxrs-cxf-cdi
title: Documentation for the jaxrs-cxf-cdi Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jaxrs-cxf-cdi | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java JAXRS Server according to JAXRS 2.0 specification, assuming an Apache CXF runtime and a Java EE runtime with CDI enabled. | |
## 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 |

12
docs/generators/jaxrs-cxf-client.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jaxrs-cxf-client
sidebar_label: jaxrs-cxf-client
title: Documentation for the jaxrs-cxf-client Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jaxrs-cxf-client | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Java JAXRS Client based on Apache CXF framework. | |
## 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 |

12
docs/generators/jaxrs-cxf-extended.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jaxrs-cxf-extended
sidebar_label: jaxrs-cxf-extended
title: Documentation for the jaxrs-cxf-extended Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jaxrs-cxf-extended | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Extends jaxrs-cxf with options to generate a functional mock server. | |
## 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 |

12
docs/generators/jaxrs-cxf.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jaxrs-cxf
sidebar_label: jaxrs-cxf
title: Documentation for the jaxrs-cxf Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jaxrs-cxf | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java JAXRS Server application based on Apache CXF framework. | |
## 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 |

12
docs/generators/jaxrs-jersey.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jaxrs-jersey
sidebar_label: jaxrs-jersey
title: Documentation for the jaxrs-jersey Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jaxrs-jersey | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java JAXRS Server application based on Jersey framework. | |
## 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 |

12
docs/generators/jaxrs-resteasy-eap.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jaxrs-resteasy-eap
sidebar_label: jaxrs-resteasy-eap
title: Documentation for the jaxrs-resteasy-eap Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jaxrs-resteasy-eap | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java JAXRS-Resteasy Server application. | |
## 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 |

12
docs/generators/jaxrs-resteasy.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jaxrs-resteasy
sidebar_label: jaxrs-resteasy
title: Documentation for the jaxrs-resteasy Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jaxrs-resteasy | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java JAXRS-Resteasy Server application. | |
## 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 |

12
docs/generators/jaxrs-spec.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jaxrs-spec
sidebar_label: jaxrs-spec
title: Documentation for the jaxrs-spec Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jaxrs-spec | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Java JAXRS Server according to JAXRS 2.0 specification. | |
## 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 |

12
docs/generators/jmeter.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for jmeter
sidebar_label: jmeter
title: Documentation for the jmeter Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | jmeter | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a JMeter .jmx file. | |
## 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 |

12
docs/generators/k6.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for k6
sidebar_label: k6
title: Documentation for the k6 Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | k6 | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a k6 script (beta). | |
## 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 |

12
docs/generators/kotlin-server-deprecated.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for kotlin-server-deprecated
sidebar_label: kotlin-server-deprecated
title: Documentation for the kotlin-server-deprecated Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | kotlin-server-deprecated | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Kotlin server (Ktor v1.1.3). IMPORTANT: this generator has been deprecated. Please migrate to `kotlin-server` which supports Ktor v1.5.2+. | |
## 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 |

12
docs/generators/kotlin-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for kotlin-server
sidebar_label: kotlin-server
title: Documentation for the kotlin-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | kotlin-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Kotlin server. | |
## 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 |

12
docs/generators/kotlin-spring.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for kotlin-spring
sidebar_label: kotlin-spring
title: Documentation for the kotlin-spring Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | kotlin-spring | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a Kotlin Spring application. | |
## 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 |

12
docs/generators/kotlin-vertx.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for kotlin-vertx
sidebar_label: kotlin-vertx
title: Documentation for the kotlin-vertx Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | kotlin-vertx | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a kotlin-vertx server. | |
## 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 |

12
docs/generators/kotlin.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for kotlin
sidebar_label: kotlin
title: Documentation for the kotlin Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | kotlin | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Kotlin client. | |
## 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 |

12
docs/generators/ktorm-schema.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for ktorm-schema
sidebar_label: ktorm-schema
title: Documentation for the ktorm-schema Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | ktorm-schema | pass this to the generate command after -g |
| generator type | SCHEMA | |
| helpTxt | Generates a kotlin-ktorm schema (beta) | |
## 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 |

12
docs/generators/lua.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for lua
sidebar_label: lua
title: Documentation for the lua Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | lua | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Lua client library (beta). | |
## 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 |

12
docs/generators/markdown.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for markdown
sidebar_label: markdown
title: Documentation for the markdown Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | markdown | pass this to the generate command after -g |
| generator type | DOCUMENTATION | |
| helpTxt | Generates a markdown documentation. | |
## 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 |

12
docs/generators/mysql-schema.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for mysql-schema
sidebar_label: mysql-schema
title: Documentation for the mysql-schema Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | mysql-schema | pass this to the generate command after -g |
| generator type | SCHEMA | |
| helpTxt | Generates a MySQL schema based on the model or schema defined in the OpenAPI specification (v2, v3). | |
## 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 |

12
docs/generators/nim.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for nim
sidebar_label: nim
title: Documentation for the nim Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | nim | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a nim client (beta). | |
## 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 |

12
docs/generators/nodejs-express-server.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for nodejs-express-server
sidebar_label: nodejs-express-server
title: Documentation for the nodejs-express-server Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | nodejs-express-server | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a NodeJS Express server (alpha). IMPORTANT: this generator may subject to breaking changes without further notice). | |
## 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 |

12
docs/generators/objc.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for objc
sidebar_label: objc
title: Documentation for the objc Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | objc | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an Objective-C client library. | |
## 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 |

12
docs/generators/ocaml.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for ocaml
sidebar_label: ocaml
title: Documentation for the ocaml Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | ocaml | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates an OCaml client library (beta). | |
## 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 |

12
docs/generators/openapi-yaml.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for openapi-yaml
sidebar_label: openapi-yaml
title: Documentation for the openapi-yaml Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | openapi-yaml | pass this to the generate command after -g |
| generator type | DOCUMENTATION | |
| helpTxt | Creates a static openapi.yaml file (OpenAPI spec v3). | |
## 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 |

12
docs/generators/openapi.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for openapi
sidebar_label: openapi
title: Documentation for the openapi Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | openapi | pass this to the generate command after -g |
| generator type | DOCUMENTATION | |
| helpTxt | Creates a static openapi.json file (OpenAPI spec v3.0). | |
## 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 |

12
docs/generators/perl.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for perl
sidebar_label: perl
title: Documentation for the perl Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | perl | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a Perl client library. | |
## 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 |

12
docs/generators/php-dt.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for php-dt
sidebar_label: php-dt
title: Documentation for the php-dt Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | php-dt | pass this to the generate command after -g |
| generator type | CLIENT | |
| helpTxt | Generates a PHP client relying on Data Transfer ( https://github.com/Articus/DataTransfer ) and compliant with PSR-7, PSR-11, PSR-17 and PSR-18. | |
## 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 |

12
docs/generators/php-laravel.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for php-laravel
sidebar_label: php-laravel
title: Documentation for the php-laravel Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | php-laravel | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a PHP laravel server library. | |
## 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 |

12
docs/generators/php-lumen.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for php-lumen
sidebar_label: php-lumen
title: Documentation for the php-lumen Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | php-lumen | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a PHP Lumen server library. | |
## 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 |

12
docs/generators/php-mezzio-ph.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for php-mezzio-ph
sidebar_label: php-mezzio-ph
title: Documentation for the php-mezzio-ph Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | php-mezzio-ph | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates PHP server stub using Mezzio ( https://docs.mezzio.dev/mezzio/ ) and Path Handler ( https://github.com/Articus/PathHandler ). | |
## 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 |

12
docs/generators/php-silex-deprecated.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for php-silex-deprecated
sidebar_label: php-silex-deprecated
title: Documentation for the php-silex-deprecated Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | php-silex-deprecated | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a PHP Silex server library. IMPORTANT NOTE: this generator is no longer actively maintained. | |
## 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 |

12
docs/generators/php-slim-deprecated.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for php-slim-deprecated
sidebar_label: php-slim-deprecated
title: Documentation for the php-slim-deprecated Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | php-slim-deprecated | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a PHP Slim Framework server library. IMPORTANT NOTE: this generator (Slim 3.x) is no longer actively maintained so please use 'php-slim4' generator instead. | |
## 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 |

12
docs/generators/php-slim4.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for php-slim4
sidebar_label: php-slim4
title: Documentation for the php-slim4 Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | php-slim4 | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a PHP Slim 4 Framework server library(with Mock server). | |
## 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 |

12
docs/generators/php-symfony.md
View File

@ -1,8 +1,16 @@
---
title: Config Options for php-symfony
sidebar_label: php-symfony
title: Documentation for the php-symfony Generator
---
## METADATA
| Property | Value | Notes |
| -------- | ----- | ----- |
| generator name | php-symfony | pass this to the generate command after -g |
| generator type | SERVER | |
| helpTxt | Generates a PHP Symfony server bundle. | |
## 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 |

Some files were not shown because too many files have changed in this diff Show More