-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Scala][Client]Add Http4s scala3 client codegen (#19658)
* fix attemp * use java.time.Instant * fix client gen * Tweeks * header and form * use scala 3 enum * more tweeks * add additional properties; add auth * add form media type * add modelsOnly * add unit tests * add petstore samples * add doc * add new samle to .github/workflows/samples-scala.yaml * update build.sbt template * simply the baseclient * add None to optional field * tweek auth model and format --------- Co-authored-by: Jenny Leahy <[email protected]>
- Loading branch information
1 parent
e5dee54
commit 9791e6f
Showing
49 changed files
with
3,372 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| generatorName: scala-http4s | ||
| outputDir: samples/client/petstore/scala-http4s | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/scala-http4s/petstore.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/scala-http4s | ||
| additionalProperties: | ||
| artifactId: scala-http4s-client |
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,272 @@ | ||
| --- | ||
| title: Documentation for the scala-http4s Generator | ||
| --- | ||
|
|
||
| ## METADATA | ||
|
|
||
| | Property | Value | Notes | | ||
| | -------- | ----- | ----- | | ||
| | generator name | scala-http4s | pass this to the generate command after -g | | ||
| | generator stability | STABLE | | | ||
| | generator type | CLIENT | | | ||
| | generator language | Scala | | | ||
| | generator default templating engine | mustache | | | ||
| | helpTxt | Generates a scala-http4s 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 | | ||
| |-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------ | ------- | | ||
| | allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | |false| | ||
| | packageName | main package for the generated classes, parent package for api package and model package | |null| | ||
| | artifactId | project name / artifactId for for the generated project | |null| | ||
| | excludeSbt | exclude sbt from generation | |null| | ||
| | excludeApi | exclude apis from generation | |null| | ||
| | prependFormOrBodyParameters | Add form or body parameters to the beginning of the parameter list. | |false| | ||
| | 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| | ||
| | 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| | ||
| | sortModelPropertiesByRequiredFlag | Sort model properties to place required parameters before optional parameters. | |true| | ||
| | sortParamsByRequiredFlag | Sort method arguments to place required parameters before optional parameters. | |true| | ||
| | sourceFolder | source folder for generated code | |null| | ||
|
|
||
| ## IMPORT MAPPING | ||
|
|
||
| | Type/Alias | Imports | | ||
| | ---------- | ------- | | ||
| |ArrayBuffer|scala.collection.mutable.ArrayBuffer| | ||
| |Date|java.util.Date| | ||
| |File|java.io.File| | ||
| |HashMap|scala.collection.immutable.HashMap| | ||
| |Instant|java.time.Instant| | ||
| |Json|io.circe.Json| | ||
| |LocalDate|java.time.LocalDate| | ||
| |LocalDateTime|java.time.LocalDateTime| | ||
| |LocalTime|java.time.LocalTime| | ||
| |Map|scala.collection.immutable.Map| | ||
| |OffsetDateTime|java.time.OffsetDateTime| | ||
| |Seq|scala.collection.immutable.Seq| | ||
| |Timestamp|java.sql.Timestamp| | ||
| |URI|java.net.URI| | ||
| |UUID|java.util.UUID| | ||
| |ZonedDateTime|java.time.ZonedDateTime| | ||
|
|
||
|
|
||
| ## INSTANTIATION TYPES | ||
|
|
||
| | Type/Alias | Instantiated By | | ||
| | ---------- | --------------- | | ||
| |array|Seq| | ||
| |list|List| | ||
| |map|Map| | ||
| |seq|Seq| | ||
| |set|Set| | ||
|
|
||
|
|
||
| ## LANGUAGE PRIMITIVES | ||
|
|
||
| <ul class="column-ul"> | ||
| <li>Any</li> | ||
| <li>AnyRef</li> | ||
| <li>AnyVal</li> | ||
| <li>BigDecimal</li> | ||
| <li>Boolean</li> | ||
| <li>Double</li> | ||
| <li>Float</li> | ||
| <li>Int</li> | ||
| <li>Integer</li> | ||
| <li>Long</li> | ||
| <li>Object</li> | ||
| <li>String</li> | ||
| </ul> | ||
|
|
||
| ## RESERVED WORDS | ||
|
|
||
| <ul class="column-ul"> | ||
| <li>abstract</li> | ||
| <li>assert</li> | ||
| <li>break</li> | ||
| <li>byte</li> | ||
| <li>case</li> | ||
| <li>catch</li> | ||
| <li>char</li> | ||
| <li>class</li> | ||
| <li>const</li> | ||
| <li>continue</li> | ||
| <li>def</li> | ||
| <li>default</li> | ||
| <li>do</li> | ||
| <li>double</li> | ||
| <li>else</li> | ||
| <li>enum</li> | ||
| <li>extends</li> | ||
| <li>false</li> | ||
| <li>final</li> | ||
| <li>finally</li> | ||
| <li>float</li> | ||
| <li>for</li> | ||
| <li>forsome</li> | ||
| <li>goto</li> | ||
| <li>if</li> | ||
| <li>implements</li> | ||
| <li>implicit</li> | ||
| <li>import</li> | ||
| <li>instanceof</li> | ||
| <li>int</li> | ||
| <li>interface</li> | ||
| <li>lazy</li> | ||
| <li>long</li> | ||
| <li>match</li> | ||
| <li>native</li> | ||
| <li>new</li> | ||
| <li>null</li> | ||
| <li>object</li> | ||
| <li>override</li> | ||
| <li>package</li> | ||
| <li>private</li> | ||
| <li>protected</li> | ||
| <li>public</li> | ||
| <li>return</li> | ||
| <li>sealed</li> | ||
| <li>short</li> | ||
| <li>static</li> | ||
| <li>strictfp</li> | ||
| <li>super</li> | ||
| <li>switch</li> | ||
| <li>synchronized</li> | ||
| <li>this</li> | ||
| <li>throw</li> | ||
| <li>throws</li> | ||
| <li>trait</li> | ||
| <li>transient</li> | ||
| <li>true</li> | ||
| <li>try</li> | ||
| <li>type</li> | ||
| <li>val</li> | ||
| <li>var</li> | ||
| <li>void</li> | ||
| <li>volatile</li> | ||
| <li>while</li> | ||
| <li>with</li> | ||
| <li>yield</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 | ||
| |Uuid|✗| | ||
| |Array|✓|OAS2,OAS3 | ||
| |Null|✗|OAS3 | ||
| |AnyType|✗|OAS2,OAS3 | ||
| |Object|✓|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 | ||
| |allOf|✗|OAS2,OAS3 | ||
| |anyOf|✗|OAS3 | ||
| |oneOf|✗|OAS3 | ||
| |not|✗|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 | ||
| |SignatureAuth|✗|OAS3 | ||
| |AWSV4Signature|✗|ToolingExtension | ||
|
|
||
| ### Wire Format Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |JSON|✓|OAS2,OAS3 | ||
| |XML|✓|OAS2,OAS3 | ||
| |PROTOBUF|✗|ToolingExtension | ||
| |Custom|✓|OAS2,OAS3 |
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
Oops, something went wrong.