Merge pull request #449 from NDLANO/update-swagger-doc

Add resourcetype list to swaggerdoc
NDLANO · Apr 12, 2024 · d4f73f7 · d4f73f7
2 parents 06101b2 + f5ad6b7
commit d4f73f7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/common/src/main/scala/no/ndla/common/model/domain/ResourceType.scala b/common/src/main/scala/no/ndla/common/model/domain/ResourceType.scala
@@ -11,7 +11,9 @@ import com.scalatsi.TypescriptType.{TSLiteralString, TSUnion}
 import com.scalatsi.{TSNamedType, TSType}
 import enumeratum.*
 
-sealed abstract class ResourceType(override val entryName: String) extends EnumEntry {}
+sealed abstract class ResourceType(override val entryName: String) extends EnumEntry {
+  override def toString: String = entryName
+}
 
 object ResourceType extends Enum[ResourceType] with CirceEnum[ResourceType] {
   override val values: IndexedSeq[ResourceType] = findValues

diff --git a/myndla-api/src/main/scala/no/ndla/myndlaapi/controller/StatsController.scala b/myndla-api/src/main/scala/no/ndla/myndlaapi/controller/StatsController.scala
@@ -9,6 +9,7 @@ package no.ndla.myndlaapi.controller
 
 import no.ndla.common.errors.NotFoundException
 import no.ndla.common.model.api.SingleResourceStats
+import no.ndla.common.model.domain.ResourceType
 import no.ndla.myndlaapi.Eff
 import no.ndla.myndlaapi.model.api.Stats
 import no.ndla.myndlaapi.service.FolderReadService
@@ -17,8 +18,8 @@ import no.ndla.network.tapir.{Service, TapirErrorHelpers}
 import no.ndla.network.tapir.TapirErrors.errorOutputsFor
 import sttp.tapir.EndpointInput
 import sttp.tapir.server.ServerEndpoint
-import sttp.tapir._
-import sttp.tapir.generic.auto._
+import sttp.tapir.*
+import sttp.tapir.generic.auto.*
 import sttp.tapir.model.CommaSeparated
 
 trait StatsController {
@@ -39,7 +40,11 @@ trait StatsController {
         }
       }
     private val pathResourceType =
-      path[CommaSeparated[String]]("resourceType").description("The type of the resource to look up")
+      path[CommaSeparated[String]]("resourceType")
+        .description(
+          s"The type of the resource to look up. Comma separated list to support ${ResourceType.Multidisciplinary}. Possible values ${ResourceType.values
+              .mkString(", ")}"
+        )
     private val pathResourceIds =
       path[CommaSeparated[String]]("resourceIds").description("IDs of the resources to look up")