Skip to content

Commit cd59338

Browse files
committed
Ran doc generator.
1 parent 8e68d5d commit cd59338

1 file changed

Lines changed: 27 additions & 37 deletions

File tree

docs/generators/cpp-oatpp-client.md

Lines changed: 27 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -11,35 +11,21 @@ title: Documentation for the cpp-oatpp-client Generator
1111
| generator type | CLIENT | |
1212
| generator language | C++ | |
1313
| generator default templating engine | mustache | |
14-
| helpTxt | Generates a C++ client library (based on oat++). | |
14+
| helpTxt | Generates a C++ API client (based on Oat++) | |
1515

1616
## CONFIG OPTIONS
1717
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.
1818

1919
| Option | Description | Values | Default |
2020
| ------ | ----------- | ------ | ------- |
21-
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
22-
|contentCompression|Enable Compressed Content Encoding for requests and responses| |false|
23-
|cppNamespace|C++ namespace (convention: name::space::for::api).| |OpenAPI|
24-
|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|
25-
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
26-
|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|
27-
|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|
28-
|modelNamePrefix|Prefix that will be prepended to all model names.| |OAI|
29-
|optionalProjectFile|Generate client.pri.| |true|
30-
|packageName|C++ package (library) name.| |QtOpenAPIClient|
31-
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
21+
|addExternalLibs|Add the Possibility to fetch and compile external Libraries needed by this Framework.| |true|
3222
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
33-
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
34-
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
3523
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -&gt; Value)| |true|
3624

3725
## IMPORT MAPPING
3826

3927
| Type/Alias | Imports |
4028
| ---------- | ------- |
41-
|OAIHttpFileElement|#include &quot;OAIHttpFileElement.h&quot;|
42-
|QJsonValue|#include &lt;QJsonValue&gt;|
4329

4430

4531
## INSTANTIATION TYPES
@@ -51,20 +37,22 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5137
## LANGUAGE PRIMITIVES
5238

5339
<ul class="column-ul">
54-
<li>QByteArray</li>
55-
<li>QDate</li>
56-
<li>QDateTime</li>
57-
<li>QString</li>
58-
<li>bool</li>
59-
<li>double</li>
60-
<li>float</li>
61-
<li>qint32</li>
62-
<li>qint64</li>
40+
<li>oatpp::Any</li>
41+
<li>oatpp::Boolean</li>
42+
<li>oatpp::Fields</li>
43+
<li>oatpp::Float64</li>
44+
<li>oatpp::Int32</li>
45+
<li>oatpp::Int64</li>
46+
<li>oatpp::Object</li>
47+
<li>oatpp::String</li>
48+
<li>oatpp::UnorderedSet</li>
49+
<li>oatpp::Vector</li>
6350
</ul>
6451

6552
## RESERVED WORDS
6653

6754
<ul class="column-ul">
55+
<li>NULL</li>
6856
<li>alignas</li>
6957
<li>alignof</li>
7058
<li>and</li>
@@ -222,9 +210,9 @@ These options may be applied as additional-properties (cli) or configOptions (pl
222210
|ExternalDocumentation|✓|OAS2,OAS3
223211
|Examples|✓|OAS2,OAS3
224212
|XMLStructureDefinitions|✗|OAS2,OAS3
225-
|MultiServer||OAS3
226-
|ParameterizedServer||OAS3
227-
|ParameterStyling||OAS3
213+
|MultiServer||OAS3
214+
|ParameterizedServer||OAS3
215+
|ParameterStyling||OAS3
228216
|Callbacks|✗|OAS3
229217
|LinkObjects|✗|OAS3
230218

@@ -237,14 +225,14 @@ These options may be applied as additional-properties (cli) or configOptions (pl
237225
|Body|✓|OAS2
238226
|FormUnencoded|✓|OAS2
239227
|FormMultipart|✓|OAS2
240-
|Cookie||OAS3
228+
|Cookie||OAS3
241229

242230
### Schema Support Feature
243231
| Name | Supported | Defined By |
244232
| ---- | --------- | ---------- |
245233
|Simple|✓|OAS2,OAS3
246234
|Composite|✓|OAS2,OAS3
247-
|Polymorphism||OAS2,OAS3
235+
|Polymorphism||OAS2,OAS3
248236
|Union|✗|OAS3
249237
|allOf|✗|OAS2,OAS3
250238
|anyOf|✗|OAS3
@@ -254,14 +242,16 @@ These options may be applied as additional-properties (cli) or configOptions (pl
254242
### Security Feature
255243
| Name | Supported | Defined By |
256244
| ---- | --------- | ---------- |
257-
|BasicAuth||OAS2,OAS3
258-
|ApiKey||OAS2,OAS3
245+
|BasicAuth||OAS2,OAS3
246+
|ApiKey||OAS2,OAS3
259247
|OpenIDConnect|✗|OAS3
260-
|BearerToken|✓|OAS3
261-
|OAuth2_Implicit|✓|OAS2,OAS3
262-
|OAuth2_Password|✓|OAS2,OAS3
263-
|OAuth2_ClientCredentials|✓|OAS2,OAS3
264-
|OAuth2_AuthorizationCode|✓|OAS2,OAS3
248+
|BearerToken|✗|OAS3
249+
|OAuth2_Implicit|✗|OAS2,OAS3
250+
|OAuth2_Password|✗|OAS2,OAS3
251+
|OAuth2_ClientCredentials|✗|OAS2,OAS3
252+
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
253+
|SignatureAuth|✗|OAS3
254+
|AWSV4Signature|✗|ToolingExtension
265255

266256
### Wire Format Feature
267257
| Name | Supported | Defined By |

0 commit comments

Comments
 (0)