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

Class BaseYangSwaggerGenerator

java.lang.Object

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

Direct Known Subclasses:

BaseYangSwaggerGeneratorDraft02, BaseYangSwaggerGeneratorRFC8040

public abstract class BaseYangSwaggerGenerator
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	BaseYangSwaggerGenerator.ListPathBuilder

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseYangSwaggerGenerator(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService)

Method Summary

Modifier and Type	Method and Description
protected void	addRpcs(org.opendaylight.yangtools.yang.model.api.RpcDefinition rpcDefn, List<Api> apis, String parentPath, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
protected abstract void	appendPathKeyValue(StringBuilder builder, Object value)
ApiDeclaration	createApiDeclaration(String basePath)
String	createBasePathFromUriInfo(javax.ws.rs.core.UriInfo uriInfo)
ResourceList	createResourceList()
String	generatePath(javax.ws.rs.core.UriInfo uriInfo, String name, String revision)
String	generateUrlPrefixFromInstanceID(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier key, String moduleName)
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)
ApiDeclaration	getApiDeclaration(String module, String revision, javax.ws.rs.core.UriInfo uriInfo)
ApiDeclaration	getApiDeclaration(String moduleName, String revision, javax.ws.rs.core.UriInfo uriInfo, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext, String context)
abstract String	getContent(String dataStore)
abstract String	getDataStorePath(String dataStore, String context)
ResourceList	getResourceListing(javax.ws.rs.core.UriInfo uriInfo)
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.
org.opendaylight.mdsal.dom.api.DOMSchemaService	getSchemaService()
protected SortedSet<org.opendaylight.yangtools.yang.model.api.Module>	getSortedModules(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
ApiDeclaration	getSwaggerDocSpec(org.opendaylight.yangtools.yang.model.api.Module module, String basePath, String context, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
protected abstract BaseYangSwaggerGenerator.ListPathBuilder	newListPathBuilder()

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

Constructor Detail

BaseYangSwaggerGenerator

protected BaseYangSwaggerGenerator(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService)

Method Detail

getSchemaService

public org.opendaylight.mdsal.dom.api.DOMSchemaService getSchemaService()

getResourceListing

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

getResourceListing

public 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

public ResourceList createResourceList()

generatePath

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

getApiDeclaration

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

getApiDeclaration

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

getApiDeclaration

public 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

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

getSwaggerDocSpec

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

createApiDeclaration

public ApiDeclaration createApiDeclaration(String basePath)

getDataStorePath

public abstract String getDataStorePath(String dataStore,
                                        String context)

getContent

public abstract String getContent(String dataStore)

newListPathBuilder

protected abstract BaseYangSwaggerGenerator.ListPathBuilder newListPathBuilder()

addRpcs

protected void addRpcs(org.opendaylight.yangtools.yang.model.api.RpcDefinition rpcDefn,
                       List<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)

appendPathKeyValue

protected abstract void appendPathKeyValue(StringBuilder builder,
                                           Object value)

generateUrlPrefixFromInstanceID

public String generateUrlPrefixFromInstanceID(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier key,
                                              String moduleName)