-
-
Notifications
You must be signed in to change notification settings - Fork 6.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[PHP] New client generator php-dt (#10041)
* - new PHP client generator php-dt * - samples regen after rebase * - README update * - fix missing options for php-dt-modern config * - use another workaround to prevent special treatment of form media types in DefaultGenerator - GlobalSettings usage mangled behaviour of other generators - fix of missing spaces in generated docs * - samples update after rebase
- Loading branch information
Arthur Mogliev
committed
Aug 15, 2021
1 parent
fce10c7
commit 2210c9f
Showing
170 changed files
with
7,621 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| generatorName: php-dt | ||
| outputDir: samples/client/petstore/php-dt-modern | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/php-dt-modern | ||
| additionalProperties: | ||
| modern: "true" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| generatorName: php-dt | ||
| outputDir: samples/client/petstore/php-dt | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/php-dt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,242 @@ | ||
| --- | ||
| title: Config Options for php-dt | ||
| sidebar_label: php-dt | ||
| --- | ||
|
|
||
| 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 | | ||
| | ------ | ----------- | ------ | ------- | | ||
| |allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false| | ||
| |apiPackage|package for generated api classes| |null| | ||
| |artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| | ||
| |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| | ||
| |ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true| | ||
| |invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null| | ||
| |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| | ||
| |modelPackage|package for generated models| |null| | ||
| |modern|use modern language features (generated code will require PHP 8.0)| |false| | ||
| |packageName|The main package name for classes. e.g. GeneratedPetstore| |null| | ||
| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| | ||
| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| | ||
| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| | ||
| |srcBasePath|The directory to serve as source root.| |null| | ||
| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| | ||
|
|
||
| ## IMPORT MAPPING | ||
|
|
||
| | Type/Alias | Imports | | ||
| | ---------- | ------- | | ||
|
|
||
|
|
||
| ## INSTANTIATION TYPES | ||
|
|
||
| | Type/Alias | Instantiated By | | ||
| | ---------- | --------------- | | ||
| |array|array| | ||
| |map|array| | ||
|
|
||
|
|
||
| ## LANGUAGE PRIMITIVES | ||
|
|
||
| <ul class="column-ul"> | ||
| <li>DateTime</li> | ||
| <li>bool</li> | ||
| <li>boolean</li> | ||
| <li>byte</li> | ||
| <li>double</li> | ||
| <li>float</li> | ||
| <li>int</li> | ||
| <li>integer</li> | ||
| <li>mixed</li> | ||
| <li>number</li> | ||
| <li>object</li> | ||
| <li>string</li> | ||
| <li>void</li> | ||
| </ul> | ||
|
|
||
| ## RESERVED WORDS | ||
|
|
||
| <ul class="column-ul"> | ||
| <li>__halt_compiler</li> | ||
| <li>_header_accept</li> | ||
| <li>_tempbody</li> | ||
| <li>abstract</li> | ||
| <li>and</li> | ||
| <li>array</li> | ||
| <li>as</li> | ||
| <li>break</li> | ||
| <li>callable</li> | ||
| <li>case</li> | ||
| <li>catch</li> | ||
| <li>class</li> | ||
| <li>clone</li> | ||
| <li>const</li> | ||
| <li>continue</li> | ||
| <li>declare</li> | ||
| <li>default</li> | ||
| <li>die</li> | ||
| <li>do</li> | ||
| <li>echo</li> | ||
| <li>else</li> | ||
| <li>elseif</li> | ||
| <li>empty</li> | ||
| <li>enddeclare</li> | ||
| <li>endfor</li> | ||
| <li>endforeach</li> | ||
| <li>endif</li> | ||
| <li>endswitch</li> | ||
| <li>endwhile</li> | ||
| <li>eval</li> | ||
| <li>exit</li> | ||
| <li>extends</li> | ||
| <li>final</li> | ||
| <li>for</li> | ||
| <li>foreach</li> | ||
| <li>formparams</li> | ||
| <li>function</li> | ||
| <li>global</li> | ||
| <li>goto</li> | ||
| <li>headerparams</li> | ||
| <li>httpbody</li> | ||
| <li>if</li> | ||
| <li>implements</li> | ||
| <li>include</li> | ||
| <li>include_once</li> | ||
| <li>instanceof</li> | ||
| <li>insteadof</li> | ||
| <li>interface</li> | ||
| <li>isset</li> | ||
| <li>list</li> | ||
| <li>namespace</li> | ||
| <li>new</li> | ||
| <li>or</li> | ||
| <li>print</li> | ||
| <li>private</li> | ||
| <li>protected</li> | ||
| <li>public</li> | ||
| <li>queryparams</li> | ||
| <li>require</li> | ||
| <li>require_once</li> | ||
| <li>resourcepath</li> | ||
| <li>return</li> | ||
| <li>static</li> | ||
| <li>switch</li> | ||
| <li>throw</li> | ||
| <li>trait</li> | ||
| <li>try</li> | ||
| <li>unset</li> | ||
| <li>use</li> | ||
| <li>var</li> | ||
| <li>while</li> | ||
| <li>xor</li> | ||
| </ul> | ||
|
|
||
| ## FEATURE SET | ||
|
|
||
|
|
||
| ### Client Modification Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |BasePath|✗|ToolingExtension | ||
| |Authorizations|✗|ToolingExtension | ||
| |UserAgent|✗|ToolingExtension | ||
| |MockServer|✗|ToolingExtension | ||
|
|
||
| ### 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 | ||
| |Array|✓|OAS2,OAS3 | ||
| |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 | ||
| |ParameterizedServer|✗|OAS3 | ||
| |ParameterStyling|✗|OAS3 | ||
| |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 | ||
| |Polymorphism|✗|OAS2,OAS3 | ||
| |Union|✗|OAS3 | ||
|
|
||
| ### 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 | ||
|
|
||
| ### Wire Format Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |JSON|✓|OAS2,OAS3 | ||
| |XML|✗|OAS2,OAS3 | ||
| |PROTOBUF|✗|ToolingExtension | ||
| |Custom|✗|OAS2,OAS3 |
Oops, something went wrong.