Add comments / simplify tests

softwaremill · Jul 6, 2023 · 095ebdf · 095ebdf
1 parent 398c15a
commit 095ebdf
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 10 deletions.
diff --git a/asyncapi-circe/src/main/scala/sttp/apispec/asyncapi/circe/package.scala b/asyncapi-circe/src/main/scala/sttp/apispec/asyncapi/circe/package.scala
@@ -19,6 +19,7 @@ package circe {
     override val openApi30: Boolean = true
 
     implicit val encoderOAuthFlow: Encoder[OAuthFlow] = {
+      // #79: all OAuth flow object MUST include a scopes field, but it MAY be empty.
       import scala.collection.immutable.ListMap
       implicit def encodeListMap: Encoder[ListMap[String, String]] = doEncodeListMap(nullWhenEmpty = false)
 

diff --git a/...circe/src/main/scala/sttp/apispec/openapi/internal/InternalSttpOpenAPICirceDecoders.scala b/...circe/src/main/scala/sttp/apispec/openapi/internal/InternalSttpOpenAPICirceDecoders.scala
@@ -18,6 +18,7 @@ trait InternalSttpOpenAPICirceDecoders extends JsonSchemaCirceDecoders {
   implicit val tagDecoder: Decoder[Tag] = withExtensions(deriveDecoder[Tag])
 
   implicit val oauthFlowDecoder: Decoder[OAuthFlow] = {
+    // #79: all OAuth flow object MUST include a scopes field, but it MAY be empty.
     implicit def listMapDecoder: Decoder[ListMap[String, String]] =
       Decoder.decodeOption(Decoder.decodeMapLike[String, String, ListMap]).map(_.getOrElse(ListMap.empty))
 

diff --git a/...circe/src/main/scala/sttp/apispec/openapi/internal/InternalSttpOpenAPICirceEncoders.scala b/...circe/src/main/scala/sttp/apispec/openapi/internal/InternalSttpOpenAPICirceEncoders.scala
@@ -11,6 +11,7 @@ import scala.collection.immutable.ListMap
 
 trait InternalSttpOpenAPICirceEncoders extends JsonSchemaCirceEncoders {
   implicit val encoderOAuthFlow: Encoder[OAuthFlow] = {
+    // #79: all OAuth flow object MUST include a scopes field, but it MAY be empty.
     implicit def encodeListMap: Encoder[ListMap[String, String]] = doEncodeListMap(nullWhenEmpty = false)
 
     deriveEncoder[OAuthFlow].mapJsonObject(expandExtensions)

diff --git a/openapi-circe/src/test/scala/sttp/apispec/openapi/circe/DecoderTest.scala b/openapi-circe/src/test/scala/sttp/apispec/openapi/circe/DecoderTest.scala
@@ -9,8 +9,6 @@ import scala.collection.immutable.ListMap
 class DecoderTest extends AnyFunSuite with ResourcePlatform {
   override val basedir = "openapi-circe"
 
-  private val tokenUrl = basedir + "-token"
-
   test("petstore deserialize") {
     val Right(openapi) = readJson("/petstore/basic-petstore.json").flatMap(_.as[OpenAPI]): @unchecked
 
@@ -48,7 +46,7 @@ class DecoderTest extends AnyFunSuite with ResourcePlatform {
 
   test("decode security schema with not empty scopes") {
     val expectedScopes = Some(Some(ListMap("example" -> "description")))
-    val expectedToken = Some(Some(Some(tokenUrl)))
+    val expectedToken = Some(Some(Some("openapi-circe-token")))
 
     val Right(securityScheme) =
       readJson("/securitySchema/security-schema-with-scopes.json").flatMap(_.as[SecurityScheme]): @unchecked
@@ -59,7 +57,7 @@ class DecoderTest extends AnyFunSuite with ResourcePlatform {
 
   test("decode security schema with empty scopes") {
     val expectedScopes = Some(Some(ListMap.empty[String, String]))
-    val expectedToken = Some(Some(Some(tokenUrl)))
+    val expectedToken = Some(Some(Some("openapi-circe-token")))
 
     val Right(securityScheme) =
       readJson("/securitySchema/security-schema-with-empty-scopes.json").flatMap(_.as[SecurityScheme]): @unchecked

diff --git a/openapi-circe/src/test/scala/sttp/apispec/openapi/circe/EncoderTest.scala b/openapi-circe/src/test/scala/sttp/apispec/openapi/circe/EncoderTest.scala
@@ -12,10 +12,7 @@ import scala.collection.immutable.ListMap
 class EncoderTest extends AnyFunSuite with ResourcePlatform with SttpOpenAPICirceEncoders {
   override val basedir = "openapi-circe"
 
-  private val tokenUrl = basedir + "-token"
-
   val petstore: OpenAPI = OpenAPI(
-    openapi = "3.1.0",
     info = Info(
       title = "Sample Pet Store App",
       summary = Some("A pet store manager."),
@@ -114,7 +111,6 @@ class EncoderTest extends AnyFunSuite with ResourcePlatform with SttpOpenAPICirc
     )
 
     val openapi = OpenAPI(
-      openapi = "3.1.0",
       info = Info(title = "API", version = "1.0.0"),
       components = Some(components)
     )
@@ -143,7 +139,7 @@ class EncoderTest extends AnyFunSuite with ResourcePlatform with SttpOpenAPICirc
               Some(
                 OAuthFlow(
                   authorizationUrl = None,
-                  tokenUrl = Some(tokenUrl),
+                  tokenUrl = Some("openapi-circe-token"),
                   refreshUrl = None,
                   scopes = scopesRequirement
                 )
@@ -176,7 +172,7 @@ class EncoderTest extends AnyFunSuite with ResourcePlatform with SttpOpenAPICirc
               Some(
                 OAuthFlow(
                   authorizationUrl = None,
-                  tokenUrl = Some(tokenUrl),
+                  tokenUrl = Some("openapi-circe-token"),
                   refreshUrl = None,
                   scopes = scopesRequirement
                 )