restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/BaseYangOpenApiGeneratorRFC8040.java

   1 /*
   2  * Copyright (c) 2018 Inocybe Technologies 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 package org.opendaylight.netconf.sal.rest.doc.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.util.Optional;
  13 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  14
  15 /**
  16  * Base class for an RFC 8040 implementation.
  17  *
  18  * @author Thomas Pantelis
  19  */
  20 public abstract class BaseYangOpenApiGeneratorRFC8040 extends BaseYangOpenApiGenerator {
  21     private final String basePath;
  22
  23     protected BaseYangOpenApiGeneratorRFC8040(final Optional<DOMSchemaService> schemaService) {
  24         this(schemaService, "rests");
  25     }
  26
  27     protected BaseYangOpenApiGeneratorRFC8040(final Optional<DOMSchemaService> schemaService, final String basePath) {
  28         super(schemaService);
  29         this.basePath = requireNonNull(basePath);
  30     }
  31
  32     @Override
  33     public String getResourcePath(final String resourceType, final String context) {
  34         if ("data".equals(resourceType)) {
  35             return "/" + basePath + "/data" + context;
  36         }
  37         return "/" + basePath + "/operations" + context;
  38     }
  39
  40     @Override
  41     protected ListPathBuilder newListPathBuilder() {
  42         return new ListPathBuilder() {
  43             private String prefix = "=";
  44
  45             @Override
  46             public String nextParamIdentifier(final String key) {
  47                 final String str = prefix + "{" + key + "}";
  48                 prefix = ",";
  49                 return str;
  50             }
  51         };
  52     }
  53
  54     @Override
  55     protected void appendPathKeyValue(final StringBuilder builder, final Object value) {
  56         builder.deleteCharAt(builder.length() - 1).append("=").append(value).append('/');
  57     }
  58 }