A B C D G H I J M N O P R S T

A

addRpcs(RpcDefinition, List<Api>, String, SchemaContext) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

Api - Class in org.opendaylight.netconf.sal.rest.doc.swagger

Implementation of swagger spec (see https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#522-api -object).

Api() - Constructor for class org.opendaylight.netconf.sal.rest.doc.swagger.Api

API_VERSION - Static variable in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

ApiDeclaration - Class in org.opendaylight.netconf.sal.rest.doc.swagger

Implementation of swagger spec (see https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#52-api- declaration).

ApiDeclaration() - Constructor for class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

ApiDocApplication - Class in org.opendaylight.netconf.sal.rest.doc.jaxrs

ApiDocApplication() - Constructor for class org.opendaylight.netconf.sal.rest.doc.jaxrs.ApiDocApplication

ApiDocGenerator - Class in org.opendaylight.netconf.sal.rest.doc.impl

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

ApiDocGenerator() - Constructor for class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocGenerator

ApiDocService - Interface in org.opendaylight.netconf.sal.rest.doc.api

This service generates swagger (See https://helloreverb.com/developers/swagger) compliant documentation for RESTCONF APIs.

ApiDocServiceImpl - Class in org.opendaylight.netconf.sal.rest.doc.impl

This service generates swagger (See https://helloreverb.com/developers/swagger) compliant documentation for RESTCONF APIs.

ApiDocServiceImpl() - Constructor for class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

B

BaseYangSwaggerGenerator - Class in org.opendaylight.netconf.sal.rest.doc.impl

BaseYangSwaggerGenerator() - Constructor for class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

build() - Method in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Delete

build() - Method in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get

build() - Method in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post

build() - Method in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put

C

close() - Method in class org.opendaylight.netconf.sal.rest.doc.DocProvider

CONFIG - Static variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder

CONSUMES_PUT_POST - Static variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder

convertToJsonSchema(Module, SchemaContext) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ModelGenerator

Creates Json models from provided module according to swagger spec.

createApiDeclaration(String) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

createBasePathFromUriInfo(UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

createResourceList() - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

D

Delete(DataSchemaNode) - Constructor for class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Delete

DocProvider - Class in org.opendaylight.netconf.sal.rest.doc

DocProvider(SchemaService, DOMMountPointService) - Constructor for class org.opendaylight.netconf.sal.rest.doc.DocProvider

G

generatePath(UriInfo, String, String) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

Get(DataSchemaNode, boolean) - Constructor for class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get

getApiDeclaration(String, String, UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocGenerator

getApiDeclaration(String, String, UriInfo, SchemaContext, String) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

getApiDeclaration(Module, UriInfo, String, SchemaContext) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

getApiExplorer(UriInfo) - Method in interface org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

Redirects to embedded swagger ui.

getApiExplorer(UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

Redirects to embedded swagger ui.

getApis() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

getApis() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList

getApiVersion() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

getApiVersion() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList

getBasePath() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

getCode() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResponseMessage

getConsumes() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

getContent(String) - Static method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

getContext(Class<?>) - Method in class org.opendaylight.netconf.sal.rest.doc.jaxrs.JaxbContextResolver

getDataStorePath(String, String) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

getDescription() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

getDescription() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Resource

getDocByModule(String, String, UriInfo) - Method in interface org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

Generates Swagger compliant document listing APIs for module.

getDocByModule(String, String, UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

Generates Swagger compliant document listing APIs for module.

getInstance() - Static method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocGenerator

Returns singleton instance.

getInstance() - Static method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

getInstance() - Static method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

getInstanceDraft18() - Static method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

getInstanceIdentifiers() - Method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

getListOfMounts(UriInfo) - Method in interface org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

Generates index document for Swagger UI.

getListOfMounts(UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

getMessage() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResponseMessage

getMethod() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

getModels() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

getMountDocByModule(String, String, String, UriInfo) - Method in interface org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

Generates Swagger compliant document listing APIs for module.

getMountDocByModule(String, String, String, UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

getMountPointApi(UriInfo, Long, String, String) - Method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

getMountRootDoc(String, UriInfo) - Method in interface org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

getMountRootDoc(String, UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

getName() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

getNickname() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

getNotes() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

getOperations() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Api

getParameters() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

getParamType() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

getPath() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Api

getPath() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Resource

getProduces() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

getResourceList(UriInfo, Long) - Method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

getResourceListing(UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocGenerator

getResourceListing(UriInfo, SchemaContext, String) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

Return list of modules converted to swagger compliant resource list.

getResourcePath() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

getResponseMessages() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

getRootDoc(UriInfo) - Method in interface org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

Generates index document for Swagger UI.

getRootDoc(UriInfo) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

Generates index document for Swagger UI.

getSingletons() - Method in class org.opendaylight.netconf.sal.rest.doc.jaxrs.ApiDocApplication

getSortedModules(SchemaContext) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

getSummary() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

getSwaggerDocSpec(Module, String, String, SchemaContext) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

getSwaggerVersion() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

getSwaggerVersion() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList

getType() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

getType() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

H

hasApi() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

hasModel() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

I

isRequired() - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

J

JaxbContextResolver - Class in org.opendaylight.netconf.sal.rest.doc.jaxrs

JaxbContextResolver() - Constructor for class org.opendaylight.netconf.sal.rest.doc.jaxrs.JaxbContextResolver

M

METHOD_NAME - Static variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post

ModelGenerator - Class in org.opendaylight.netconf.sal.rest.doc.impl

Generates JSON Schema for data defined in YANG.

ModelGenerator() - Constructor for class org.opendaylight.netconf.sal.rest.doc.impl.ModelGenerator

MountPointSwagger - Class in org.opendaylight.netconf.sal.rest.doc.mountpoints

MountPointSwagger() - Constructor for class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

N

nodeName - Variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put

O

onMountPointCreated(YangInstanceIdentifier) - Method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

onMountPointRemoved(YangInstanceIdentifier) - Method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

Operation - Class in org.opendaylight.netconf.sal.rest.doc.swagger

Implementation of swagger spec (see https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#523- operation-object).

Operation() - Constructor for class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

OPERATIONAL - Static variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder

OperationBuilder - Class in org.opendaylight.netconf.sal.rest.doc.model.builder

OperationBuilder.Delete - Class in org.opendaylight.netconf.sal.rest.doc.model.builder

OperationBuilder.Get - Class in org.opendaylight.netconf.sal.rest.doc.model.builder

OperationBuilder.Post - Class in org.opendaylight.netconf.sal.rest.doc.model.builder

OperationBuilder.Put - Class in org.opendaylight.netconf.sal.rest.doc.model.builder

org.opendaylight.netconf.sal.rest.doc - package org.opendaylight.netconf.sal.rest.doc

org.opendaylight.netconf.sal.rest.doc.api - package org.opendaylight.netconf.sal.rest.doc.api

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

org.opendaylight.netconf.sal.rest.doc.jaxrs - package org.opendaylight.netconf.sal.rest.doc.jaxrs

org.opendaylight.netconf.sal.rest.doc.model.builder - package org.opendaylight.netconf.sal.rest.doc.model.builder

org.opendaylight.netconf.sal.rest.doc.mountpoints - package org.opendaylight.netconf.sal.rest.doc.mountpoints

org.opendaylight.netconf.sal.rest.doc.swagger - package org.opendaylight.netconf.sal.rest.doc.swagger

org.opendaylight.netconf.sal.rest.doc.util - package org.opendaylight.netconf.sal.rest.doc.util

P

Parameter - Class in org.opendaylight.netconf.sal.rest.doc.swagger

Implementation of swagger spec (see https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#524- parameter-object).

Parameter() - Constructor for class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

parentName - Variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put

pathParams(List<Parameter>) - Method in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get

pathParams(List<Parameter>) - Method in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post

pathParams(List<Parameter>) - Method in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put

Post(String, String, String, DataNodeContainer) - Constructor for class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post

Put(String, String, String) - Constructor for class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put

R

resolveNodesName(SchemaNode, Module, SchemaContext) - Static method in class org.opendaylight.netconf.sal.rest.doc.util.RestDocgenUtil

resolvePathArgumentsName(SchemaNode, SchemaContext) - Static method in class org.opendaylight.netconf.sal.rest.doc.util.RestDocgenUtil

Resolve path argument name for node.

Resource - Class in org.opendaylight.netconf.sal.rest.doc.swagger

Implementation of swagger spec (see https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#512- resource-object).

Resource() - Constructor for class org.opendaylight.netconf.sal.rest.doc.swagger.Resource

ResourceList - Class in org.opendaylight.netconf.sal.rest.doc.swagger

Implementation of swagger spec (see https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#51- resource-listing).

ResourceList() - Constructor for class org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList

ResponseMessage - Class in org.opendaylight.netconf.sal.rest.doc.swagger

Implementation of swagger spec (see https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#525- response-message-object).

ResponseMessage() - Constructor for class org.opendaylight.netconf.sal.rest.doc.swagger.ResponseMessage

RESTCONF_CONTEXT_ROOT - Static variable in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

RestDocgenUtil - Class in org.opendaylight.netconf.sal.rest.doc.util

S

schemaNode - Variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get

setApis(List<Api>) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

setApis(List<Resource>) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList

setApiVersion(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

setApiVersion(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList

setBasePath(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

setCode(int) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResponseMessage

setConsumes(List<String>) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

setDescription(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

setDescription(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Resource

setDraft(boolean) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocGenerator

setDraft(boolean) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

setGlobalSchema(SchemaService) - Method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

setMessage(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResponseMessage

setMethod(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

setModels(ObjectNode) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

setMountService(DOMMountPointService) - Method in class org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger

setName(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

setNickname(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

setNotes(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

setOperations(List<Operation>) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Api

setParameters(List<Parameter>) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

setParamType(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

setPath(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Api

setPath(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Resource

setProduces(List<String>) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

setRequired(boolean) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

setResourcePath(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

setResponseMessages(List<ResponseMessage>) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

setSchemaService(SchemaService) - Method in class org.opendaylight.netconf.sal.rest.doc.impl.ApiDocGenerator

setSummary(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

setSwaggerVersion(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration

setSwaggerVersion(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList

setType(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Operation

setType(String) - Method in class org.opendaylight.netconf.sal.rest.doc.swagger.Parameter

spec - Variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get

spec - Variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put

summary(String) - Method in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post

SWAGGER_VERSION - Static variable in class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

T

TOP - Static variable in class org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder

A B C D G H I J M N O P R S T