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>
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()) {
}
/**
- * 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;
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,
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);
}
}