Merge pull request #950 from NDLANO/feat/openapi-auth-url-and-scopes

feat: generate proper auth/token URLs and scopes for Auth0 OpenAPI docs

Author: amatho

article-api/src/main/scala/no/ndla/articleapi/ArticleApiProperties.scala

@@ -8,6 +8,7 @@
 
 package no.ndla.articleapi
 
+import no.ndla.common.auth.Permission
 import no.ndla.common.configuration.{BaseProps, Prop}
 import no.ndla.common.model.EmbedType
 import no.ndla.database.DatabaseProps
@@ -79,4 +80,6 @@ class ArticleApiProperties extends BaseProps with DatabaseProps {
 
   override def MetaMigrationLocation: String      = "no/ndla/articleapi/db/migration"
   override def MetaMigrationTable: Option[String] = Some("schema_version")
+
+  override val ndlaAuth0Scopes: Seq[Permission] = Permission.thatStartsWith("articles") :+ Permission.DRAFT_API_WRITE
 }

article-api/src/main/scala/no/ndla/articleapi/ComponentRegistry.scala

@@ -38,6 +38,7 @@ import no.ndla.network.tapir.{
   ErrorHelpers,
   Routes,
   SwaggerController,
+  SwaggerInfo,
   TapirApplication,
   TapirController,
   TapirHealthController,
@@ -91,11 +92,15 @@ class ComponentRegistry(properties: ArticleApiProperties) extends TapirApplicati
     new V67__ComputeSearchTraitsAgain,
   )
 
-  given swagger: SwaggerController = new SwaggerController(
-    List[TapirController](articleControllerV2, internController, healthController),
-    SwaggerDocControllerConfig.swaggerInfo,
+  given swaggerInfo: SwaggerInfo = SwaggerInfo(
+    prefix = "article-api",
+    description = "Searching and fetching all articles published on the NDLA platform.\n\n" +
+      "The Article API provides an endpoint for searching and fetching articles. Different meta-data is attached to the " +
+      "returned articles, and typical examples of this are language and license.\n" +
+      "Includes endpoints to filter Articles on different levels, and retrieve single articles.",
   )
+  given swagger: SwaggerController = new SwaggerController(internController, articleControllerV2, healthController)
 
-  given services: List[TapirController] = swagger.getServices()
+  given services: List[TapirController] = swagger.allServices
   given routes: Routes                  = new Routes
 }

article-api/src/main/scala/no/ndla/articleapi/controller/InternController.scala

@@ -25,7 +25,7 @@ import no.ndla.database.DBUtility
 import no.ndla.language.Language
 import no.ndla.network.tapir.NoNullJsonPrinter.jsonBody
 import no.ndla.network.tapir.TapirUtil.errorOutputsFor
-import no.ndla.network.tapir.auth.Permission.ARTICLE_API_WRITE
+import no.ndla.common.auth.Permission.ARTICLE_API_WRITE
 import no.ndla.network.tapir.{ErrorHandling, ErrorHelpers, TapirController}
 import no.ndla.network.clients.MyNDLAApiClient
 import sttp.model.StatusCode

article-api/src/main/scala/no/ndla/articleapi/controller/SwaggerDocControllerConfig.scala

@@ -9,6 +9,7 @@
 package no.ndla.audioapi
 
 import com.typesafe.scalalogging.StrictLogging
+import no.ndla.common.auth.Permission
 import no.ndla.common.configuration.{BaseProps, Prop}
 import no.ndla.database.DatabaseProps
 import no.ndla.network.{AuthUser, Domains}
@@ -67,4 +68,6 @@ class AudioApiProperties extends BaseProps with DatabaseProps with StrictLogging
 
   override def MetaMigrationLocation: String      = "no/ndla/audioapi/db/migration"
   override def MetaMigrationTable: Option[String] = Some("schema_version")
+
+  override val ndlaAuth0Scopes: Seq[Permission] = Permission.thatStartsWith("audio")
 }

audio-api/src/main/scala/no/ndla/audioapi/AudioApiProperties.scala

