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

Class ApiDocGeneratorDraftO2

java.lang.Object

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

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

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

public class ApiDocGeneratorDraftO2
extends BaseYangSwaggerGeneratorDraft02

This class gathers all YANG-defined Modules and generates Swagger compliant documentation for the bierman draft02 version.

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

BaseYangSwaggerGenerator.ListPathBuilder

Field Summary

Fields inherited from class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGeneratorDraft02

DEFAULT_BASE_PATH

Fields inherited from class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

API_VERSION, SWAGGER_VERSION

Constructor Summary

Constructors

Constructor and Description
ApiDocGeneratorDraftO2(org.opendaylight.mdsal.dom.api.DOMSchemaService schemaService)
ApiDocGeneratorDraftO2(org.opendaylight.mdsal.dom.api.DOMSchemaService schemaService, String basePath)

Method Summary

Methods inherited from class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGeneratorDraft02

appendPathKeyValue, getContent, getDataStorePath, newListPathBuilder

Methods inherited from class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

addRpcs, createApiDeclaration, createBasePathFromUriInfo, createResourceList, generatePath, generateUrlPrefixFromInstanceID, getApiDeclaration, getApiDeclaration, getApiDeclaration, getResourceListing, getResourceListing, getSchemaService, getSortedModules, getSwaggerDocSpec

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocGeneratorDraftO2

public ApiDocGeneratorDraftO2(org.opendaylight.mdsal.dom.api.DOMSchemaService schemaService)

ApiDocGeneratorDraftO2

public ApiDocGeneratorDraftO2(org.opendaylight.mdsal.dom.api.DOMSchemaService schemaService,
                              String basePath)