Upgrade to OpenAPI 3.1.0

apispec/openapi-circe/src/test/resources/expected_webhooks.json

@@ -0,0 +1,31 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Fruits",
+    "version": "1.0"
+  },
+  "paths": {
+    "/": {
+      "get": {
+        "operationId": "getRoot",
+        "responses": {
+          "200": {
+            "description": "Default description"
+          }
+        }
+      }
+    }
+  },
+  "webhooks": {
+    "newPet": {
+      "get": {
+        "operationId": "getRoot",
+        "responses": {
+          "200": {
+            "description": "Default description"
+          }
+        }
+      }
+    }
+  }
+}

apispec/openapi-circe/src/test/resources/expected_with_schema_dialect.json

@@ -0,0 +1,20 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Fruits",
+    "version": "1.0"
+  },
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "paths": {
+    "/": {
+      "get": {
+        "operationId": "getRoot",
+        "responses": {
+          "200": {
+            "description": "Default description"
+          }
+        }
+      }
+    }
+  }
+}

apispec/openapi-circe/src/test/scala/sttp/tapir/openapi/circe/TapirOpenAPICirceTest.scala

@@ -0,0 +1,65 @@
+package sttp.tapir.openapi.circe
+
+import io.circe.Printer
+import io.circe.syntax.EncoderOps
+import sttp.tapir.apispec.ReferenceOr
+import sttp.tapir.openapi._
+import org.scalatest.funsuite.AnyFunSuite
+import org.scalatest.matchers.should.Matchers
+
+import scala.collection.immutable.ListMap
+import scala.io.Source
+
+class TapirOpenAPICirceTest extends AnyFunSuite with Matchers {
+
+  test("should match the expected yaml with schema dialect") {
+    val expectedJson = load("expected_with_schema_dialect.json")
+    val responsesList = ListMap[ResponsesKey, ReferenceOr[Response]](ResponsesCodeKey(200) -> Right(Response(description = "Default description")))
+    val responses = Responses(responsesList)
+    val operation = Operation(operationId = "getRoot", responses = responses)
+    val pathItem = PathItem(get = Some(operation))
+
+    val actualJson = OpenAPI(
+      info = Info("Fruits", "1.0"),
+      jsonSchemaDialect = Some("https://json-schema.org/draft/2020-12/schema"),
+      tags = List.empty,
+      servers = List.empty,
+      paths = Paths(ListMap[String, PathItem]("/" -> pathItem)),
+      webhooks = None,
+      components = None,
+      security = List.empty)
+      .asJson
+    val actualJsonNoIndent = noIndentation(Printer.spaces2.print(actualJson))
+
+    actualJsonNoIndent shouldBe expectedJson
+  }
+
+  test("should match the expected yaml with webhooks") {
+    val expectedJson = load("expected_webhooks.json")
+    val responsesList = ListMap[ResponsesKey, ReferenceOr[Response]](ResponsesCodeKey(200) -> Right(Response(description = "Default description")))
+    val responses = Responses(responsesList)
+    val operation = Operation(operationId = "getRoot", responses = responses)
+    val eitherPathItem = Right(PathItem(get = Some(operation)))
+    val pathItem = PathItem(get = Some(operation))
+
+    val actualJson= OpenAPI(
+      info = Info("Fruits", "1.0"),
+      jsonSchemaDialect = None,
+      tags = List.empty,
+      servers = List.empty,
+      paths = Paths(ListMap[String, PathItem]("/" -> pathItem)),
+      webhooks = Some(Map("newPet" -> eitherPathItem)),
+      components = None,
+      security = List.empty)
+      .asJson
+    val actualJsonNoIndent = noIndentation(Printer.spaces2.print(actualJson))
+
+    actualJsonNoIndent shouldBe expectedJson
+  }
+
+  private def load(fileName: String): String = {
+    noIndentation(Source.fromInputStream(getClass.getResourceAsStream(s"/$fileName")).getLines().mkString("\n"))
+  }
+  private def noIndentation(s: String): String = s.replaceAll("[ \t]", "").trim
+
+}

apispec/openapi-model/src/main/scala/sttp/tapir/openapi/OpenAPI.scala

