restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/model/builder/OperationBuilder.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.netconf.sal.rest.doc.model.builder;
  10
  11 import static org.opendaylight.netconf.sal.rest.doc.impl.DefinitionGenerator.INPUT;
  12 import static org.opendaylight.netconf.sal.rest.doc.impl.DefinitionGenerator.INPUT_SUFFIX;
  13 import static org.opendaylight.netconf.sal.rest.doc.impl.DefinitionGenerator.OUTPUT_SUFFIX;
  14
  15 import com.fasterxml.jackson.databind.node.ArrayNode;
  16 import com.fasterxml.jackson.databind.node.JsonNodeFactory;
  17 import com.fasterxml.jackson.databind.node.ObjectNode;
  18 import com.google.common.collect.ImmutableList;
  19 import java.util.List;
  20 import java.util.Optional;
  21 import javax.ws.rs.HttpMethod;
  22 import javax.ws.rs.core.MediaType;
  23 import javax.ws.rs.core.Response;
  24 import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl;
  25 import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.OAversion;
  26 import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.URIType;
  27 import org.opendaylight.netconf.sal.rest.doc.impl.DefinitionNames;
  28 import org.opendaylight.netconf.sal.rest.doc.util.JsonUtil;
  29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
  32
  33 public final class OperationBuilder {
  34     public static final String BODY = "body";
  35     public static final String CONFIG = "_config";
  36     public static final String CONFIG_QUERY_PARAM = "config";
  37     public static final String CONSUMES_KEY = "consumes";
  38     public static final String CONTENT_KEY = "content";
  39     public static final String COMPONENTS_PREFIX = "#/components/schemas/";
  40     public static final String DEFINITIONS_PREFIX = "#/definitions/";
  41     public static final String DESCRIPTION_KEY = "description";
  42     public static final String IN_KEY = "in";
  43     public static final String INPUT_KEY = "input";
  44     public static final String NAME_KEY = "name";
  45     public static final String NONCONFIG_QUERY_PARAM = "nonconfig";
  46     public static final String PARAMETERS_KEY = "parameters";
  47     public static final String POST_SUFFIX = "_post";
  48     public static final String PROPERTIES_KEY = "properties";
  49     public static final String REF_KEY = "$ref";
  50     public static final String REQUEST_BODY_KEY = "requestBody";
  51     public static final String RESPONSES_KEY = "responses";
  52     public static final String SCHEMA_KEY = "schema";
  53     public static final String SUMMARY_KEY = "summary";
  54     public static final String SUMMARY_SEPARATOR = " - ";
  55     public static final String TAGS_KEY = "tags";
  56     public static final String TOP = "_TOP";
  57     public static final String XML_KEY = "xml";
  58     public static final String XML_SUFFIX = "_xml";
  59     private static final String CONTENT = "content";
  60     private static final ArrayNode CONSUMES_PUT_POST;
  61     private static final String ENUM_KEY = "enum";
  62     private static final List<String> MIME_TYPES = ImmutableList.of(MediaType.APPLICATION_XML,
  63             MediaType.APPLICATION_JSON);
  64     private static final String OBJECT = "object";
  65     private static final String REQUIRED_KEY = "required";
  66     private static final String STRING = "string";
  67     private static final String TYPE_KEY = "type";
  68     private static final String QUERY = "query";
  69
  70     static {
  71         CONSUMES_PUT_POST = JsonNodeFactory.instance.arrayNode();
  72         for (final String mimeType : MIME_TYPES) {
  73             CONSUMES_PUT_POST.add(mimeType);
  74         }
  75     }
  76
  77     private OperationBuilder() {
  78
  79     }
  80
  81     public static ObjectNode buildPost(final String parentName, final String nodeName, final String discriminator,
  82                                        final String moduleName, final Optional<String> deviceName,
  83                                        final String description, final ArrayNode pathParams,
  84                                        final OAversion oaversion) {
  85         final ObjectNode value = JsonNodeFactory.instance.objectNode();
  86         value.put(DESCRIPTION_KEY, description);
  87         value.put(SUMMARY_KEY, buildSummaryValue(HttpMethod.POST, moduleName, deviceName, nodeName));
  88         value.set(TAGS_KEY, buildTagsValue(deviceName, moduleName));
  89         final ArrayNode parameters = JsonUtil.copy(pathParams);
  90         final ObjectNode ref = JsonNodeFactory.instance.objectNode();
  91         final String cleanDefName = parentName + CONFIG + "_" + nodeName + POST_SUFFIX;
  92         final String defName = cleanDefName + discriminator;
  93         final String xmlDefName = cleanDefName + XML_SUFFIX + discriminator;
  94         ref.put(REF_KEY, getAppropriateModelPrefix(oaversion) + defName);
  95         insertRequestBodyParameter(parameters, value, defName, xmlDefName, nodeName + CONFIG, oaversion);
  96         value.set(PARAMETERS_KEY, parameters);
  97
  98         final ObjectNode responses = JsonNodeFactory.instance.objectNode();
  99         responses.set(String.valueOf(Response.Status.CREATED.getStatusCode()),
 100                 buildResponse(Response.Status.CREATED.getReasonPhrase(), Optional.empty(), oaversion));
 101
 102         value.set(RESPONSES_KEY, responses);
 103         setConsumesIfNeeded(value, oaversion);
 104         return value;
 105     }
 106
 107     public static ObjectNode buildGet(final DataSchemaNode node, final String moduleName,
 108                                       final Optional<String> deviceName, final ArrayNode pathParams,
 109                                       final String defName, final boolean isConfig,
 110                                       final URIType uriType, final OAversion oaversion) {
 111         final ObjectNode value = JsonNodeFactory.instance.objectNode();
 112         value.put(DESCRIPTION_KEY, node.getDescription().orElse(""));
 113         value.put(SUMMARY_KEY, buildSummaryValue(HttpMethod.GET, moduleName, deviceName,
 114                 node.getQName().getLocalName()));
 115         value.set(TAGS_KEY, buildTagsValue(deviceName, moduleName));
 116         final ArrayNode parameters = JsonUtil.copy(pathParams);
 117
 118         addQueryParameters(parameters, isConfig, uriType, oaversion);
 119
 120         value.set(PARAMETERS_KEY, parameters);
 121
 122         final ObjectNode responses = JsonNodeFactory.instance.objectNode();
 123         final ObjectNode schema = JsonNodeFactory.instance.objectNode();
 124         schema.put(REF_KEY, getAppropriateModelPrefix(oaversion) + defName);
 125         responses.set(String.valueOf(Response.Status.OK.getStatusCode()),
 126                 buildResponse(Response.Status.OK.getReasonPhrase(), Optional.of(schema), oaversion));
 127
 128         value.set(RESPONSES_KEY, responses);
 129         return value;
 130     }
 131
 132     private static void addQueryParameters(final ArrayNode parameters, final boolean isConfig,
 133                                            final ApiDocServiceImpl.URIType uriType, final OAversion oaversion) {
 134         if (uriType.equals(ApiDocServiceImpl.URIType.RFC8040)) {
 135             final ObjectNode contentParam = JsonNodeFactory.instance.objectNode();
 136             final ArrayNode cases = JsonNodeFactory.instance.arrayNode();
 137             cases.add(NONCONFIG_QUERY_PARAM);
 138             if (isConfig) {
 139                 cases.add(CONFIG_QUERY_PARAM);
 140             } else {
 141                 contentParam.put(REQUIRED_KEY, true);
 142             }
 143             contentParam.put(IN_KEY, QUERY);
 144             contentParam.put(NAME_KEY, CONTENT);
 145
 146             final ObjectNode typeParent = getTypeParentNode(contentParam, oaversion);
 147             typeParent.put(TYPE_KEY, STRING);
 148             typeParent.set(ENUM_KEY, cases);
 149
 150             parameters.add(contentParam);
 151         }
 152     }
 153
 154     public static ObjectNode buildPut(final String parentName, final String nodeName, final String discriminator,
 155                                       final String moduleName, final Optional<String> deviceName,
 156                                       final String description, final ArrayNode pathParams,
 157                                       final OAversion oaversion) {
 158         final ObjectNode value = JsonNodeFactory.instance.objectNode();
 159         value.put(DESCRIPTION_KEY, description);
 160         value.put(SUMMARY_KEY, buildSummaryValue(HttpMethod.PUT, moduleName, deviceName, nodeName));
 161         value.set(TAGS_KEY, buildTagsValue(deviceName, moduleName));
 162         final ArrayNode parameters = JsonUtil.copy(pathParams);
 163         final String defName = parentName + CONFIG + "_" + nodeName + TOP;
 164         final String xmlDefName = parentName + CONFIG + "_" + nodeName;
 165         insertRequestBodyParameter(parameters, value, defName, xmlDefName, nodeName + CONFIG, oaversion);
 166         value.set(PARAMETERS_KEY, parameters);
 167
 168         final ObjectNode responses = JsonNodeFactory.instance.objectNode();
 169         responses.set(String.valueOf(Response.Status.CREATED.getStatusCode()),
 170                 buildResponse(Response.Status.CREATED.getReasonPhrase(), Optional.empty(), oaversion));
 171         responses.set(String.valueOf(Response.Status.NO_CONTENT.getStatusCode()),
 172                 buildResponse("Updated", Optional.empty(), oaversion));
 173
 174         value.set(RESPONSES_KEY, responses);
 175         setConsumesIfNeeded(value, oaversion);
 176         return value;
 177     }
 178
 179     public static ObjectNode buildDelete(final DataSchemaNode node, final String moduleName,
 180                                          final Optional<String> deviceName, final ArrayNode pathParams,
 181                                          final OAversion oaversion) {
 182         final ObjectNode value = JsonNodeFactory.instance.objectNode();
 183         value.put(SUMMARY_KEY, buildSummaryValue(HttpMethod.DELETE, moduleName, deviceName,
 184                 node.getQName().getLocalName()));
 185         value.set(TAGS_KEY, buildTagsValue(deviceName, moduleName));
 186         value.put(DESCRIPTION_KEY, node.getDescription().orElse(""));
 187         final ArrayNode parameters = JsonUtil.copy(pathParams);
 188         value.set(PARAMETERS_KEY, parameters);
 189
 190         final ObjectNode responses = JsonNodeFactory.instance.objectNode();
 191         responses.set(String.valueOf(Response.Status.NO_CONTENT.getStatusCode()),
 192                 buildResponse("Deleted", Optional.empty(), oaversion));
 193
 194         value.set(RESPONSES_KEY, responses);
 195         return value;
 196     }
 197
 198     public static ObjectNode buildPostOperation(final OperationDefinition operDef, final String moduleName,
 199                                                 final Optional<String> deviceName, final String parentName,
 200                                                 final DefinitionNames definitionNames, final OAversion oaversion) {
 201         final ObjectNode postOperation = JsonNodeFactory.instance.objectNode();
 202         final ArrayNode parameters = JsonNodeFactory.instance.arrayNode();
 203         final String operName = operDef.getQName().getLocalName();
 204         final String inputName = operName + INPUT_SUFFIX;
 205
 206         final ContainerSchemaNode input = operDef.getInput();
 207         final ContainerSchemaNode output = operDef.getOutput();
 208         if (!input.getChildNodes().isEmpty()) {
 209             final String discriminator = definitionNames.getDiscriminator(input);
 210             final String clearDefName = parentName + "_" + operName + INPUT_SUFFIX;
 211             final String defName = clearDefName + discriminator;
 212             final String defTopName = clearDefName + TOP + discriminator;
 213             insertRequestBodyParameter(parameters, postOperation, defTopName, defName, inputName, oaversion);
 214         } else {
 215             final ObjectNode payload = JsonNodeFactory.instance.objectNode();
 216             final ObjectNode jsonSchema = JsonNodeFactory.instance.objectNode();
 217             final ObjectNode properties = JsonNodeFactory.instance.objectNode();
 218             final ObjectNode inputSchema = JsonNodeFactory.instance.objectNode();
 219             inputSchema.put(TYPE_KEY, OBJECT);
 220             properties.set(INPUT_KEY, inputSchema);
 221             jsonSchema.put(TYPE_KEY, OBJECT);
 222             jsonSchema.set(PROPERTIES_KEY, properties);
 223             if (oaversion.equals(OAversion.V3_0)) {
 224                 final ObjectNode content = JsonNodeFactory.instance.objectNode();
 225                 final ObjectNode jsonTypeValue = JsonNodeFactory.instance.objectNode();
 226                 jsonTypeValue.set(SCHEMA_KEY, jsonSchema);
 227                 content.set(MediaType.APPLICATION_JSON, jsonTypeValue);
 228
 229                 final ObjectNode xmlSchema = JsonNodeFactory.instance.objectNode();
 230                 xmlSchema.put(TYPE_KEY, OBJECT);
 231                 final ObjectNode xml = JsonNodeFactory.instance.objectNode();
 232                 xml.put(NAME_KEY, INPUT);
 233                 xmlSchema.set(XML_KEY, xml);
 234                 final ObjectNode xmlTypeValue = JsonNodeFactory.instance.objectNode();
 235                 xmlTypeValue.set(SCHEMA_KEY, xmlSchema);
 236                 content.set(MediaType.APPLICATION_XML, xmlTypeValue);
 237
 238                 payload.set(CONTENT_KEY, content);
 239                 payload.put(DESCRIPTION_KEY, inputName);
 240                 postOperation.set(REQUEST_BODY_KEY, payload);
 241             } else {
 242                 payload.put(IN_KEY, BODY);
 243                 payload.put(NAME_KEY, inputName);
 244                 payload.set(SCHEMA_KEY, jsonSchema);
 245                 parameters.add(payload);
 246             }
 247
 248         }
 249         setConsumesIfNeeded(postOperation, oaversion);
 250         postOperation.set(PARAMETERS_KEY, parameters);
 251         final ObjectNode responses = JsonNodeFactory.instance.objectNode();
 252         final String description = String.format("RPC %s success", operName);
 253
 254         if (!output.getChildNodes().isEmpty()) {
 255             final ObjectNode schema = JsonNodeFactory.instance.objectNode();
 256             final String defName = parentName + "_" + operName + OUTPUT_SUFFIX + TOP
 257                     + definitionNames.getDiscriminator(output);
 258             schema.put(REF_KEY, getAppropriateModelPrefix(oaversion) + defName);
 259             responses.set(String.valueOf(Response.Status.OK.getStatusCode()), buildResponse(description,
 260                     Optional.of(schema), oaversion));
 261         } else {
 262             responses.set(String.valueOf(Response.Status.NO_CONTENT.getStatusCode()), buildResponse(description,
 263                     Optional.empty(), oaversion));
 264         }
 265         postOperation.set(RESPONSES_KEY, responses);
 266         postOperation.put(DESCRIPTION_KEY, operDef.getDescription().orElse(""));
 267         postOperation.put(SUMMARY_KEY, buildSummaryValue(HttpMethod.POST, moduleName, deviceName, operName));
 268         postOperation.set(TAGS_KEY, buildTagsValue(deviceName, moduleName));
 269         return postOperation;
 270     }
 271
 272     private static void insertRequestBodyParameter(final ArrayNode parameters, final ObjectNode operation,
 273                                                    final String defName, final String xmlDefName,
 274                                                    final String name, final OAversion oaversion) {
 275         final ObjectNode payload = JsonNodeFactory.instance.objectNode();
 276         if (oaversion.equals(OAversion.V3_0)) {
 277             final ObjectNode content = JsonNodeFactory.instance.objectNode();
 278             content.set(MediaType.APPLICATION_JSON, buildMimeTypeValue(defName));
 279             content.set(MediaType.APPLICATION_XML, buildMimeTypeValue(xmlDefName));
 280             payload.set(CONTENT_KEY, content);
 281             payload.put(DESCRIPTION_KEY, name);
 282             operation.set(REQUEST_BODY_KEY, payload);
 283         } else {
 284             payload.put(IN_KEY, BODY);
 285             payload.put(NAME_KEY, name);
 286             payload.set(SCHEMA_KEY, buildRefSchema(defName, OAversion.V2_0));
 287             parameters.add(payload);
 288         }
 289     }
 290
 291     private static ObjectNode buildRefSchema(final String defName, final OAversion oaversion) {
 292         final ObjectNode schema = JsonNodeFactory.instance.objectNode();
 293         schema.put(REF_KEY, getAppropriateModelPrefix(oaversion) + defName);
 294         return schema;
 295     }
 296
 297     private static ObjectNode buildMimeTypeValue(final String defName) {
 298         final ObjectNode mimeTypeValue = JsonNodeFactory.instance.objectNode();
 299         mimeTypeValue.set(SCHEMA_KEY, buildRefSchema(defName, OAversion.V3_0));
 300         return mimeTypeValue;
 301     }
 302
 303     public static ObjectNode buildResponse(final String description, final Optional<ObjectNode> schema,
 304                                            final OAversion oaversion) {
 305         final ObjectNode response = JsonNodeFactory.instance.objectNode();
 306
 307         if (schema.isPresent()) {
 308             final ObjectNode schemaValue = schema.get();
 309             if (oaversion.equals(OAversion.V3_0)) {
 310                 final ObjectNode content = JsonNodeFactory.instance.objectNode();
 311                 final ObjectNode body = JsonNodeFactory.instance.objectNode();
 312                 for (final String mimeType : MIME_TYPES) {
 313                     content.set(mimeType, body);
 314                 }
 315                 body.set(SCHEMA_KEY, schemaValue);
 316                 response.set(CONTENT_KEY, content);
 317             } else {
 318                 response.set(SCHEMA_KEY, schemaValue);
 319             }
 320         }
 321         response.put(DESCRIPTION_KEY, description);
 322         return response;
 323     }
 324
 325     private static void setConsumesIfNeeded(final ObjectNode operation, final OAversion oaversion) {
 326         if (oaversion.equals(OAversion.V2_0)) {
 327             operation.set(CONSUMES_KEY, CONSUMES_PUT_POST);
 328         }
 329     }
 330
 331     private static String buildSummaryValue(final String httpMethod, final String moduleName,
 332                                             final Optional<String> deviceName, final String nodeName) {
 333         return httpMethod + SUMMARY_SEPARATOR + (deviceName.map(s -> s + SUMMARY_SEPARATOR).orElse(""))
 334                 + moduleName + SUMMARY_SEPARATOR + nodeName;
 335     }
 336
 337     public static ArrayNode buildTagsValue(final Optional<String> deviceName, final String moduleName) {
 338         final ArrayNode tagsValue = JsonNodeFactory.instance.arrayNode();
 339         tagsValue.add((deviceName.map(s -> "mounted " + s).orElse("controller")) + " " + moduleName);
 340         return tagsValue;
 341     }
 342
 343     public static String getAppropriateModelPrefix(final OAversion oaversion) {
 344         if (oaversion.equals(OAversion.V3_0)) {
 345             return COMPONENTS_PREFIX;
 346         }
 347         return DEFINITIONS_PREFIX;
 348     }
 349
 350     public static ObjectNode getTypeParentNode(final ObjectNode parameter, final OAversion oaversion) {
 351         if (oaversion.equals(OAversion.V3_0)) {
 352             final ObjectNode schema = JsonNodeFactory.instance.objectNode();
 353             parameter.set(SCHEMA_KEY, schema);
 354             return schema;
 355         }
 356         return parameter;
 357     }
 358 }