Merge pull request #525 from kchaitanya1195/default-tag-70

Remove default tags from global level
iheartradio · Mar 10, 2023 · de25a72 · de25a72
2 parents b947d9c + b58f7ac
commit de25a72
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 23 deletions.
diff --git a/build.sbt b/build.sbt
@@ -43,7 +43,9 @@ lazy val playSwagger = project.in(file("core"))
       Dependencies.yaml ++ Seq(
         "com.github.takezoe" %% "runtime-scaladoc-reader" % "1.0.3",
         "org.scalameta" %% "scalameta" % "4.7.5",
-        "net.steppschuh.markdowngenerator" % "markdowngenerator" % "1.3.1.1"
+        "net.steppschuh.markdowngenerator" % "markdowngenerator" % "1.3.1.1",
+        "joda-time" % "joda-time" % "2.10.6" % Test,
+        "com.google.errorprone" % "error_prone_annotations" % "2.17.0" % Test
       ),
     addCompilerPlugin("com.github.takezoe" %% "runtime-scaladoc-reader" % "1.0.3"),
     scalaVersion := scalaV,

diff --git a/core/src/main/scala/com/iheart/playSwagger/SwaggerSpecGenerator.scala b/core/src/main/scala/com/iheart/playSwagger/SwaggerSpecGenerator.scala
@@ -211,15 +211,7 @@ final case class SwaggerSpecGenerator(
 
     val definitionsJson = JsObject(definitions.map(d => d.name -> Json.toJson(d)))
 
-    // TODO: remove hardcoded path
-    val generatedTagsJson = JsArray(
-      paths.keys
-        // .filterNot(_ == RoutesFileReader.rootRoute)
-        .map(tag => Json.obj("name" -> tag)).toSeq
-    )
-
-    val tagsJson = mergeByName(generatedTagsJson, (baseJson \ "tags").asOpt[JsArray].getOrElse(JsArray()))
-
+    val tagsJson = (baseJson \ "tags").asOpt[JsArray].getOrElse(JsArray())
     val pathsAndDefinitionsJson = Json.obj(
       "paths" -> pathsJson,
       if (swaggerV3) {

diff --git a/core/src/test/scala/com/iheart/playSwagger/SwaggerSpecGeneratorSpec.scala b/core/src/test/scala/com/iheart/playSwagger/SwaggerSpecGeneratorSpec.scala
@@ -115,6 +115,10 @@ class SwaggerSpecGeneratorIntegrationSpec extends Specification {
       val json = defaultRoutesFile.get
       (json \ "paths" \ "/player/{pid}/context/{bid}").asOpt[JsObject] must beSome
     }
+    "Default routes tag must not be present" >> {
+      val json = defaultRoutesFile.get
+      (json \ "tags").asOpt[JsObject] must beNone
+    }
 
     lazy val json = SwaggerSpecGenerator(false, false, false, "com.iheart").generate("test.routes").get
     lazy val pathJson = json \ "paths"
@@ -329,11 +333,29 @@ class SwaggerSpecGeneratorIntegrationSpec extends Specification {
     "generate tags definition" >> {
       val tags = (json \ "tags").asOpt[Seq[JsObject]]
       tags must beSome[Seq[JsObject]]
-      tags.get.map(tO => (tO \ "name").as[String]).sorted must containAllOf(Seq(
+      tags.get.map(tO => (tO \ "name").as[String]).sorted must contain(exactly("player"))
+
+      val allTags =
+        pathJson.as[JsObject].value.values.flatMap { pathObj =>
+          pathObj.as[JsObject].value.values.flatMap { opObj =>
+            val tag = (opObj \ "tags").asOpt[Seq[String]]
+
+            tag must beSome[Seq[String]]
+            tag.get must have size 1
+            tag.get
+          }
+        }.toSet
+
+      allTags must containAllOf(Seq(
+        "test",
+        "students",
+        "player",
+        "resource",
+        "level2",
         "customResource",
         "liveMeta",
-        "player",
-        "resource"
+        "referencing",
+        "zoo"
       ))
     }
 

diff --git a/sbtPlugin/src/sbt-test/sbt-play-swagger/generate-docs-from-scala-doc/build.sbt b/sbtPlugin/src/sbt-test/sbt-play-swagger/generate-docs-from-scala-doc/build.sbt
@@ -128,11 +128,7 @@ TaskKey[Unit]("check") := {
       |      "title":"Poweramp API",
       |      "description":"My API is the best"
       |   },
-      |   "tags":[
-      |      {
-      |         "name":"${swaggerRoutesFile.value}"
-      |      }
-      |   ]
+      |   "tags":[]
       |}
     """.stripMargin
   )

diff --git a/sbtPlugin/src/sbt-test/sbt-play-swagger/generate-docs/build.sbt b/sbtPlugin/src/sbt-test/sbt-play-swagger/generate-docs/build.sbt
@@ -120,11 +120,7 @@ TaskKey[Unit]("check") := {
       |      "title":"Poweramp API",
       |      "description":"My API is the best"
       |   },
-      |   "tags":[
-      |      {
-      |         "name":"${swaggerRoutesFile.value}"
-      |      }
-      |   ]
+      |   "tags":[]
       |}
     """.stripMargin
   )