Skip to content

Commit

Permalink
Release 1.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
adamw committed Aug 8, 2022
1 parent 9082999 commit f30efb0
Show file tree
Hide file tree
Showing 24 changed files with 66 additions and 61 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ tapir documentation is available at [tapir.softwaremill.com](http://tapir.softwa
Add the following dependency:

```sbt
"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.0.4"
```

Then, import:
Expand Down
4 changes: 2 additions & 2 deletions doc/docs/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ these steps can be done separately, giving you complete control over the process
To generate OpenAPI documentation and expose it using the Swagger UI in a single step, first add the dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.0.4"
```

And the server endpoints can be generated using the `sttp.tapir.redoc.bundle.RedocInterpreter` class.
Expand Down
2 changes: 1 addition & 1 deletion generated-doc/out/client/http4s.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Add the dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "1.0.4"
```

To interpret an endpoint definition as an `org.http4s.Request[F]`, import:
Expand Down
2 changes: 1 addition & 1 deletion generated-doc/out/client/play.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Add the dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.0.4"
```

To make requests using an endpoint definition using the [play client](https://github.com/playframework/play-ws), import:
Expand Down
4 changes: 2 additions & 2 deletions generated-doc/out/client/sttp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Add the dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "1.0.3"
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "1.0.4"
"io.github.cquiroz" %%% "scala-java-time" % "2.2.0" // implementations of java.time classes for Scala.JS
```

Expand Down
2 changes: 1 addition & 1 deletion generated-doc/out/docs/asyncapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use, add the following dependencies:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "1.0.4"
"com.softwaremill.sttp.apispec" %% "asyncapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
```

Expand Down
10 changes: 5 additions & 5 deletions generated-doc/out/docs/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ these steps can be done separately, giving you complete control over the process
To generate OpenAPI documentation and expose it using the Swagger UI in a single step, first add the dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.0.4"
"com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
```

Expand Down Expand Up @@ -136,12 +136,12 @@ The modules `tapir-swagger-ui` and `tapir-redoc` contain server endpoint definit
yaml format, will expose it using the given context path. To use, add as a dependency either
`tapir-swagger-ui`:
```scala
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "1.0.4"
```

or `tapir-redoc`:
```scala
"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.0.4"
```

Then, you'll need to pass the server endpoints to your server interpreter. For example, using akka-http:
Expand Down
10 changes: 5 additions & 5 deletions generated-doc/out/endpoint/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `tapir-cats` module contains additional instances for some [cats](https://ty
datatypes as well as additional syntax:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-cats" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-cats" % "1.0.4"
```

- `import sttp.tapir.integ.cats.codec._` - brings schema, validator and codec instances
Expand All @@ -26,7 +26,7 @@ If you use [refined](https://github.com/fthomas/refined), the `tapir-refined` mo
validators for `T Refined P` as long as a codec for `T` already exists:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-refined" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-refined" % "1.0.4"
```

You'll need to extend the `sttp.tapir.codec.refined.TapirCodecRefined`
Expand All @@ -47,7 +47,7 @@ The `tapir-enumeratum` module provides schemas, validators and codecs for [Enume
enumerations. To use, add the following dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "1.0.4"
```

Then, `import sttp.tapir.codec.newtype._`, or extend the `sttp.tapir.codec.enumeratum.TapirCodecNewType` trait to bring the implicit values into scope.
Expand All @@ -99,7 +99,7 @@ For details refer to [derevo documentation](https://github.com/tofu-tf/derevo#in
To use, add the following dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "1.0.4"
```

Then you can derive schema for your ADT along with other typeclasses besides ADT declaration itself:
Expand Down
16 changes: 8 additions & 8 deletions generated-doc/out/endpoint/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ the json codec that is in scope.
To use [Circe](https://github.com/circe/circe), add the following dependency to your project:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "1.0.4"
```

Next, import the package (or extend the `TapirJsonuPickle` trait, see [MyTapir](../mytapir.md) and add `TapirJsonuPickle` not `TapirCirceJson`):
Expand Down Expand Up @@ -138,7 +138,7 @@ For more examples, including making a custom encoder/decoder, see [TapirJsonuPic
To use [Play JSON](https://github.com/playframework/play-json) add the following dependency to your project:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "1.0.4"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "1.0.4"
```

And one of the implementations:
Expand Down Expand Up @@ -233,7 +233,7 @@ implicit val formats: Formats = org.json4s.jackson.Serialization.formats(NoTypeH
To use [zio-json](https://github.com/zio/zio-json), add the following dependency to your project:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "1.0.4"
```
Next, import the package (or extend the `TapirJsonZio` trait, see [MyTapir](../mytapir.md) and add `TapirJsonZio` instead of `TapirCirceJson`):

Expand Down
2 changes: 1 addition & 1 deletion generated-doc/out/generator/sbt-openapi-codegen.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Add the sbt plugin to the `project/plugins.sbt`:

```scala
addSbtPlugin("com.softwaremill.sttp.tapir" % "sbt-openapi-codegen" % "1.0.3")
addSbtPlugin("com.softwaremill.sttp.tapir" % "sbt-openapi-codegen" % "1.0.4")
```

Enable the plugin for your project in the `build.sbt`:
Expand Down
2 changes: 1 addition & 1 deletion generated-doc/out/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To use tapir, add the following dependency to your project:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.0.4"
```

This will import only the core classes needed to create endpoint descriptions. To generate a server or a client, you
Expand Down
4 changes: 2 additions & 2 deletions generated-doc/out/server/akkahttp.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ To expose an endpoint as an [akka-http](https://doc.akka.io/docs/akka-http/curre
dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "1.0.4"
```

This will transitively pull some Akka modules in version 2.6. If you want to force
your own Akka version (for example 2.5), use sbt exclusion. Mind the Scala version in artifact name:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "1.0.3" exclude("com.typesafe.akka", "akka-stream_2.12")
"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "1.0.4" exclude("com.typesafe.akka", "akka-stream_2.12")
```

Now import the object:
Expand Down
8 changes: 4 additions & 4 deletions generated-doc/out/server/armeria.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Armeria interpreter can be used with different effect systems (cats-effect, ZIO)

Add the following dependency
```scala
"com.softwaremill.sttp.tapir" %% "tapir-armeria-server" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-armeria-server" % "1.0.4"
```

and import the object:
Expand Down Expand Up @@ -75,7 +75,7 @@ Note that Armeria automatically injects an `ExecutionContext` on top of Armeria'

Add the following dependency
```scala
"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-cats" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-cats" % "1.0.4"
```
to use this interpreter with Cats Effect typeclasses.

Expand Down Expand Up @@ -155,9 +155,9 @@ Add the following dependency

```scala
// for zio 2:
"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-zio" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-zio" % "1.0.4"
// for zio 1:
"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-zio1" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-zio1" % "1.0.4"
```

to use this interpreter with ZIO.
Expand Down
6 changes: 3 additions & 3 deletions generated-doc/out/server/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To implement the Lambda function, a server interpreter is available, which takes
Currently, only an interpreter integrating with cats-effect is available (`AwsCatsEffectServerInterpreter`). To use, add the following dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-aws-lambda" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-aws-lambda" % "1.0.4"
```

To configure API Gateway and the Lambda function, you can use:
Expand All @@ -24,8 +24,8 @@ To configure API Gateway and the Lambda function, you can use:
Add one of the following dependencies:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-aws-sam" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-aws-terraform" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-aws-sam" % "1.0.4"
"com.softwaremill.sttp.tapir" %% "tapir-aws-terraform" % "1.0.4"
```

## Examples
Expand Down
4 changes: 2 additions & 2 deletions generated-doc/out/server/finatra.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To expose an endpoint as an [finatra](https://twitter.github.io/finatra/) server
dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-finatra-server" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-finatra-server" % "1.0.4"
```

and import the object:
Expand All @@ -17,7 +17,7 @@ This interpreter supports the twitter `Future`.
Or, if you would like to use cats-effect project, you can add the following dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-finatra-server-cats" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-finatra-server-cats" % "1.0.4"
```

and import the object:
Expand Down
2 changes: 1 addition & 1 deletion generated-doc/out/server/http4s.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To expose an endpoint as an [http4s](https://http4s.org) server, first add the f
dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-http4s-server" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-http4s-server" % "1.0.4"
```

and import the object:
Expand Down
7 changes: 6 additions & 1 deletion generated-doc/out/server/logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ There are also other variants of the methods that can be used to provide the ser
* `serverLogicPure(f: I => Either[E, O])`: if the server logic function is pure, that is returns a strict value, not
a description of side-effects
* `serverLogicOption(f: I => F[Option[O]])`: if the error type is a `Unit`, a `None` results is treated as an error
* `serverLogicRightErrorOrSuccess(f: I => F[Either[RE, O]])`: if the error type is an `Either`, e.g. when using
`errorOutEither`, this method accepts server logic that returns either success or the `Right` error type. Use of this
method avoids having to wrap the returned error in `Right`.
* `serverLogicLeftErrorOrSuccess(f: I => F[Either[LE, O]])`: similarly, this accepts server logic which returns the `Left`
error type or success

Similar variants are available to provide the security logic.

Expand Down Expand Up @@ -204,4 +209,4 @@ val secureFileEndpoints = filesServerEndpoints[Future]("secure")("/home/data")
.map(_.prependSecurity(auth.bearer[String](), statusCode(StatusCode.Forbidden)) { token =>
Future.successful(if (token.startsWith("secret")) Right(()) else Left(()))
})
```
```
4 changes: 2 additions & 2 deletions generated-doc/out/server/netty.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
To expose an endpoint using a [Netty](https://netty.io)-based server, first add the following dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-netty-server" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-netty-server" % "1.0.4"
```

Then, use:
Expand Down Expand Up @@ -75,5 +75,5 @@ can be passed using the `NettyFutureServer(options)` methods. Options may also b
Add the following dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-netty-server-cats" % "1.0.3"
"com.softwaremill.sttp.tapir" %% "tapir-netty-server-cats" % "1.0.4"
```
Loading

0 comments on commit f30efb0

Please sign in to comment.