Skip to content

Commit

Permalink
Release 0.20.0-M9
Browse files Browse the repository at this point in the history
  • Loading branch information
adamw committed Feb 3, 2022
1 parent 90fe9ff commit c15af76
Show file tree
Hide file tree
Showing 25 changed files with 89 additions and 59 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-core" % "0.20.0-M9"
```

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "0.20.0-M9"
```

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "0.20.0-M9"
```

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

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

To make requests using an endpoint definition using the [play client](https://github.com/playframework/play-ws), import:
Expand Down
16 changes: 9 additions & 7 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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "0.20.0-M9"
```

To make requests using an endpoint definition using the [sttp client](https://github.com/softwaremill/sttp), import:
Expand Down Expand Up @@ -66,21 +66,23 @@ convert sttp's `WebSocket` instance into a pipe. This logic is looked up via the
The required imports are as follows:

```scala
import sttp.tapir.client.sttp.ws.akkahttp._ // for akka-streams // for akka-streams
import sttp.tapir.client.sttp.ws.fs2._ // for fs2 // for fs2
import sttp.tapir.client.sttp.ws.zio._ // for zio
import sttp.tapir.client.sttp.ws.akkahttp._ // for akka-streams
import sttp.tapir.client.sttp.ws.fs2._ // for fs2
import sttp.tapir.client.sttp.ws.zio._ // for zio 2.x
import sttp.tapir.client.sttp.ws.zio1._ // for zio 1.x
```

No additional dependencies are needed, as both of the above implementations are included in the main interpreter,
with dependencies on akka-streams, fs2 and zio being marked as optional (hence these are not transitive).
No additional dependencies are needed (except for zio1, which needs the `tapir-sttp-client-ws-zio1` dependency), as
both of the above implementations are included in the main interpreter, with dependencies on akka-streams, fs2 and zio
being marked as optional (hence these are not transitive).

## Scala.JS

In this case add the following dependencies (note the [`%%%`](https://www.scala-js.org/doc/project/dependencies.html)
instead of the usual `%%`):

```scala
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "0.20.0-M8"
"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "0.20.0-M9"
"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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-circe-yaml" % "0.20.0-M8"
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-circe-yaml" % "0.20.0-M9"
```

Tapir contains a case class-based model of the asyncapi data structures in the `asyncapi/asyncapi-model` subproject (the
Expand Down
15 changes: 9 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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "0.20.0-M9"
```

Then, you can interpret a list of endpoints, as server endpoints exposing the Swagger UI, using `SwaggerInterpreter`.
Expand Down Expand Up @@ -38,12 +38,15 @@ Moreover, model generation can be configured - see below for more details on `Op
parameters of `fromEndpoitns`. Finally, the generated model can be customised. See the scaladocs for
`SwaggerInterpreter`.

The swagger server endpoints can be secured using `ServerLogic.prependSecurity`, see [server logic](../server/logic.md)
for details.

### Using Redoc

Similarly as above, you'll need the following dependency:

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

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

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

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

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

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

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

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

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

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "0.20.0-M9"
```

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "0.20.0-M9"
```

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

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "0.20.0-M9"
```

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "0.20.0-M9"
```

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "0.20.0-M9"
```

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "0.20.0-M9"
```

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-M8"
"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "0.20.0-M9"
```
Next, import the package (or extend the `TapirJsonZio` trait, see [MyTapir](../mytapir.md) and add `TapirJsonZio` instead of `TapirCirceJson`):

Expand Down
3 changes: 3 additions & 0 deletions generated-doc/out/endpoint/static.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ Using the above endpoint, a request to `/site/static/css/styles.css` will try to

A single file can be exposed using `fileGetServerEndpoint`.

The file server endpoints can be secured using `ServerLogic.prependSecurity`, see [server logic](../server/logic.md)
for details.

## Resources

Similarly, the `resourcesGetServerEndpoint` can be used to expose the application's resources at the given prefix.
Expand Down
2 changes: 1 addition & 1 deletion generated-doc/out/examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples

The [`examples`](https://github.com/softwaremill/tapir/tree/master/examples/src/main/scala/sttp/tapir/examples) sub-project contains a number of runnable tapir usage examples, using various interpreters and showcasing different features.
The [`examples`](https://github.com/softwaremill/tapir/tree/master/examples/src/main/scala/sttp/tapir/examples) and [`examples3`](https://github.com/softwaremill/tapir/tree/master/examples/src/main/scala/sttp/tapir/examples3) sub-projects (the latter containing Scala 3-only code) contains a number of runnable tapir usage examples, using various interpreters and showcasing different features.

## Other examples

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

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

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

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

Now import the object:
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" % "0.20.0-M8"
"com.softwaremill.sttp.tapir" %% "tapir-aws-lambda" % "0.20.0-M9"
```

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" % "0.20.0-M8"
"com.softwaremill.sttp.tapir" %% "tapir-aws-terraform" % "0.20.0-M8"
"com.softwaremill.sttp.tapir" %% "tapir-aws-sam" % "0.20.0-M9"
"com.softwaremill.sttp.tapir" %% "tapir-aws-terraform" % "0.20.0-M9"
```

## 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" % "0.20.0-M8"
"com.softwaremill.sttp.tapir" %% "tapir-finatra-server" % "0.20.0-M9"
```

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" % "0.20.0-M8"
"com.softwaremill.sttp.tapir" %% "tapir-finatra-server-cats" % "0.20.0-M9"
```

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

and import the object:
Expand Down
Loading

0 comments on commit c15af76

Please sign in to comment.