Skip to content

Commit e04ed99

Browse files
committed
update doc
1 parent 5c4ae7a commit e04ed99

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

docs/generators.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ The following generators are available:
6565
* [scala-pekko](generators/scala-pekko.md)
6666
* [scala-sttp](generators/scala-sttp.md)
6767
* [scala-sttp4 (beta)](generators/scala-sttp4.md)
68+
* [scala-sttp4-jsoniter (beta)](generators/scala-sttp4-jsoniter.md)
6869
* [scalaz](generators/scalaz.md)
6970
* [swift-combine](generators/swift-combine.md)
7071
* [swift5](generators/swift5.md)

docs/generators/scala-sttp4-jsoniter.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2020
| ------ | ----------- | ------ | ------- |
2121
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
2222
|apiPackage|package for generated api classes| |null|
23-
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for JDK 1.8+)</dd></dl>|java8|
2423
|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|
2524
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
2625
|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|
@@ -34,14 +33,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3433
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
3534
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
3635
|sourceFolder|source folder for generated code| |null|
37-
|sttpClientVersion|The version of sttp client| |4.0.0-M19|
36+
|sttpClientVersion|The version of sttp client| |4.0.0-RC1|
3837

3938
## IMPORT MAPPING
4039

4140
| Type/Alias | Imports |
4241
| ---------- | ------- |
4342
|Array|java.util.List|
4443
|ArrayList|java.util.ArrayList|
44+
|BigDecimal|scala.math.BigDecimal|
4545
|Date|java.util.Date|
4646
|DateTime|org.joda.time.*|
4747
|File|java.io.File|
@@ -56,6 +56,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5656
|Timestamp|java.sql.Timestamp|
5757
|URI|java.net.URI|
5858
|UUID|java.util.UUID|
59+
|io.circe.Json|com.github.plokhotnyuk.jsoniter_scala.circe.JsoniterScalaCodec.*|
5960

6061

6162
## INSTANTIATION TYPES
@@ -89,6 +90,9 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8990
## RESERVED WORDS
9091

9192
<ul class="column-ul">
93+
<li>Either</li>
94+
<li>Method</li>
95+
<li>Request</li>
9296
<li>abstract</li>
9397
<li>case</li>
9498
<li>catch</li>
@@ -97,12 +101,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl
97101
<li>def</li>
98102
<li>do</li>
99103
<li>else</li>
104+
<li>enum</li>
105+
<li>export</li>
100106
<li>extends</li>
101107
<li>false</li>
102108
<li>final</li>
103109
<li>finally</li>
104110
<li>for</li>
105111
<li>forSome</li>
112+
<li>given</li>
106113
<li>if</li>
107114
<li>implicit</li>
108115
<li>import</li>
@@ -118,12 +125,14 @@ These options may be applied as additional-properties (cli) or configOptions (pl
118125
<li>return</li>
119126
<li>sealed</li>
120127
<li>super</li>
128+
<li>then</li>
121129
<li>this</li>
122130
<li>throw</li>
123131
<li>trait</li>
124132
<li>true</li>
125133
<li>try</li>
126134
<li>type</li>
135+
<li>using</li>
127136
<li>val</li>
128137
<li>var</li>
129138
<li>while</li>
@@ -214,7 +223,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
214223
|Body|✓|OAS2
215224
|FormUnencoded|✓|OAS2
216225
|FormMultipart|✓|OAS2
217-
|Cookie||OAS3
226+
|Cookie||OAS3
218227

219228
### Schema Support Feature
220229
| Name | Supported | Defined By |

0 commit comments

Comments
 (0)