Rename convertToJsonSchema method 32/106032/6
authorIvan Hrasko <ivan.hrasko@pantheon.tech>
Thu, 18 May 2023 13:13:27 +0000 (15:13 +0200)
committerIvan Hrasko <ivan.hrasko@pantheon.tech>
Thu, 18 May 2023 13:55:27 +0000 (15:55 +0200)
We are no more returning JSON ObjectNode but Map of Schema.
Rename method accordingly.

JIRA: NETCONF-1024
Change-Id: Ib1d03f2be463c754a0eda2564b50162a9eb9ab45
Signed-off-by: Ivan Hrasko <ivan.hrasko@pantheon.tech>
restconf/restconf-openapi/src/main/java/org/opendaylight/restconf/openapi/impl/BaseYangOpenApiGenerator.java
restconf/restconf-openapi/src/main/java/org/opendaylight/restconf/openapi/impl/DefinitionGenerator.java
restconf/restconf-openapi/src/test/java/org/opendaylight/restconf/openapi/impl/DefinitionGeneratorTest.java

index b723a73258b83b35c958cca63f92409aec58a6d0..407fab1627f55320eb652aa8e51503c06310b48a 100644 (file)
@@ -218,7 +218,7 @@ public abstract class BaseYangOpenApiGenerator {
             final EffectiveModelContext schemaContext, final DefinitionNames definitionNames, final OpenApiObject doc,
             final boolean isForSingleModule) {
         try {
-            final Map<String, Schema> schemas = jsonConverter.convertToJsonSchema(module, schemaContext,
+            final Map<String, Schema> schemas = jsonConverter.convertToSchemas(module, schemaContext,
                 definitionNames, isForSingleModule);
             doc.getComponents().getSchemas().putAll(schemas);
             if (LOG.isDebugEnabled()) {
index cc3ca039df5eea3f87b47f07e25710a8735eb489..7a20c55894683b6b4de8a6cd44096462129c3738 100644 (file)
@@ -132,17 +132,15 @@ public class DefinitionGenerator {
     }
 
     /**
-     * Creates Json definitions from provided module according to swagger spec.
+     * Creates Json definitions from provided module according to openapi spec.
      *
      * @param module          - Yang module to be converted
      * @param schemaContext   - SchemaContext of all Yang files used by Api Doc
      * @param definitionNames - Store for definition names
-     * @return ObjectNode containing data used for creating examples and definitions in Api Doc
+     * @return {@link Map} containing data used for creating examples and definitions in OpenAPI documentation
      * @throws IOException if I/O operation fails
      */
-
-
-    public Map<String, Schema> convertToJsonSchema(final Module module, final EffectiveModelContext schemaContext,
+    public Map<String, Schema> convertToSchemas(final Module module, final EffectiveModelContext schemaContext,
             final Map<String, Schema> definitions, final DefinitionNames definitionNames,
             final boolean isForSingleModule) throws IOException {
         topLevelModule = module;
@@ -158,14 +156,14 @@ public class DefinitionGenerator {
         return definitions;
     }
 
-    public Map<String, Schema> convertToJsonSchema(final Module module, final EffectiveModelContext schemaContext,
+    public Map<String, Schema> convertToSchemas(final Module module, final EffectiveModelContext schemaContext,
             final DefinitionNames definitionNames, final boolean isForSingleModule)
             throws IOException {
         final Map<String, Schema> definitions = new HashMap<>();
         if (isForSingleModule) {
             definitionNames.addUnlinkedName(module.getName() + MODULE_NAME_SUFFIX);
         }
-        return convertToJsonSchema(module, schemaContext, definitions, definitionNames, isForSingleModule);
+        return convertToSchemas(module, schemaContext, definitions, definitionNames, isForSingleModule);
     }
 
     private void processModule(final Module module, final Map<String, Schema> definitions,
index 2e260b1454057e79644337b18f35fbd48ae28c40..7eded3c4b07f493ac66daa308c0775fa86baffc7 100644 (file)
@@ -10,37 +10,32 @@ package org.opendaylight.restconf.openapi.impl;
 import static org.junit.Assert.assertNotNull;
 
 import java.io.IOException;
-import java.util.Map;
 import org.junit.Test;
 import org.opendaylight.restconf.openapi.AbstractOpenApiTest;
-import org.opendaylight.restconf.openapi.model.Schema;
 import org.opendaylight.yangtools.yang.common.Revision;
 
 public final class DefinitionGeneratorTest extends AbstractOpenApiTest {
     @Test
-    public void testConvertToJsonSchema() throws IOException {
+    public void testConvertToSchemas() throws IOException {
         final var module = CONTEXT.findModule("opflex", Revision.of("2014-05-28")).orElseThrow();
         final DefinitionGenerator generator = new DefinitionGenerator();
-        final Map<String, Schema> jsonObject = generator.convertToJsonSchema(module, CONTEXT, new DefinitionNames(),
-                true);
-        assertNotNull(jsonObject);
+        final var schemas = generator.convertToSchemas(module, CONTEXT, new DefinitionNames(), true);
+        assertNotNull(schemas);
     }
 
     @Test
     public void testActionTypes() throws IOException {
         final var module = CONTEXT.findModule("action-types").orElseThrow();
         final DefinitionGenerator generator = new DefinitionGenerator();
-        final Map<String, Schema> jsonObject = generator.convertToJsonSchema(module, CONTEXT, new DefinitionNames(),
-                true);
-        assertNotNull(jsonObject);
+        final var schemas = generator.convertToSchemas(module, CONTEXT, new DefinitionNames(), true);
+        assertNotNull(schemas);
     }
 
     @Test
     public void testStringTypes() throws IOException {
         final var module = CONTEXT.findModule("string-types").orElseThrow();
         final DefinitionGenerator generator = new DefinitionGenerator();
-        final Map<String, Schema> jsonObject = generator.convertToJsonSchema(module, CONTEXT, new DefinitionNames(),
-                true);
-        assertNotNull(jsonObject);
+        final var schemas = generator.convertToSchemas(module, CONTEXT, new DefinitionNames(), true);
+        assertNotNull(schemas);
     }
 }