feat: add access key parameter to /sample/info and remove downloadAsFile

GenSpectrum · Feb 12, 2024 · 340f2ac · 340f2ac
1 parent 1402019
commit 340f2ac
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 8 deletions.
diff --git a/lapis2/src/main/kotlin/org/genspectrum/lapis/openApi/AccessKeyParameterCustomizer.kt b/lapis2/src/main/kotlin/org/genspectrum/lapis/openApi/AccessKeyParameterCustomizer.kt
@@ -0,0 +1,41 @@
+package org.genspectrum.lapis.openApi
+
+import io.swagger.v3.oas.models.OpenAPI
+import io.swagger.v3.oas.models.parameters.Parameter
+import org.genspectrum.lapis.config.DatabaseConfig
+import org.genspectrum.lapis.config.OpennessLevel
+import org.genspectrum.lapis.controller.ACCESS_KEY_PROPERTY
+import org.genspectrum.lapis.controller.INFO_ROUTE
+import org.springdoc.core.customizers.OpenApiCustomizer
+import org.springframework.stereotype.Component
+
+@Component
+class AccessKeyParameterCustomizer(
+    private val databaseConfig: DatabaseConfig,
+) : OpenApiCustomizer {
+    companion object {
+        private val PATH_WITH_ACCESS_KEY_PARAMETER = listOf(
+            "/sample$INFO_ROUTE",
+        )
+    }
+
+    override fun customise(openApi: OpenAPI) {
+        if (databaseConfig.schema.opennessLevel == OpennessLevel.OPEN) {
+            return
+        }
+
+        for ((_, path) in openApi.paths.filter { (url, _) ->
+            PATH_WITH_ACCESS_KEY_PARAMETER.any {
+                url.startsWith(it)
+            }
+        }) {
+            path.get.addParametersItem(
+                Parameter()
+                    .`in`("query")
+                    .name(ACCESS_KEY_PROPERTY)
+                    .description(ACCESS_KEY_DESCRIPTION)
+                    .schema(accessKeySchema()),
+            )
+        }
+    }
+}
diff --git a/lapis2/src/main/kotlin/org/genspectrum/lapis/openApi/DownloadAsFileParameterCustomizer.kt b/lapis2/src/main/kotlin/org/genspectrum/lapis/openApi/DownloadAsFileParameterCustomizer.kt
@@ -3,13 +3,24 @@ package org.genspectrum.lapis.openApi
 import io.swagger.v3.oas.models.OpenAPI
 import io.swagger.v3.oas.models.parameters.Parameter
 import org.genspectrum.lapis.controller.DOWNLOAD_AS_FILE_PROPERTY
+import org.genspectrum.lapis.controller.INFO_ROUTE
 import org.springdoc.core.customizers.OpenApiCustomizer
 import org.springframework.stereotype.Component
 
 @Component
 class DownloadAsFileParameterCustomizer : OpenApiCustomizer {
+    companion object {
+        private val PATH_WITHOUT_DOWNLOAD_AS_FILE = listOf(
+            "/sample$INFO_ROUTE",
+        )
+    }
+
     override fun customise(openApi: OpenAPI) {
-        for ((_, path) in openApi.paths.filter { (url, _) -> url.startsWith("/sample") }) {
+        for ((_, path) in openApi.paths.filter { (url, _) ->
+            url.startsWith("/sample") && !PATH_WITHOUT_DOWNLOAD_AS_FILE.any {
+                url.startsWith(it)
+            }
+        }) {
             path.get.addParametersItem(
                 Parameter()
                     .`in`("query")

diff --git a/lapis2/src/main/kotlin/org/genspectrum/lapis/openApi/OpenApiDocs.kt b/lapis2/src/main/kotlin/org/genspectrum/lapis/openApi/OpenApiDocs.kt
@@ -354,13 +354,7 @@ private fun getAggregatedResponseProperties(filterProperties: Map<SequenceFilter
         COUNT_PROPERTY to IntegerSchema().description("The number of sequences matching the filters."),
     )
 
-private fun accessKeySchema() =
-    StringSchema()
-        .description(
-            "An access key that grants access to the protected data that this instance serves. " +
-                "There are two types or access keys: One only grants access to aggregated data, " +
-                "the other also grants access to detailed data.",
-        )
+fun accessKeySchema() = StringSchema().description(ACCESS_KEY_DESCRIPTION)
 
 private fun nucleotideMutationProportionSchema() =
     mapOf(

diff --git a/lapis2/src/main/kotlin/org/genspectrum/lapis/openApi/Schemas.kt b/lapis2/src/main/kotlin/org/genspectrum/lapis/openApi/Schemas.kt
@@ -82,6 +82,12 @@ Set to true to make your browser trigger a download instead of showing the respo
 'Content-Disposition' header to 'attachment'.
 """
 
+const val ACCESS_KEY_DESCRIPTION = """
+An access key that grants access to the protected data that this instance serves.
+There are two types or access keys: One only grants access to aggregated data,
+the other also grants access to detailed data.
+"""
+
 @Target(AnnotationTarget.FUNCTION, AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
 @Operation