Package org.opendaylight.netconf.sal.rest.doc.impl

Class DefinitionGenerator

java.lang.Object

org.opendaylight.netconf.sal.rest.doc.impl.DefinitionGenerator

public class DefinitionGenerator
extends Object

Generates JSON Schema for data defined in YANG. This class is not thread-safe.

Field Summary

Fields

Modifier and Type	Field	Description
static String	INPUT
static String	INPUT_SUFFIX
static String	OUTPUT
static String	OUTPUT_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DefinitionGenerator()

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	convertToJsonSchema(org.opendaylight.yangtools.yang.model.api.Module module, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, com.fasterxml.jackson.databind.node.ObjectNode definitions, DefinitionNames definitionNames, ApiDocServiceImpl.OAversion oaversion, boolean isForSingleModule)	Creates Json definitions from provided module according to swagger spec.
com.fasterxml.jackson.databind.node.ObjectNode	convertToJsonSchema(org.opendaylight.yangtools.yang.model.api.Module module, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, DefinitionNames definitionNames, ApiDocServiceImpl.OAversion oaversion, boolean isForSingleModule)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INPUT

public static final String INPUT

See Also:

Constant Field Values

INPUT_SUFFIX

public static final String INPUT_SUFFIX

See Also:

Constant Field Values

OUTPUT

public static final String OUTPUT

See Also:

Constant Field Values

OUTPUT_SUFFIX

public static final String OUTPUT_SUFFIX

See Also:

Constant Field Values

Constructor Detail

DefinitionGenerator

public DefinitionGenerator()

Method Detail

convertToJsonSchema

public com.fasterxml.jackson.databind.node.ObjectNode convertToJsonSchema(org.opendaylight.yangtools.yang.model.api.Module module,
                                                                          org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                                                          com.fasterxml.jackson.databind.node.ObjectNode definitions,
                                                                          DefinitionNames definitionNames,
                                                                          ApiDocServiceImpl.OAversion oaversion,
                                                                          boolean isForSingleModule)
                                                                   throws IOException

Creates Json definitions from provided module according to swagger spec.

Parameters:

module - - Yang module to be converted

schemaContext - - SchemaContext of all Yang files used by Api Doc

definitionNames - - Store for definition names

Returns:

ObjectNode containing data used for creating examples and definitions in Api Doc

Throws:

IOException - if I/O operation fails

convertToJsonSchema

public com.fasterxml.jackson.databind.node.ObjectNode convertToJsonSchema(org.opendaylight.yangtools.yang.model.api.Module module,
                                                                          org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                                                          DefinitionNames definitionNames,
                                                                          ApiDocServiceImpl.OAversion oaversion,
                                                                          boolean isForSingleModule)
                                                                   throws IOException

Throws:

IOException