Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Commit 49a8f4f

Browse files
committed
Docs updated
1 parent 818b212 commit 49a8f4f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+88
-88
lines changed

docs/generators/android.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3434
|library|library template (sub-template) to use|<dl><dt>**volley**</dt><dd>HTTP client: Volley 1.0.19 (default)</dd><dt>**httpclient**</dt><dd>HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be deprecated in the next major release.</dd></dl>|null|
3535
|modelPackage|package for generated models| |null|
3636
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
37-
|serializableModel|boolean - toggle &quot;implements Serializable&quot; for generated models| |false|
37+
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
3838
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
3939
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
4040
|sourceFolder|source folder for generated code| |null|

docs/generators/aspnetcore.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3333
|nullableReferenceTypes|Use nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer.| |false|
3434
|operationIsAsync|Set methods to async or sync (default).| |false|
3535
|operationModifier|Operation Modifier can be virtual or abstract|<dl><dt>**virtual**</dt><dd>Keep method virtual</dd><dt>**abstract**</dt><dd>Make method abstract</dd></dl>|virtual|
36-
|operationResultTask|Set methods result to Task&lt;&gt;.| |false|
36+
|operationResultTask|Set methods result to Task<>.| |false|
3737
|packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
3838
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
3939
|packageDescription|Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |A library generated from a OpenAPI doc|
@@ -42,11 +42,11 @@ These options may be applied as additional-properties (cli) or configOptions (pl
4242
|packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
4343
|packageVersion|C# package version.| |1.0.0|
4444
|pocoModels|Build POCO Models| |false|
45-
|returnICollection|Return ICollection&lt;T&gt; instead of the concrete type.| |false|
45+
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
4646
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
4747
|sourceFolder|source folder for generated code| |src|
4848
|swashbuckleVersion|Swashbuckle version: 3.0.0 (deprecated), 4.0.0 (deprecated), 5.0.0 (deprecated), 6.4.0|<dl><dt>**3.0.0**</dt><dd>Swashbuckle 3.0.0</dd><dt>**4.0.0**</dt><dd>Swashbuckle 4.0.0</dd><dt>**5.0.0**</dt><dd>Swashbuckle 5.0.0</dd><dt>**6.4.0**</dt><dd>Swashbuckle 6.4.0</dd></dl>|3.0.0|
49-
|useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false|
49+
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
5050
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
5151
|useDefaultRouting|Use default routing for the ASP.NET Core version.| |true|
5252
|useFrameworkReference|Use frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.| |false|

docs/generators/clojure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2525
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
2626
|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|
2727
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
28-
|projectDescription|description of the project (Default: using info.description or &quot;Client library of &lt;projectName&gt;&quot;)| |null|
28+
|projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null|
2929
|projectLicenseName|name of the license the project uses (Default: using info.license.name or not included in project.clj)| |null|
3030
|projectLicenseUrl|URL of the license the project uses (Default: using info.license.url or not included in project.clj)| |null|
31-
|projectName|name of the project (Default: generated from info.title or &quot;openapi-clj-client&quot;)| |null|
31+
|projectName|name of the project (Default: generated from info.title or "openapi-clj-client")| |null|
3232
|projectUrl|URL of the project (Default: using info.contact.url or not included in project.clj)| |null|
33-
|projectVersion|version of the project (Default: using info.version or &quot;1.0.0&quot;)| |null|
33+
|projectVersion|version of the project (Default: using info.version or "1.0.0")| |null|
3434
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
3535
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
3636

docs/generators/cpp-pistache-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2222
|helpersPackage|Specify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).| |org.openapitools.server.helpers|
2323
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
2424
|useStructModel|Use struct-based model template instead of get/set-based model template| |false|
25-
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -&gt; Value)| |true|
25+
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
2626

2727
## IMPORT MAPPING
2828

docs/generators/cpp-qt-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3131
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
3232
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
3333
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
34-
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -&gt; Value)| |true|
34+
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
3535

3636
## IMPORT MAPPING
3737

docs/generators/cpp-qt-qhttpengine-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3030
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
3131
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
3232
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
33-
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -&gt; Value)| |true|
33+
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
3434

3535
## IMPORT MAPPING
3636

docs/generators/cpp-restbed-server-deprecated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2020
| ------ | ----------- | ------ | ------- |
2121
|apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.server.api|
2222
|declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| ||
23-
|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include &quot;Commons.h&quot; | ||
23+
|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
2424
|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.server.model|
2525
|packageVersion|C++ package version.| |1.0.0|
2626
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|

docs/generators/cpp-restbed-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2020
| ------ | ----------- | ------ | ------- |
2121
|apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.server.api|
2222
|declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| ||
23-
|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include &quot;Commons.h&quot; | ||
23+
|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
2424
|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.server.model|
2525
|packageVersion|C++ package version.| |1.0.0|
2626
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|

docs/generators/cpp-restsdk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2020
| ------ | ----------- | ------ | ------- |
2121
|apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.client.api|
2222
|declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| ||
23-
|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include &quot;Commons.h&quot; | ||
23+
|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
2424
|generateGMocksForApis|Generate Google Mock classes for APIs.| |null|
2525
|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.client.model|
2626
|packageName|C++ package (library) name.| |CppRestOpenAPIClient|
2727
|packageVersion|C++ package version.| |1.0.0|
2828
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
29-
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -&gt; Value)| |true|
29+
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
3030

3131
## IMPORT MAPPING
3232

docs/generators/cpp-tiny.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2828
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
2929
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
3030
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
31-
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -&gt; Value)| |true|
31+
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
3232

3333
## IMPORT MAPPING
3434

0 commit comments

Comments
 (0)