Merge branch 'provide_version'

Author: sjoubert

src/main/kotlin/com/cosmotech/api/config/CsmOpenAPIConfiguration.kt

@@ -11,6 +11,7 @@ import java.io.BufferedReader
 import org.springframework.beans.factory.annotation.Value
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
+import com.cosmotech.api.utils.getAboutInfo
 
 @Configuration
 open class CsmOpenAPIConfiguration(val csmPlatformProperties: CsmPlatformProperties) {
@@ -38,12 +39,8 @@ open class CsmOpenAPIConfiguration(val csmPlatformProperties: CsmPlatformPropert
 
     openAPI.info.version = apiVersion
 
-    if (!csmPlatformProperties.vcsRef.isNullOrBlank()) {
-      openAPI.info.description += " / ${csmPlatformProperties.vcsRef}"
-    }
-    if (!csmPlatformProperties.commitId.isNullOrBlank()) {
-      openAPI.info.description += " / ${csmPlatformProperties.commitId}"
-    }
+    val fullVersion = getAboutInfo().getJSONObject("version").getString("full")
+    openAPI.info.description += " ($fullVersion)"
 
     // Remove any set of servers already defined in the input openapi.yaml,
     // so as to have the base URL auto-generated based on the incoming requests

src/main/kotlin/com/cosmotech/api/config/CsmPlatformProperties.kt

@@ -9,22 +9,6 @@ import org.springframework.boot.context.properties.ConfigurationProperties
 /** Configuration Properties for the Cosmo Tech Platform */
 @ConfigurationProperties(prefix = "csm.platform")
 data class CsmPlatformProperties(
-
-    /** Platform summary */
-    val summary: String?,
-
-    /** Platform description */
-    val description: String?,
-
-    /** Platform version (MAJOR.MINOR.PATCH) */
-    val version: String?,
-
-    /** Platform exact commit ID */
-    val commitId: String? = null,
-
-    /** Platform exact Version-Control System reference */
-    val vcsRef: String? = null,
-
     /** API Configuration */
     val api: Api,
 

src/main/kotlin/com/cosmotech/api/security/AbstractSecurityConfiguration.kt

@@ -162,6 +162,15 @@ internal fun endpointSecurityReaders(
     customOrganizationViewer: String
 ) =
     listOf(
+        CsmSecurityEndpointsRolesReader(
+            paths = listOf("/about"),
+            roles =
+                arrayOf(
+                    ROLE_ORGANIZATION_USER,
+                    ROLE_ORGANIZATION_VIEWER,
+                    customOrganizationUser,
+                    customOrganizationViewer),
+            customAdmin = customOrganizationAdmin),
         CsmSecurityEndpointsRolesReader(
             paths = PATHS_CONNECTORS,
             roles =

src/main/kotlin/com/cosmotech/api/utils/AboutInfo.kt

@@ -0,0 +1,22 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+package com.cosmotech.api.utils
+
+import java.io.BufferedReader
+import org.json.JSONException
+import org.json.JSONObject
+
+fun getAboutInfo(): JSONObject {
+  val aboutJsonInputStream =
+    object{}::class.java.getResourceAsStream("/about.json")
+      ?: throw IllegalStateException("Unable to read about info data from 'classpath:/about.json'")
+  val aboutJsonContent = aboutJsonInputStream.use { it.bufferedReader().use(BufferedReader::readText) }
+
+  try {
+    return JSONObject(aboutJsonContent)
+  }
+  catch (e: JSONException)
+  {
+    throw IllegalStateException("Unable to parse about info from 'classpath:/about.json'", e)
+  }
+}