Skip to content

Commit

Permalink
Release 0.20.0-M10
Browse files Browse the repository at this point in the history
  • Loading branch information
adamw committed Feb 18, 2022
1 parent 81d9f3b commit 6b5d195
Show file tree
Hide file tree
Showing 26 changed files with 271 additions and 54 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ tapir documentation is available at [tapir.softwaremill.com](http://tapir.softwa
Add the following dependency:

```sbt
"com.softwaremill.sttp.tapir" %% "tapir-core" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-core" % "0.20.0-M10"
```

Partial unification is now enabled by default from Scala 2.13. However, if you're using Scala 2.12 or older, then
Expand Down
4 changes: 2 additions & 2 deletions doc/docs/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "0.20.0-M10"
```

Then, you can interpret a list of endpoints, as server endpoints exposing the Swagger UI, using `SwaggerInterpreter`.
Expand Down Expand Up @@ -46,7 +46,7 @@ for details.
Similarly as above, you'll need the following dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "0.20.0-M10"
```

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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "0.20.0-M10"
```

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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "0.20.0-M10"
```

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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "0.20.0-M10"
```

To make requests using an endpoint definition using the [sttp client](https://github.com/softwaremill/sttp), import:
Expand Down Expand Up @@ -82,7 +82,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "0.20.0-M10"
"io.github.cquiroz" %%% "scala-java-time" % "2.2.0" // implementations of java.time classes for Scala.JS
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-circe-yaml" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "0.20.0-M10"
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-circe-yaml" % "0.20.0-M10"
```

Tapir contains a case class-based model of the asyncapi data structures in the `asyncapi/asyncapi-model` subproject (the
Expand Down
12 changes: 6 additions & 6 deletions generated-doc/out/docs/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "0.20.0-M10"
```

Then, you can interpret a list of endpoints, as server endpoints exposing the Swagger UI, using `SwaggerInterpreter`.
Expand Down Expand Up @@ -46,7 +46,7 @@ for details.
Similarly as above, you'll need the following dependency:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "0.20.0-M10"
```

And the server endpoints can be generated using the `sttp.tapir.redoc.bundle.RedocInterpreter` class.
Expand All @@ -56,8 +56,8 @@ 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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-openapi-circe-yaml" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "0.20.0-M10"
"com.softwaremill.sttp.tapir" %% "tapir-openapi-circe-yaml" % "0.20.0-M10"
```

Tapir contains a case class-based model of the openapi data structures in the `openapi/openapi-model` subproject (the
Expand Down Expand Up @@ -193,12 +193,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "0.20.0-M10"
```

or `tapir-redoc`:
```scala
"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "0.20.0-M10"
```

Then, you'll need to pass the server endpoints to your server interpreter. For example, using akka-http:
Expand Down
1 change: 1 addition & 0 deletions generated-doc/out/endpoint/customtypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ In some cases, codecs can be automatically derived:

* for supported [json](json.md) libraries
* for urlencoded and multipart [forms](forms.md)
* for value classes (extending `AnyVal`)

Automatic codec derivation usually requires other implicits, such as:

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 @@ -6,7 +6,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-cats" % "0.20.0-M10"
```

- `import sttp.tapir.integ.cats.codec._` - brings schema, validator and codec instances
Expand All @@ -18,7 +18,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-refined" % "0.20.0-M10"
```

You'll need to extend the `sttp.tapir.codec.refined.TapirCodecRefined`
Expand All @@ -39,7 +39,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "0.20.0-M10"
```

Then, `import sttp.tapir.codec.enumeratum`, or extends the `sttp.tapir.codec.enumeratum.TapirCodecEnumeratum` trait.
Expand Down Expand Up @@ -77,7 +77,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "0.20.0-M10"
```

Then, `import sttp.tapir.codec.newtype._`, or extend the `sttp.tapir.codec.enumeratum.TapirCodecNewType` trait to bring the implicit values into scope.
Expand All @@ -89,7 +89,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "0.20.0-M10"
```

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 @@ -17,7 +17,7 @@ the json codec that is in scope.
To use Circe, add the following dependency to your project:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "0.20.0-M10"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "0.20.0-M10"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "0.20.0-M10"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "0.20.0-M10"
```

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

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "0.20.0-M10"
```

Next, import the package (or extend the `TapirJsonTethys` trait, see [MyTapir](../mytapir.md) and add `TapirJsonTethys` not `TapirCirceJson`):
Expand All @@ -174,7 +174,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "0.20.0-M10"
```

Next, import the package (or extend the `TapirJsonJsoniter` trait, see [MyTapir](../mytapir.md) and add `TapirJsonJsoniter` not `TapirCirceJson`):
Expand All @@ -191,7 +191,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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "0.20.0-M10"
```

And one of the implementations:
Expand Down Expand Up @@ -222,7 +222,7 @@ implicit val formats: Formats = org.json4s.jackson.Serialization.formats(NoTypeH
To use Zio JSON, add the following dependency to your project:

```scala
"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "0.20.0-M10"
```
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" % "0.20.0-M9")
addSbtPlugin("com.softwaremill.sttp.tapir" % "sbt-openapi-codegen" % "0.20.0-M10")
```

Enable the plugin for your project in the `build.sbt`:
Expand Down
2 changes: 2 additions & 0 deletions generated-doc/out/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ input and output parameters. An endpoint specification can be interpreted as:
* [Finatra](server/finatra.md) `http.Controller`
* [Play](server/play.md) `Route`
* [ZIO Http](server/ziohttp.md) `Http`
* [Armeria](server/armeria.md) `HttpServiceWithRoutes`
* [aws](server/aws.md) through Lambda/SAM/Terraform
* a client, which is a function from input parameters to output parameters.
Currently supported:
Expand Down Expand Up @@ -149,6 +150,7 @@ Development and maintenance of sttp tapir is sponsored by [SoftwareMill](https:/
server/play
server/vertx
server/ziohttp
server/armeria
server/aws
server/options
server/interceptors
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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-core" % "0.20.0-M10"
```

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" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "0.20.0-M10"
```

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" % "0.20.0-M9" exclude("com.typesafe.akka", "akka-stream_2.12")
"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "0.20.0-M10" exclude("com.typesafe.akka", "akka-stream_2.12")
```

Now import the object:
Expand Down
Loading

0 comments on commit 6b5d195

Please sign in to comment.