@@ -21,7 +21,7 @@ import no.ndla.common.brightcove.NdlaBrightcoveClient
 import no.ndla.database.{DBMigrator, DataSource, DBUtility}
 import no.ndla.network.NdlaClient
 import no.ndla.network.clients.MyNDLAApiClient
-import no.ndla.network.tapir.{ErrorHelpers, Routes, SwaggerController, TapirApplication}
+import no.ndla.network.tapir.{ErrorHelpers, Routes, SwaggerController, SwaggerInfo, TapirApplication}
 import no.ndla.search.{Elastic4sClientFactory, NdlaE4sClient, SearchLanguage}
 
 class ComponentRegistry(properties: AudioApiProperties) extends TapirApplication[AudioApiProperties] {
@@ -70,11 +70,21 @@ class ComponentRegistry(properties: AudioApiProperties) extends TapirApplication
   given healthController: HealthController               = new HealthController
   given transcriptionController: TranscriptionController = new TranscriptionController
 
+  given swaggerInfo: SwaggerInfo = SwaggerInfo(
+    prefix = "audio-api",
+    description = "Searching and fetching all audio used in the NDLA platform.\n\n" +
+      "The Audio API provides an endpoint for searching and fetching audio used in NDLA resources. " +
+      "Meta-data like title, tags, language and license are searchable and also provided in the results. " +
+      "The media file is provided as an URL with the mime type.",
+  )
   given swagger: SwaggerController = new SwaggerController(
-    List(audioApiController, seriesController, internController, healthController, transcriptionController),
-    SwaggerDocControllerConfig.swaggerInfo,
+    internController,
+    audioApiController,
+    seriesController,
+    healthController,
+    transcriptionController,
   )
 
-  given services: List[no.ndla.network.tapir.TapirController] = swagger.getServices()
+  given services: List[no.ndla.network.tapir.TapirController] = swagger.allServices
   given routes: Routes                                        = new Routes
 }

audio-api/src/main/scala/no/ndla/audioapi/ComponentRegistry.scala

@@ -25,7 +25,7 @@ import no.ndla.common.model.domain.UploadedFile
 import no.ndla.network.clients.MyNDLAApiClient
 import no.ndla.network.tapir.{ErrorHelpers, NonEmptyString, TapirController}
 import no.ndla.network.tapir.TapirUtil.errorOutputsFor
-import no.ndla.network.tapir.auth.Permission.AUDIO_API_WRITE
+import no.ndla.common.auth.Permission.AUDIO_API_WRITE
 import sttp.model.Part
 import sttp.tapir.EndpointIO.annotations.{header, jsonbody}
 import sttp.tapir.generic.auto.*

audio-api/src/main/scala/no/ndla/audioapi/controller/AudioController.scala

@@ -8,6 +8,7 @@
 
 package no.ndla.audioapi.controller
 
+import no.ndla.audioapi.Props
 import no.ndla.audioapi.integration.NDLAS3Client
 import no.ndla.audioapi.repository.AudioRepository
 import no.ndla.network.tapir.{ErrorHelpers, TapirHealthController}
@@ -21,6 +22,7 @@ class HealthController(using
     myNDLAApiClient: MyNDLAApiClient,
     errorHelpers: ErrorHelpers,
     errorHandling: ControllerErrorHandling,
+    props: Props,
 ) extends TapirHealthController {
   private def checkBucketAccess(): Either[String, Unit] = s3Client.canAccessBucket match {
     case Failure(ex) =>

audio-api/src/main/scala/no/ndla/audioapi/controller/HealthController.scala

@@ -19,7 +19,7 @@ import no.ndla.audioapi.service.{ReadService, WriteService}
 import no.ndla.language.Language
 import no.ndla.network.tapir.NoNullJsonPrinter.*
 import no.ndla.network.tapir.TapirUtil.errorOutputsFor
-import no.ndla.network.tapir.auth.Permission.AUDIO_API_WRITE
+import no.ndla.common.auth.Permission.AUDIO_API_WRITE
 import no.ndla.common.implicits.*
 import no.ndla.common.model.api.LanguageCode
 import no.ndla.network.tapir.{ErrorHelpers, TapirController}