@@ -5,11 +5,13 @@ import sttp.tapir.apispec.{ExampleValue, ExtensionValue, ReferenceOr, Schema, Se
 import scala.collection.immutable.ListMap
 
 case class OpenAPI(
-    openapi: String = "3.0.3",
+    openapi: String = "3.1.0",
     info: Info,
+    jsonSchemaDialect: Option[String],
     tags: List[Tag],
     servers: List[Server],
     paths: Paths,
+    webhooks: Option[Map[String, ReferenceOr[PathItem]]],
     components: Option[Components],
     security: List[SecurityRequirement],
     extensions: ListMap[String, ExtensionValue] = ListMap.empty
@@ -27,6 +29,10 @@ case class OpenAPI(
   def servers(s: List[Server]): OpenAPI = copy(servers = s)
 
   def tags(t: List[Tag]): OpenAPI = copy(tags = t)
+
+  def jsonSchemaDialect(d: Option[String]): OpenAPI = copy(jsonSchemaDialect = d)
+
+  def webhooks(wh: Option[Map[String, ReferenceOr[PathItem]]]): OpenAPI = copy(webhooks = wh)
 }
 
 case class Info(
@@ -74,7 +80,8 @@ case class ServerVariable(
 case class Components(
     schemas: ListMap[String, ReferenceOr[Schema]],
     securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]],
-    extensions: ListMap[String, ExtensionValue] = ListMap.empty
+    extensions: ListMap[String, ExtensionValue] = ListMap.empty,
+    pathItems: ListMap[String, ReferenceOr[PathItem]] = ListMap.empty
 )
 
 case class Paths(

build.sbt

@@ -562,7 +562,8 @@ lazy val openapiCirce: ProjectMatrix = (projectMatrix in file("apispec/openapi-c
     libraryDependencies ++= Seq(
       "io.circe" %% "circe-core" % Versions.circe,
       "io.circe" %% "circe-parser" % Versions.circe,
-      "io.circe" %% "circe-generic" % Versions.circe
+      "io.circe" %% "circe-generic" % Versions.circe,
+      scalaTest.value % Test
     ),
     name := "tapir-openapi-circe"
   )

docs/openapi-docs/src/main/scala/sttp/tapir/docs/openapi/EndpointToOpenAPIDocs.scala

@@ -37,7 +37,9 @@ private[openapi] object EndpointToOpenAPIDocs {
       paths = Paths(ListMap.empty),
       components = componentsCreator.components,
       security = List.empty,
-      extensions = DocsExtensions.fromIterable(docsExtensions)
+      extensions = DocsExtensions.fromIterable(docsExtensions),
+      jsonSchemaDialect = Option.empty,
+      webhooks = Option.empty
     )
   }
 }

docs/openapi-docs/src/test/resources/coproduct/expected_coproduct.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_discriminator.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_discriminator_nested.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_discriminator_with_enum_circe.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: My Bookshop
   version: '1.0'

docs/openapi-docs/src/test/resources/coproduct/expected_coproduct_nested.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/coproduct/expected_generic_coproduct.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/coproduct/expected_recursive_coproducts.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/coproduct/expected_unfolded_coproduct_unfolded_array.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/decode_failure_output/expected_default_400_response.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/decode_failure_output/expected_no_400_response.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/decode_failure_output/expected_response_defined_in_options.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/decode_failure_output/expected_user_defined_response.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/enum/expected_enumeratum_enum_component.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Countries
   version: '1.0'

docs/openapi-docs/src/test/resources/enum/expected_enumeratum_int_enum_component.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Errors
   version: '1.0'

docs/openapi-docs/src/test/resources/enum/expected_trait_enum_component.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Games
   version: '1.0'

docs/openapi-docs/src/test/resources/example/expected_examples_of_list_and_not_list_types.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/example/expected_fixed_header_example.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Examples
   version: '1.0'

docs/openapi-docs/src/test/resources/example/expected_multiple_examples.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/example/expected_multiple_examples_with_default_names.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/example/expected_multiple_examples_with_explicit_and_default_names.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/example/expected_multiple_examples_with_names.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/example/expected_schema_example.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Examples
   version: '1.0'

docs/openapi-docs/src/test/resources/example/expected_single_example_with_name.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/expected.json

@@ -1,5 +1,5 @@
 {
-  "openapi" : "3.0.3",
+  "openapi" : "3.1.0",
   "info" : {
     "title" : "Fruits",
     "version" : "1.0"

docs/openapi-docs/src/test/resources/expected.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_additional_properties.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_arbitrary_json_output.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_array_no_format.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_custom_operation_id.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_custom_schema_name.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_date_time.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Examples
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_default_query_param.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_deprecated.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Entities
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_descriptions_in_nested_custom_schemas.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'

docs/openapi-docs/src/test/resources/expected_double_quoted.yml

@@ -1,4 +1,4 @@
-openapi: "3.0.3"
+openapi: "3.1.0"
 info:
   title: "String style"
   version: "1.0"

docs/openapi-docs/src/test/resources/expected_empty.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Fruits
   version: '1.0'