io.lighty.swagger.impl

Class BaseYangSwaggerGenerator

java.lang.Object

io.lighty.swagger.impl.BaseYangSwaggerGenerator

Direct Known Subclasses:

ApiDocGenerator, MountPointSwagger

public class BaseYangSwaggerGenerator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	API_VERSION
protected static String	RESTCONF_CONTEXT_ROOT
protected static String	SWAGGER_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseYangSwaggerGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	addRpcs(org.opendaylight.yangtools.yang.model.api.RpcDefinition rpcDefn, List<org.opendaylight.netconf.sal.rest.doc.swagger.Api> apis, String parentPath, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
protected org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration	createApiDeclaration(String basePath)
protected String	createBasePathFromUriInfo(javax.ws.rs.core.UriInfo uriInfo)
protected org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList	createResourceList()
protected String	generatePath(javax.ws.rs.core.UriInfo uriInfo, String name, String revision)
org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration	getApiDeclaration(org.opendaylight.yangtools.yang.model.api.Module module, javax.ws.rs.core.UriInfo uriInfo, String context, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration	getApiDeclaration(String moduleName, String revision, javax.ws.rs.core.UriInfo uriInfo, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext, String context)
protected static String	getContent(String dataStore)
protected String	getDataStorePath(String dataStore, String context)
org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList	getResourceListing(javax.ws.rs.core.UriInfo uriInfo, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext, String context) Return list of modules converted to swagger compliant resource list.
protected SortedSet<org.opendaylight.yangtools.yang.model.api.Module>	getSortedModules(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration	getSwaggerDocSpec(org.opendaylight.yangtools.yang.model.api.Module module, String basePath, String context, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
void	setDraft(boolean draft)

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

protected static final String API_VERSION

See Also:

Constant Field Values

SWAGGER_VERSION

protected static final String SWAGGER_VERSION

See Also:

Constant Field Values

RESTCONF_CONTEXT_ROOT

protected static final String RESTCONF_CONTEXT_ROOT

See Also:

Constant Field Values

Constructor Detail

BaseYangSwaggerGenerator

protected BaseYangSwaggerGenerator()

Method Detail

getResourceListing

public org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList getResourceListing(javax.ws.rs.core.UriInfo uriInfo,
                                                                                     org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext,
                                                                                     String context)

Return list of modules converted to swagger compliant resource list.

createResourceList

protected org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList createResourceList()

generatePath

protected String generatePath(javax.ws.rs.core.UriInfo uriInfo,
                              String name,
                              String revision)

getApiDeclaration

public org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration getApiDeclaration(String moduleName,
                                                                                      String revision,
                                                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                                                      org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext,
                                                                                      String context)

getApiDeclaration

public org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration getApiDeclaration(org.opendaylight.yangtools.yang.model.api.Module module,
                                                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                                                      String context,
                                                                                      org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

createBasePathFromUriInfo

protected String createBasePathFromUriInfo(javax.ws.rs.core.UriInfo uriInfo)

getSwaggerDocSpec

public org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration getSwaggerDocSpec(org.opendaylight.yangtools.yang.model.api.Module module,
                                                                                      String basePath,
                                                                                      String context,
                                                                                      org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

createApiDeclaration

protected org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration createApiDeclaration(String basePath)

getDataStorePath

protected String getDataStorePath(String dataStore,
                                  String context)

getContent

protected static String getContent(String dataStore)

addRpcs

protected void addRpcs(org.opendaylight.yangtools.yang.model.api.RpcDefinition rpcDefn,
                       List<org.opendaylight.netconf.sal.rest.doc.swagger.Api> apis,
                       String parentPath,
                       org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

getSortedModules

protected SortedSet<org.opendaylight.yangtools.yang.model.api.Module> getSortedModules(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

setDraft

public void setDraft(boolean draft)