From 5cec9e9bfd4ef7cfd12887d11e8e3a4180484e20 Mon Sep 17 00:00:00 2001 From: Bartlomiej Baj Date: Mon, 8 Jan 2024 12:36:10 +0200 Subject: [PATCH] #29 Fix typo in OpenAPISScalaCustomizer name --- .../scala/za/co/absa/springdocopenapiscala/Bundle.scala | 6 +++--- ...ScalaCustomizer.scala => OpenAPIScalaCustomizer.scala} | 2 +- .../OpenAPIScalaCustomizerSpec.scala | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) rename library/src/main/scala/za/co/absa/springdocopenapiscala/{OpenAPISScalaCustomizer.scala => OpenAPIScalaCustomizer.scala} (95%) diff --git a/library/src/main/scala/za/co/absa/springdocopenapiscala/Bundle.scala b/library/src/main/scala/za/co/absa/springdocopenapiscala/Bundle.scala index b916ff5..769e741 100644 --- a/library/src/main/scala/za/co/absa/springdocopenapiscala/Bundle.scala +++ b/library/src/main/scala/za/co/absa/springdocopenapiscala/Bundle.scala @@ -24,7 +24,7 @@ import za.co.absa.springdocopenapiscala.SpringdocOpenAPIVersionSpecificTypes._ * Glues all components of `springdoc-openapi-scala` together * and enables additional customization (for example to set info). * - * @param extraOpenAPICustomizers additional customizers that are executed after [[OpenAPISScalaCustomizer]] + * @param extraOpenAPICustomizers additional customizers that are executed after [[OpenAPIScalaCustomizer]] */ class Bundle(extraOpenAPICustomizers: Seq[OpenApiCustomizer] = Seq.empty) { @@ -33,9 +33,9 @@ class Bundle(extraOpenAPICustomizers: Seq[OpenApiCustomizer] = Seq.empty) { val modelRegistration: OpenAPIModelRegistration = new OpenAPIModelRegistration(components) val customizer: OpenApiCustomizer = { - val openAPISScalaCustomizer = new OpenAPISScalaCustomizer(components) + val openAPIScalaCustomizer = new OpenAPIScalaCustomizer(components) - (openApi: OpenAPI) => (openAPISScalaCustomizer +: extraOpenAPICustomizers).foreach(_.customise(openApi)) + (openApi: OpenAPI) => (openAPIScalaCustomizer +: extraOpenAPICustomizers).foreach(_.customise(openApi)) } } diff --git a/library/src/main/scala/za/co/absa/springdocopenapiscala/OpenAPISScalaCustomizer.scala b/library/src/main/scala/za/co/absa/springdocopenapiscala/OpenAPIScalaCustomizer.scala similarity index 95% rename from library/src/main/scala/za/co/absa/springdocopenapiscala/OpenAPISScalaCustomizer.scala rename to library/src/main/scala/za/co/absa/springdocopenapiscala/OpenAPIScalaCustomizer.scala index 88e1903..7fd6844 100644 --- a/library/src/main/scala/za/co/absa/springdocopenapiscala/OpenAPISScalaCustomizer.scala +++ b/library/src/main/scala/za/co/absa/springdocopenapiscala/OpenAPIScalaCustomizer.scala @@ -21,7 +21,7 @@ import za.co.absa.springdocopenapiscala.SpringdocOpenAPIVersionSpecificTypes.Ope import scala.collection.JavaConverters._ -class OpenAPISScalaCustomizer(components: Components) extends OpenApiCustomizer { +class OpenAPIScalaCustomizer(components: Components) extends OpenApiCustomizer { override def customise(openAPIOutOfSync: OpenAPI): Unit = { // this is needed as for some reason springdoc-openapi cache the `OpenAPI` at the beginning diff --git a/library/src/test/scala/za/co/absa/springdocopenapiscala/OpenAPIScalaCustomizerSpec.scala b/library/src/test/scala/za/co/absa/springdocopenapiscala/OpenAPIScalaCustomizerSpec.scala index f766499..67a54e8 100644 --- a/library/src/test/scala/za/co/absa/springdocopenapiscala/OpenAPIScalaCustomizerSpec.scala +++ b/library/src/test/scala/za/co/absa/springdocopenapiscala/OpenAPIScalaCustomizerSpec.scala @@ -58,22 +58,22 @@ class OpenAPIScalaCustomizerSpec extends AnyFlatSpec { it should "set `components` of its argument OpenAPI object to one injected via DI to the class" in { val components = new Components().addSchemas("a", new Schema) - val openAPISScalaCustomizer = new OpenAPISScalaCustomizer(components) + val openAPIScalaCustomizer = new OpenAPIScalaCustomizer(components) val openAPI = initializeOpenAPI - openAPISScalaCustomizer.customise(openAPI) + openAPIScalaCustomizer.customise(openAPI) assert(openAPI.getComponents === components) } it should "convert all responses returning Unit (BoxedUnit reference) to empty response" in { val components = new Components() - val openAPISScalaCustomizer = new OpenAPISScalaCustomizer(components) + val openAPIScalaCustomizer = new OpenAPIScalaCustomizer(components) val openAPI = initializeOpenAPI - openAPISScalaCustomizer.customise(openAPI) + openAPIScalaCustomizer.customise(openAPI) assert( Option(openAPI.getPaths.get("/api/endpoint").getPost.getResponses.get("200").getContent).isEmpty