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

Class ApiDocGeneratorRFC8040

java.lang.Object

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

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

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

public class ApiDocGeneratorRFC8040
extends BaseYangSwaggerGeneratorRFC8040

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

Author:

Thomas Pantelis

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.BaseYangSwaggerGenerator

BASE_PATH, MODULE_NAME_SUFFIX

Constructor Summary

Constructors

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

Method Summary

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

appendPathKeyValue, getPathVersion, getResourcePath, getResourcePathPart, newListPathBuilder

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

createHostFromUriInfo, createResourceList, createSchemaFromUriInfo, createSwaggerObject, fillDoc, generatePath, generateUrlPrefixFromInstanceID, getAllModulesDoc, getAllModulesDoc, getApiDeclaration, getApiDeclaration, getApiDeclaration, getAppropriateDoc, getResourceListing, getResourceListing, getSchemaService, getSortedModules, getSwaggerDocSpec, getSwaggerDocSpec

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocGeneratorRFC8040

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

ApiDocGeneratorRFC8040

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