Merge pull request #1342 from dvgica/fix-reqd-authorization-url

Make authorizationUrl optional
softwaremill · Jun 27, 2021 · 55b5776 · 55b5776
2 parents 109908f + 2f5da55
commit 55b5776
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/apispec/apispec-model/src/main/scala/sttp/tapir/apispec/SecurityScheme.scala b/apispec/apispec-model/src/main/scala/sttp/tapir/apispec/SecurityScheme.scala
@@ -23,7 +23,7 @@ case class OAuthFlows(
 )
 
 case class OAuthFlow(
-    authorizationUrl: String,
+    authorizationUrl: Option[String],
     tokenUrl: Option[String],
     refreshUrl: Option[String],
     scopes: ListMap[String, String],

diff --git a/core/src/main/scala/sttp/tapir/EndpointIO.scala b/core/src/main/scala/sttp/tapir/EndpointIO.scala
@@ -206,7 +206,7 @@ object EndpointInput {
       override def securitySchemeName(name: String): Http[T] = copy(securitySchemeName = Some(name))
     }
     case class Oauth2[T](
-        authorizationUrl: String,
+        authorizationUrl: Option[String],
         tokenUrl: Option[String],
         scopes: ListMap[String, String],
         refreshUrl: Option[String],

diff --git a/core/src/main/scala/sttp/tapir/TapirAuth.scala b/core/src/main/scala/sttp/tapir/TapirAuth.scala
@@ -32,8 +32,8 @@ object TapirAuth {
 
   object oauth2 {
     def authorizationCode(
-        authorizationUrl: String,
-        scopes: ListMap[String, String],
+        authorizationUrl: Option[String] = None,
+        scopes: ListMap[String, String] = ListMap(),
         tokenUrl: Option[String] = None,
         refreshUrl: Option[String] = None,
         challenge: WWWAuthenticate = WWWAuthenticate.bearer()

diff --git a/docs/openapi-docs/src/test/scala/sttp/tapir/docs/openapi/VerifyYamlSecurityTest.scala b/docs/openapi-docs/src/test/scala/sttp/tapir/docs/openapi/VerifyYamlSecurityTest.scala
@@ -57,7 +57,7 @@ class VerifyYamlSecurityTest extends AnyFunSuite with Matchers {
     val oauth2 =
       auth.oauth2
         .authorizationCode(
-          "https://example.com/auth",
+          Some("https://example.com/auth"),
           ListMap("client" -> "scope for clients", "admin" -> "administration scope")
         )
 

diff --git a/examples/src/main/scala/sttp/tapir/examples/OAuth2GithubHttp4sServer.scala b/examples/src/main/scala/sttp/tapir/examples/OAuth2GithubHttp4sServer.scala
@@ -38,7 +38,7 @@ object OAuth2GithubHttp4sServer extends App {
 
   case class AccessDetails(token: String)
 
-  val authorizationUrl = "https://github.com/login/oauth/authorize"
+  val authorizationUrl = Some("https://github.com/login/oauth/authorize")
   val accessTokenUrl = Some("https://github.com/login/oauth/access_token")
 
   val authOAuth2 = auth.oauth2.authorizationCode(authorizationUrl, ListMap.empty, accessTokenUrl)