#1299 PR updates: api/schema/topic -> api/schema/registry, scaladoc

AbsaOSS · Jun 22, 2020 · 8df37f6 · 8df37f6
1 parent 11ef249
commit 8df37f6
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 17 deletions.
diff --git a/menas/src/main/scala/za/co/absa/enceladus/menas/controllers/SchemaController.scala b/menas/src/main/scala/za/co/absa/enceladus/menas/controllers/SchemaController.scala
@@ -73,7 +73,7 @@ class SchemaController @Autowired()(
     uploadSchemaToMenas(principal.getUsername, menasFile, sparkStruct, schemaType)
   }
 
-  @PostMapping(Array("/topic"))
+  @PostMapping(Array("/registry"))
   @ResponseStatus(HttpStatus.CREATED)
   def handleTopicStem(@AuthenticationPrincipal principal: UserDetails,
                       @RequestParam topicStem: String,

diff --git a/menas/src/main/scala/za/co/absa/enceladus/menas/services/SchemaRegistryService.scala b/menas/src/main/scala/za/co/absa/enceladus/menas/services/SchemaRegistryService.scala
@@ -41,8 +41,8 @@ class SchemaRegistryService @Autowired()() {
 
   /**
    * Loading the latest schema by a topicName (e.g. topic1-value), the url is constructed based on the [[schemaRegistryBaseUrl]]
-   * @param topicName topic name
-   * @return
+   * @param topicName topic name to load the Schema by
+   * @return `SchemaResponse` object containing the obtained schema.
    */
   def loadSchemaByTopicName(topicName: String): SchemaResponse = {
     val schemaUrl = SchemaRegistryService.getLatestSchemaUrl(schemaRegistryBaseUrl, topicName)
@@ -51,8 +51,8 @@ class SchemaRegistryService @Autowired()() {
 
   /**
    * Loading the schema by a full URL
-   * @param remoteUrl
-   * @return
+   * @param remoteUrl URL to for the Schema to be loaded from
+   * @return `SchemaResponse` object containing the obtained schema.
    */
   def loadSchemaByUrl(remoteUrl: String): SchemaResponse = {
     try {

diff --git a/.../scala/za/co/absa/enceladus/menas/integration/controllers/SchemaApiIntegrationSuite.scala b/.../scala/za/co/absa/enceladus/menas/integration/controllers/SchemaApiIntegrationSuite.scala
@@ -1008,7 +1008,7 @@ class SchemaApiIntegrationSuite extends BaseRestApiTest with BeforeAndAfterAll {
     }
   }
 
-  s"POST $apiUrl/topic" should {
+  s"POST $apiUrl/registry" should {
     def topicPath(topicName: String) = s"/subjects/$topicName/versions/latest/schema"
 
     "return 201" when {
@@ -1022,7 +1022,7 @@ class SchemaApiIntegrationSuite extends BaseRestApiTest with BeforeAndAfterAll {
 
           val params = HashMap[String, Any](
             "name" -> schema.name, "version" -> schema.version, "format" -> "avro", "topicStem" -> "myTopic1", "mergeWithKey" -> false)
-          val responseRemoteLoaded = sendPostTopicName[Schema](s"$apiUrl/topic", params)
+          val responseRemoteLoaded = sendPostTopicName[Schema](s"$apiUrl/registry", params)
           assertCreated(responseRemoteLoaded)
 
           val actual = responseRemoteLoaded.getBody
@@ -1042,7 +1042,7 @@ class SchemaApiIntegrationSuite extends BaseRestApiTest with BeforeAndAfterAll {
 
           val params = HashMap[String, Any](
             "name" -> schema.name, "version" -> schema.version, "format" -> "avro", "topicStem" -> "myTopic1", "mergeWithKey" -> true)
-          val responseRemoteLoaded = sendPostTopicName[Schema](s"$apiUrl/topic", params)
+          val responseRemoteLoaded = sendPostTopicName[Schema](s"$apiUrl/registry", params)
           assertCreated(responseRemoteLoaded)
 
           val expectedSchema: StructType = DataType.fromJson(readTestResourceAsString(TestResourcePath.AvroCombining.expectedCombination)).asInstanceOf[StructType]

diff --git a/menas/ui/components/schema/schemaDetail.controller.js b/menas/ui/components/schema/schemaDetail.controller.js
@@ -184,7 +184,7 @@ sap.ui.define([
         };
 
         jQuery.ajax({
-          url: "api/schema/topic",
+          url: "api/schema/registry",
           type: 'POST',
           data: $.param(data),
           contentType: 'application/x-www-form-urlencoded',

diff --git a/utils/src/main/scala/za/co/absa/enceladus/utils/implicits/StringImplicits.scala b/utils/src/main/scala/za/co/absa/enceladus/utils/implicits/StringImplicits.scala
@@ -185,8 +185,8 @@ object StringImplicits {
      * "file:///" / "path" -> "file:///path",
      * }}}
      *
-     * @param another
-     * @return
+     * @param another the second string we are appending after the `/` separator
+     * @return this/another (this has stripped trailing / if present, another has leading / stripped if present)
      */
     def /(another: String): String = { // scalastyle:ignore method.name
       joinWithSingleSeparator(another, "/")

diff --git a/utils/src/main/scala/za/co/absa/enceladus/utils/schema/SchemaUtils.scala b/utils/src/main/scala/za/co/absa/enceladus/utils/schema/SchemaUtils.scala
@@ -589,9 +589,9 @@ object SchemaUtils {
   /**
    * Combines schemas into one. Wrapper for [[SchemaUtils#combineStructFieldLists]]
    *
-   * @param firstType
-   * @param secondType
-   * @return
+   * @param firstType StructType to be combined with `secondType`
+   * @param secondType StructType to be combined with `firstType`
+   * @return combined `firstType` + `secondType` (`firstType`` will take precedence for non-combinable fields of the same name)
    */
   def combineStructTypes(firstType: StructType, secondType: StructType): StructType =
     StructType(combineStructFieldLists(firstType.fields, secondType.fields))
@@ -600,9 +600,9 @@ object SchemaUtils {
    * Combines schemas into one. By-name duplicated struct fields are deep-combined, otherwise the field from `firstFields`
    * takes precedence.
    *
-   * @param firstFields
-   * @param secondFields
-   * @return
+   * @param firstFields fields to be combined with `secondFields`
+   * @param secondFields fields to be combined with `firstFields`
+   * @return combined `firstFields` + `secondFields` (`firstFields` will take precedence for non-combinable fields of the same name)
    */
   def combineStructFieldLists(firstFields: Seq[StructField], secondFields: Seq[StructField]): Seq[StructField] = {
     Seq(firstFields, secondFields).foreach{fields =>