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

Class ApiDocGenerator

java.lang.Object

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

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

public class ApiDocGenerator
extends BaseYangSwaggerGenerator

This class gathers all YANG-defined Modules and generates Swagger compliant documentation.

Field Summary

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

API_VERSION, RESTCONF_CONTEXT_ROOT, SWAGGER_VERSION

Constructor Summary

Constructors

Constructor and Description
ApiDocGenerator()

Method Summary

Modifier and Type	Method and Description
ApiDeclaration	getApiDeclaration(String module, String revision, javax.ws.rs.core.UriInfo uriInfo)
static ApiDocGenerator	getInstance() Returns singleton instance.
ResourceList	getResourceListing(javax.ws.rs.core.UriInfo uriInfo)
void	setDraft(boolean newDraft)
void	setSchemaService(org.opendaylight.controller.sal.core.api.model.SchemaService schemaService)

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

addRpcs, createApiDeclaration, createBasePathFromUriInfo, createResourceList, generatePath, getApiDeclaration, getApiDeclaration, getContent, getDataStorePath, getResourceListing, getSortedModules, getSwaggerDocSpec

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocGenerator

public ApiDocGenerator()

Method Detail

getResourceListing

public ResourceList getResourceListing(javax.ws.rs.core.UriInfo uriInfo)

getApiDeclaration

public ApiDeclaration getApiDeclaration(String module,
                                        String revision,
                                        javax.ws.rs.core.UriInfo uriInfo)

getInstance

public static ApiDocGenerator getInstance()

Returns singleton instance.

setDraft

public void setDraft(boolean newDraft)

Overrides:

setDraft in class BaseYangSwaggerGenerator

setSchemaService

public void setSchemaService(org.opendaylight.controller.sal.core.api.model.SchemaService schemaService)