Skip to content

Commit 0240533

Browse files
committed
Release 1.13.7
1 parent a253330 commit 0240533

36 files changed

+144
-140
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ val booksListingRequest: Request[DecodeResult[Either[String, List[Book]]]] =
139139
Add the following dependency:
140140

141141
```sbt
142-
"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.13.6"
142+
"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.13.7"
143143
```
144144

145145
Then, import:

generated-doc/out/client/http4s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Add the dependency:
44

55
```scala
6-
"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "1.13.6"
6+
"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "1.13.7"
77
```
88

99
To interpret an endpoint definition as an `org.http4s.Request[F]`, import:

generated-doc/out/client/play.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ See the [Play framework documentation](https://www.playframework.com/documentati
66
For **Play 3.0**, add the dependency:
77

88
```scala
9-
"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.13.6"
9+
"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.13.7"
1010
```
1111

1212
For **Play 2.9**, add
1313

1414
```scala
15-
"com.softwaremill.sttp.tapir" %% "tapir-play29-client" % "1.13.6"
15+
"com.softwaremill.sttp.tapir" %% "tapir-play29-client" % "1.13.7"
1616
```
1717

1818
instead. Furthermore, replace all uses of `sttp.capabilities.pekko.PekkoStreams` in the following code snippets with `sttp.capabilities.akka.AkkaStreams`.

generated-doc/out/client/sttp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Add the dependency:
44

55
```scala
6-
"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.13.6"
6+
"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.13.7"
77
```
88

99
To make requests using an endpoint definition using the [sttp client](https://github.com/softwaremill/sttp), import:
@@ -101,7 +101,7 @@ In this case add the following dependencies (note the [`%%%`](https://www.scala-
101101
instead of the usual `%%`):
102102

103103
```scala
104-
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "1.13.6"
104+
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "1.13.7"
105105
"io.github.cquiroz" %%% "scala-java-time" % "2.2.0" // implementations of java.time classes for Scala.JS
106106
```
107107

generated-doc/out/client/sttp4.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Add the dependency:
44

55
```scala
6-
"com.softwaremill.sttp.tapir" %% "tapir-sttp-client4" % "1.13.6"
6+
"com.softwaremill.sttp.tapir" %% "tapir-sttp-client4" % "1.13.7"
77
```
88

99
To make requests using an endpoint definition using the [sttp client](https://github.com/softwaremill/sttp), import:
@@ -124,7 +124,7 @@ In this case add the following dependencies (note the [`%%%`](https://www.scala-
124124
instead of the usual `%%`):
125125

126126
```scala
127-
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client4" % "1.13.6"
127+
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client4" % "1.13.7"
128128
"io.github.cquiroz" %%% "scala-java-time" % "2.2.0" // implementations of java.time classes for Scala.JS
129129
```
130130

generated-doc/out/docs/asyncapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
To use, add the following dependencies:
44

55
```scala
6-
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "1.13.6"
6+
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "1.13.7"
77
"com.softwaremill.sttp.apispec" %% "asyncapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
88
```
99

generated-doc/out/docs/json-schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
You can conveniently generate JSON schema from Tapir schema, which can be derived from your Scala types. Use `TapirSchemaToJsonSchema`:
44

55
```scala
6-
"com.softwaremill.sttp.tapir" %% "tapir-apispec-docs" % "1.13.6"
6+
"com.softwaremill.sttp.tapir" %% "tapir-apispec-docs" % "1.13.7"
77
```
88

99
Schema generation can now be performed like in the following example:

generated-doc/out/docs/openapi.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ these steps can be done separately, giving you complete control over the process
1313
To generate OpenAPI documentation and expose it using the Swagger UI in a single step, first add the dependency:
1414

1515
```scala
16-
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.13.6"
16+
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.13.7"
1717
```
1818

1919
Then, you can interpret a list of endpoints using `SwaggerInterpreter`. The result will be a list of file-serving
@@ -55,7 +55,7 @@ for details.
5555
Similarly as above, you'll need the following dependency:
5656

5757
```scala
58-
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.13.6"
58+
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.13.7"
5959
```
6060

6161
And the server endpoints can be generated using the `sttp.tapir.redoc.bundle.RedocInterpreter` class.
@@ -65,7 +65,7 @@ And the server endpoints can be generated using the `sttp.tapir.redoc.bundle.Red
6565
To generate the docs in the OpenAPI yaml format, add the following dependencies:
6666

6767
```scala
68-
"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.13.6"
68+
"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.13.7"
6969
"com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
7070
```
7171

@@ -133,7 +133,7 @@ For example, generating the OpenAPI 3.0.3 YAML string can be achieved by perform
133133

134134
Firstly add dependencies:
135135
```scala
136-
"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.13.6"
136+
"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.13.7"
137137
"com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
138138
```
139139

@@ -163,12 +163,12 @@ The modules `tapir-swagger-ui` and `tapir-redoc` contain server endpoint definit
163163
yaml format, will expose it using the given context path. To use, add as a dependency either
164164
`tapir-swagger-ui`:
165165
```scala
166-
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "1.13.6"
166+
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "1.13.7"
167167
```
168168

169169
or `tapir-redoc`:
170170
```scala
171-
"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.13.6"
171+
"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.13.7"
172172
```
173173

174174
Then, you'll need to pass the server endpoints to your server interpreter. For example, using akka-http:
@@ -212,6 +212,10 @@ Options can be customised by providing an instance of `OpenAPIDocsOptions` to th
212212
* `failOnDuplicateOperationId`: if set to `true`, the interpreter will throw an exception if it encounters two endpoints
213213
with the same operation id. An OpenAPI document with duplicate operation ids is not valid. Code generators can
214214
silently drop duplicates. This is also verified by the [endpoint verifier](../testing.md).
215+
* `failOnDuplicateSchemaName`: if set to `true`, the interpreter will throw an exception if it encounters two schemas
216+
which (without automatic deduplication by adding a numeric suffix) would be identical. Having automatically resolved
217+
de-duplications might result in different names depending on the order of endpoints. This might result in false
218+
positive changes in the OpenApi document.
215219

216220
## Inlined and referenced schemas
217221

generated-doc/out/endpoint/integrations.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The `tapir-cats` module contains additional instances for some [cats](https://ty
1212
datatypes as well as additional syntax:
1313

1414
```scala
15-
"com.softwaremill.sttp.tapir" %% "tapir-cats" % "1.13.6"
15+
"com.softwaremill.sttp.tapir" %% "tapir-cats" % "1.13.7"
1616
```
1717

1818
- `import sttp.tapir.integ.cats.codec.*` - brings schema, validator and codec instances
@@ -22,7 +22,7 @@ Additionally, the `tapir-cats-effect` module contains an implementation of the `
2222
between the sttp-internal `MonadError` and the cats-effect `Sync` typeclass:
2323

2424
```scala
25-
"com.softwaremill.sttp.tapir" %% "tapir-cats-effect" % "1.13.6"
25+
"com.softwaremill.sttp.tapir" %% "tapir-cats-effect" % "1.13.7"
2626
```
2727

2828
## Refined integration
@@ -31,7 +31,7 @@ If you use [refined](https://github.com/fthomas/refined), the `tapir-refined` mo
3131
validators for `T Refined P` as long as a codec for `T` already exists:
3232

3333
```scala
34-
"com.softwaremill.sttp.tapir" %% "tapir-refined" % "1.13.6"
34+
"com.softwaremill.sttp.tapir" %% "tapir-refined" % "1.13.7"
3535
```
3636

3737
You'll need to extend the `sttp.tapir.codec.refined.TapirCodecRefined`
@@ -52,7 +52,7 @@ If you use [iron](https://github.com/Iltotore/iron), the `tapir-iron` module wil
5252
validators for `T :| P` as long as a codec for `T` already exists:
5353

5454
```scala
55-
"com.softwaremill.sttp.tapir" %% "tapir-iron" % "1.13.6"
55+
"com.softwaremill.sttp.tapir" %% "tapir-iron" % "1.13.7"
5656
```
5757

5858
The module is only available for Scala 3 since iron is not designed to work with Scala 2.
@@ -145,7 +145,7 @@ The `tapir-enumeratum` module provides schemas, validators and codecs for [Enume
145145
enumerations. To use, add the following dependency:
146146

147147
```scala
148-
"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "1.13.6"
148+
"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "1.13.7"
149149
```
150150

151151
Then, `import sttp.tapir.codec.enumeratum.*`, or extends the `sttp.tapir.codec.enumeratum.TapirCodecEnumeratum` trait.
@@ -158,7 +158,7 @@ If you use [scala-newtype](https://github.com/estatico/scala-newtype), the `tapi
158158
schemas for types with a `@newtype` and `@newsubtype` annotations as long as a codec and schema for its underlying value already exists:
159159

160160
```scala
161-
"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "1.13.6"
161+
"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "1.13.7"
162162
```
163163

164164
Then, `import sttp.tapir.codec.newtype.*`, or extend the `sttp.tapir.codec.newtype.TapirCodecNewType` trait to bring the implicit values into scope.
@@ -169,7 +169,7 @@ If you use [monix newtypes](https://github.com/monix/newtypes), the `tapir-monix
169169
schemas for types which extend `NewtypeWrapped` and `NewsubtypeWrapped` annotations as long as a codec and schema for its underlying value already exists:
170170

171171
```scala
172-
"com.softwaremill.sttp.tapir" %% "tapir-monix-newtype" % "1.13.6"
172+
"com.softwaremill.sttp.tapir" %% "tapir-monix-newtype" % "1.13.7"
173173
```
174174

175175
Then, `import sttp.tapir.codec.monix.newtype.*`, or extend the `sttp.tapir.codec.monix.newtype.TapirCodecMonixNewType` trait to bring the implicit values into scope.
@@ -180,7 +180,7 @@ If you use [ZIO Prelude Newtypes](https://zio.github.io/zio-prelude/docs/newtype
180180
schemas for types defined using `Newtype` and `Subtype` as long as a codec and a schema for the underlying type already exists:
181181

182182
```scala
183-
"com.softwaremill.sttp.tapir" %% "tapir-zio-prelude" % "1.13.6"
183+
"com.softwaremill.sttp.tapir" %% "tapir-zio-prelude" % "1.13.7"
184184
```
185185

186186
Then, mix in `sttp.tapir.codec.zio.prelude.newtype.TapirNewtypeSupport` into your newtype to bring the implicit values into scope:
@@ -219,7 +219,7 @@ For details refer to [derevo documentation](https://github.com/tofu-tf/derevo#in
219219
To use, add the following dependency:
220220

221221
```scala
222-
"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "1.13.6"
222+
"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "1.13.7"
223223
```
224224

225225
Then you can derive schema for your ADT along with other typeclasses besides ADT declaration itself:

generated-doc/out/endpoint/json.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ stringJsonBody.schema(implicitly[Schema[MyBody]].as[String])
5050
To use [Circe](https://github.com/circe/circe), add the following dependency to your project:
5151

5252
```scala
53-
"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "1.13.6"
53+
"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "1.13.7"
5454
```
5555

5656
Next, import the package (or extend the `TapirJsonCirce` trait, see [MyTapir](../other/mytapir.md)):
@@ -122,7 +122,7 @@ Now the above JSON object will render as
122122
To use [µPickle](http://www.lihaoyi.com/upickle/) add the following dependency to your project:
123123

124124
```scala
125-
"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "1.13.6"
125+
"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "1.13.7"
126126
```
127127

128128
Next, import the package (or extend the `TapirJsonuPickle` trait, see [MyTapir](../other/mytapir.md) and add `TapirJsonuPickle` not `TapirCirceJson`):
@@ -156,13 +156,13 @@ For more examples, including making a custom encoder/decoder, see [TapirJsonuPic
156156
To use [Play JSON](https://github.com/playframework/play-json) for **Play 3.0**, add the following dependency to your project:
157157

158158
```scala
159-
"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.13.6"
159+
"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.13.7"
160160
```
161161

162162
For **Play 2.9** use:
163163

164164
```scala
165-
"com.softwaremill.sttp.tapir" %% "tapir-json-play29" % "1.13.6"
165+
"com.softwaremill.sttp.tapir" %% "tapir-json-play29" % "1.13.7"
166166
```
167167

168168
Next, import the package (or extend the `TapirJsonPlay` trait, see [MyTapir](../other/mytapir.md) and add `TapirJsonPlay` not `TapirCirceJson`):
@@ -178,7 +178,7 @@ Play JSON requires `Reads` and `Writes` implicit values in scope for each type y
178178
To use [Spray JSON](https://github.com/spray/spray-json) add the following dependency to your project:
179179

180180
```scala
181-
"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "1.13.6"
181+
"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "1.13.7"
182182
```
183183

184184
Next, import the package (or extend the `TapirJsonSpray` trait, see [MyTapir](../other/mytapir.md) and add `TapirJsonSpray` not `TapirCirceJson`):
@@ -194,7 +194,7 @@ Spray JSON requires a `JsonFormat` implicit value in scope for each type you wan
194194
To use [Tethys JSON](https://github.com/tethys-json/tethys) add the following dependency to your project:
195195

196196
```scala
197-
"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "1.13.6"
197+
"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "1.13.7"
198198
```
199199

200200
Next, import the package (or extend the `TapirJsonTethys` trait, see [MyTapir](../other/mytapir.md) and add `TapirJsonTethys` not `TapirCirceJson`):
@@ -210,7 +210,7 @@ Tethys JSON requires `JsonReader` and `JsonWriter` implicit values in scope for
210210
To use [Jsoniter-scala](https://github.com/plokhotnyuk/jsoniter-scala) add the following dependency to your project:
211211

212212
```scala
213-
"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "1.13.6"
213+
"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "1.13.7"
214214
```
215215

216216
Next, import the package (or extend the `TapirJsonJsoniter` trait, see [MyTapir](../other/mytapir.md) and add `TapirJsonJsoniter` not `TapirCirceJson`):
@@ -226,7 +226,7 @@ Jsoniter Scala requires `JsonValueCodec` implicit value in scope for each type y
226226
To use [json4s](https://github.com/json4s/json4s) add the following dependencies to your project:
227227

228228
```scala
229-
"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "1.13.6"
229+
"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "1.13.7"
230230
```
231231

232232
And one of the implementations:
@@ -257,7 +257,7 @@ given Formats = org.json4s.jackson.Serialization.formats(NoTypeHints)
257257
To use [zio-json](https://github.com/zio/zio-json), add the following dependency to your project:
258258

259259
```scala
260-
"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "1.13.6"
260+
"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "1.13.7"
261261
```
262262
Next, import the package (or extend the `TapirJsonZio` trait, see [MyTapir](../other/mytapir.md) and add `TapirJsonZio` instead of `TapirCirceJson`):
263263

0 commit comments

Comments
 (0)