*/
package org.opendaylight.netconf.sal.rest.doc.impl;
+import static org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.DEFAULT_PAGESIZE;
import static org.opendaylight.netconf.sal.rest.doc.util.RestDocgenUtil.resolvePathArgumentsName;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.SortedSet;
import java.util.TreeSet;
import javax.ws.rs.core.UriInfo;
-import org.opendaylight.controller.sal.core.api.model.SchemaService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
+import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.URIType;
import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder;
import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Delete;
import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
+import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.slf4j.Logger;
// private Map<String, ApiDeclaration> MODULE_DOC_CACHE = new HashMap<>()
private final ObjectMapper mapper = new ObjectMapper();
- private final SchemaService schemaService;
+ private final DOMSchemaService schemaService;
- protected BaseYangSwaggerGenerator(Optional<SchemaService> schemaService) {
+ protected BaseYangSwaggerGenerator(final Optional<DOMSchemaService> schemaService) {
this.schemaService = schemaService.orElse(null);
this.mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
}
- public SchemaService getSchemaService() {
+ public DOMSchemaService getSchemaService() {
return schemaService;
}
- public ResourceList getResourceListing(final UriInfo uriInfo) {
+ public ResourceList getResourceListing(final UriInfo uriInfo, final URIType uriType) {
final SchemaContext schemaContext = schemaService.getGlobalContext();
Preconditions.checkState(schemaContext != null);
- return getResourceListing(uriInfo, schemaContext, "");
+ return getResourceListing(uriInfo, schemaContext, "", 0, true, uriType);
+ }
+
+ public ResourceList getResourceListing(final UriInfo uriInfo, final SchemaContext schemaContext,
+ final String context, final URIType uriType) {
+ return getResourceListing(uriInfo, schemaContext, context, 0, true, uriType);
}
/**
* Return list of modules converted to swagger compliant resource list.
*/
public ResourceList getResourceListing(final UriInfo uriInfo, final SchemaContext schemaContext,
- final String context) {
+ final String context, final int pageNum, final boolean all, final URIType uriType) {
final ResourceList resourceList = createResourceList();
final Set<Module> modules = getSortedModules(schemaContext);
- final List<Resource> resources = new ArrayList<>(modules.size());
+ final List<Resource> resources = new ArrayList<>(DEFAULT_PAGESIZE);
LOG.info("Modules found [{}]", modules.size());
-
+ final int start = DEFAULT_PAGESIZE * pageNum;
+ final int end = start + DEFAULT_PAGESIZE;
+ int count = 0;
for (final Module module : modules) {
final String revisionString = module.getQNameModule().getRevision().map(Revision::toString).orElse(null);
- final Resource resource = new Resource();
+
LOG.debug("Working on [{},{}]...", module.getName(), revisionString);
final ApiDeclaration doc =
- getApiDeclaration(module.getName(), revisionString, uriInfo, schemaContext, context);
-
+ getApiDeclaration(module.getName(), revisionString, uriInfo, schemaContext, context, uriType);
if (doc != null) {
- resource.setPath(generatePath(uriInfo, module.getName(), revisionString));
- resources.add(resource);
+ count++;
+ if (count >= start && count < end || all) {
+ final Resource resource = new Resource();
+ resource.setPath(generatePath(uriInfo, module.getName(), revisionString));
+ resources.add(resource);
+ }
+
+ if (count >= end && !all) {
+ break;
+ }
} else {
LOG.warn("Could not generate doc for {},{}", module.getName(), revisionString);
}
}
public String generatePath(final UriInfo uriInfo, final String name, final String revision) {
- final URI uri = uriInfo.getRequestUriBuilder().path(generateCacheKey(name, revision)).build();
+ final URI uri = uriInfo.getRequestUriBuilder().replaceQuery("").path(generateCacheKey(name, revision)).build();
return uri.toASCIIString();
}
- public ApiDeclaration getApiDeclaration(final String module, final String revision, final UriInfo uriInfo) {
+ public ApiDeclaration getApiDeclaration(final String module, final String revision, final UriInfo uriInfo,
+ final URIType uriType) {
final SchemaContext schemaContext = schemaService.getGlobalContext();
Preconditions.checkState(schemaContext != null);
- return getApiDeclaration(module, revision, uriInfo, schemaContext, "");
+ return getApiDeclaration(module, revision, uriInfo, schemaContext, "", uriType);
}
public ApiDeclaration getApiDeclaration(final String moduleName, final String revision, final UriInfo uriInfo,
- final SchemaContext schemaContext, final String context) {
+ final SchemaContext schemaContext, final String context, final URIType uriType) {
final Optional<Revision> rev;
try {
final Module module = schemaContext.findModule(moduleName, rev).orElse(null);
Preconditions.checkArgument(module != null,
- "Could not find module by name,revision: " + moduleName + "," + revision);
+ "Could not find module by name,revision: " + moduleName + "," + revision);
- return getApiDeclaration(module, uriInfo, context, schemaContext);
+ return getApiDeclaration(module, uriInfo, context, schemaContext, uriType);
}
public ApiDeclaration getApiDeclaration(final Module module, final UriInfo uriInfo,
- final String context, final SchemaContext schemaContext) {
+ final String context, final SchemaContext schemaContext, final URIType uriType) {
final String basePath = createBasePathFromUriInfo(uriInfo);
- final ApiDeclaration doc = getSwaggerDocSpec(module, basePath, context, schemaContext);
+ final ApiDeclaration doc = getSwaggerDocSpec(module, basePath, context, schemaContext, uriType);
if (doc != null) {
return doc;
}
portPart = ":" + port;
}
final String basePath =
- new StringBuilder(uriInfo.getBaseUri().getScheme()).append("://").append(uriInfo.getBaseUri().getHost())
- .append(portPart).toString();
+ new StringBuilder(uriInfo.getBaseUri().getScheme()).append("://").append(uriInfo.getBaseUri().getHost())
+ .append(portPart).toString();
return basePath;
}
public ApiDeclaration getSwaggerDocSpec(final Module module, final String basePath, final String context,
- final SchemaContext schemaContext) {
+ final SchemaContext schemaContext, final URIType uriType) {
final ApiDeclaration doc = createApiDeclaration(basePath);
final List<Api> apis = new ArrayList<>();
boolean hasAddRootPostLink = false;
- final Collection<DataSchemaNode> dataSchemaNodes = module.getChildNodes();
+ final Collection<? extends DataSchemaNode> dataSchemaNodes = module.getChildNodes();
LOG.debug("child nodes size [{}]", dataSchemaNodes.size());
for (final DataSchemaNode node : dataSchemaNodes) {
if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
hasAddRootPostLink = true;
}
- addApis(node, apis, resourcePath, pathParams, schemaContext, true, module.getName(), "config");
+ addApis(node, apis, resourcePath, pathParams, schemaContext, true, module.getName(), "config",
+ uriType);
}
pathParams = new ArrayList<>();
resourcePath = getDataStorePath("operational", context);
- addApis(node, apis, resourcePath, pathParams, schemaContext, false, module.getName(), "operational");
+ addApis(node, apis, resourcePath, pathParams, schemaContext, false, module.getName(), "operational",
+ uriType);
}
}
- final Set<RpcDefinition> rpcs = module.getRpcs();
- for (final RpcDefinition rpcDefinition : rpcs) {
+ for (final RpcDefinition rpcDefinition : module.getRpcs()) {
final String resourcePath;
resourcePath = getDataStorePath("operations", context);
-
- addRpcs(rpcDefinition, apis, resourcePath, schemaContext);
+ addOperations(rpcDefinition, apis, resourcePath, schemaContext);
}
LOG.debug("Number of APIs found [{}]", apis.size());
models = this.jsonConverter.convertToJsonSchema(module, schemaContext);
doc.setModels(models);
if (LOG.isDebugEnabled()) {
- LOG.debug(this.mapper.writeValueAsString(doc));
+ LOG.debug("Document: {}", this.mapper.writeValueAsString(doc));
}
} catch (IOException e) {
LOG.error("Exception occured in ModelGenerator", e);
}
private void addRootPostLink(final Module module, final DataNodeContainer node,
-
final List<Parameter> pathParams, final String resourcePath, final String dataStore, final List<Api> apis) {
+ final List<Parameter> pathParams, final String resourcePath, final String dataStore, final List<Api> apis) {
if (containsListOrContainer(module.getChildNodes())) {
final Api apiForRootPostUri = new Api();
apiForRootPostUri.setPath(resourcePath.concat(getContent(dataStore)));
apiForRootPostUri.setOperations(operationPost(module.getName() + MODULE_NAME_SUFFIX,
- module.getDescription().orElse(null), module, pathParams, true, ""));
+ module.getDescription().orElse(null), module, pathParams, true, ""));
apis.add(apiForRootPostUri);
}
}
}
private void addApis(final DataSchemaNode node, final List<Api> apis, final String parentPath,
-
final List<Parameter> parentPathParams, final SchemaContext schemaContext, final boolean addConfigApi,
- final String parentName, final String dataStore) {
+ final List<Parameter> parentPathParams, final SchemaContext schemaContext, final boolean addConfigApi,
+ final String parentName, final String dataStore, final URIType uriType) {
final Api api = new Api();
final List<Parameter> pathParams = new ArrayList<>(parentPathParams);
LOG.debug("Adding path: [{}]", resourcePath);
api.setPath(resourcePath.concat(getContent(dataStore)));
- Iterable<DataSchemaNode> childSchemaNodes = Collections.<DataSchemaNode>emptySet();
+ Iterable<? extends DataSchemaNode> childSchemaNodes = Collections.emptySet();
if (node instanceof ListSchemaNode || node instanceof ContainerSchemaNode) {
final DataNodeContainer dataNodeContainer = (DataNodeContainer) node;
childSchemaNodes = dataNodeContainer.getChildNodes();
api.setOperations(operation(node, pathParams, addConfigApi, childSchemaNodes, parentName));
apis.add(api);
+ if (uriType.equals(URIType.RFC8040)) {
+ ((ActionNodeContainer) node).getActions().forEach(actionDef -> {
+ addOperations(actionDef, apis, resourcePath, schemaContext);
+ });
+ }
+
for (final DataSchemaNode childNode : childSchemaNodes) {
if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) {
// keep config and operation attributes separate.
if (childNode.isConfiguration() == addConfigApi) {
final String newParent = parentName + "/" + node.getQName().getLocalName();
addApis(childNode, apis, resourcePath, pathParams, schemaContext, addConfigApi, newParent,
- dataStore);
+ dataStore, uriType);
}
}
}
public abstract String getContent(String dataStore);
- private static boolean containsListOrContainer(final Iterable<DataSchemaNode> nodes) {
+ private static boolean containsListOrContainer(final Iterable<? extends DataSchemaNode> nodes) {
for (final DataSchemaNode child : nodes) {
if (child instanceof ListSchemaNode || child instanceof ContainerSchemaNode) {
return true;
}
private static List<Operation> operation(final DataSchemaNode node, final List<Parameter> pathParams,
- final boolean isConfig, final Iterable<DataSchemaNode> childSchemaNodes, final String parentName) {
+ final boolean isConfig, final Iterable<? extends DataSchemaNode> childSchemaNodes,
+ final String parentName) {
final List<Operation> operations = new ArrayList<>();
final Get getBuilder = new Get(node, isConfig);
final List<QName> listKeys = ((ListSchemaNode) schemaNode).getKeyDefinition();
for (final QName listKey : listKeys) {
final ListPathBuilder keyBuilder = newListPathBuilder();
- final DataSchemaNode dataChildByName = ((DataNodeContainer) schemaNode).getDataChildByName(listKey);
final String pathParamIdentifier = keyBuilder.nextParamIdentifier(listKey.getLocalName());
path.append(pathParamIdentifier);
final Parameter pathParam = new Parameter();
pathParam.setName(listKey.getLocalName());
- pathParam.setDescription(dataChildByName.getDescription().orElse(null));
+
+ ((DataNodeContainer) schemaNode).findDataChildByName(listKey).flatMap(DataSchemaNode::getDescription)
+ .ifPresent(pathParam::setDescription);
+
pathParam.setType("string");
pathParam.setParamType("path");
return path.toString();
}
- protected void add
Rpcs(final RpcDefinition rpcDefn, final List<Api> apis, final String parentPath,
- final SchemaContext schemaContext) {
- final Api rpc = new Api();
- final String resourcePath = parentPath + "/" + resolvePathArgumentsName(rpcDefn, schemaContext);
- rpc.setPath(resourcePath);
+ protected void add
Operations(final OperationDefinition operDef, final List<Api> apis, final String parentPath,
+ final SchemaContext schemaContext) {
+ final Api operationApi = new Api();
+ final String resourcePath = parentPath + "/" + resolvePathArgumentsName(operDef, schemaContext);
+ operationApi.setPath(resourcePath);
final Operation operationSpec = new Operation();
operationSpec.setMethod("POST");
- operationSpec.setNotes(rpcDefn.getDescription().orElse(null));
- operationSpec.setNickname(rpcDefn.getQName().getLocalName());
- if (!rpcDefn.getOutput().getChildNodes().isEmpty()) {
- operationSpec.setType("(" + rpcDefn.getQName().getLocalName() + ")output" + OperationBuilder.TOP);
+ operationSpec.setNotes(operDef.getDescription().orElse(null));
+ operationSpec.setNickname(operDef.getQName().getLocalName());
+ if (!operDef.getOutput().getChildNodes().isEmpty()) {
+ operationSpec.setType("(" + operDef.getQName().getLocalName() + ")output" + OperationBuilder.TOP);
}
- if (!rpcDefn.getInput().getChildNodes().isEmpty()) {
+ if (!operDef.getInput().getChildNodes().isEmpty()) {
final Parameter payload = new Parameter();
payload.setParamType("body");
- payload.setType("(" + rpcDefn.getQName().getLocalName() + ")input" + OperationBuilder.TOP);
+ payload.setType("(" + operDef.getQName().getLocalName() + ")input" + OperationBuilder.TOP);
operationSpec.setParameters(Collections.singletonList(payload));
operationSpec.setConsumes(OperationBuilder.CONSUMES_PUT_POST);
}
-
- rpc.setOperations(Arrays.asList(operationSpec));
-
- apis.add(rpc);
+ operationApi.setOperations(Arrays.asList(operationSpec));
+ apis.add(operationApi);
}
protected SortedSet<Module> getSortedModules(final SchemaContext schemaContext) {
return new TreeSet<>();
}
- final Set<Module> modules = schemaContext.getModules();
-
final SortedSet<Module> sortedModules = new TreeSet<>((module1, module2) -> {
int result = module1.getName().compareTo(module2.getName());
if (result == 0) {
}
return result;
});
- for (final Module m : modules) {
+ for (final Module m : schemaContext.getModules()) {
if (m != null) {
sortedModules.add(m);
}
final String name = arg.getNodeType().getLocalName();
if (arg instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates) {
final NodeIdentifierWithPredicates nodeId = (NodeIdentifierWithPredicates) arg;
- for (final Entry<QName, Object> entry : nodeId.getKeyValues().entrySet()) {
+ for (final Entry<QName, Object> entry : nodeId.entrySet()) {
appendPathKeyValue(builder, entry.getValue());
}
} else {
Code Review / netconf.git / blobdiff