/** * ============LICENSE_START======================================================= * org.onap.aai * ================================================================================ * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. * ================================================================================ * Modifications Copyright © 2018 IBM. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * ============LICENSE_END========================================================= */ package org.onap.aai.schemagen.genxsd; import org.apache.commons.lang3.StringUtils; import org.onap.aai.setup.SchemaVersion; import org.onap.aai.schemagen.GenerateXsd; public class PutOperation { public static final String RELATIONSHIP = "relationship"; private String useOpId; private String xmlRootElementName; private String tag; private String path; private String pathParams; private SchemaVersion version; private String basePath; public PutOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams, SchemaVersion v, String basePath) { super(); this.useOpId = useOpId; this.xmlRootElementName = xmlRootElementName; this.tag = tag; this.path = path; this.pathParams = pathParams; this.version = v; this.basePath = basePath; } @Override public String toString() { //a valid tag is necessary if ( StringUtils.isEmpty(tag) ) { return ""; } //All Put operation paths end with "relationship" //or there is a parameter at the end of the path //and there is a parameter in the path if ( path.contains("/"+RELATIONSHIP+"/") ) { // filter paths with relationship-list return ""; } if ( path.endsWith("/"+RELATIONSHIP+"-list")) { return ""; } if ( !path.endsWith("/"+RELATIONSHIP) && !path.endsWith("}") ) { return ""; } if ( path.startsWith("/search")) { return ""; } StringBuffer pathSb = new StringBuffer(); StringBuffer relationshipExamplesSb = new StringBuffer(); if ( path.endsWith("/"+RELATIONSHIP) ) { pathSb.append(" " + path + ":\n" ); } pathSb.append(" put:\n"); pathSb.append(" tags:\n"); pathSb.append(" - " + tag + "\n"); if ( path.endsWith("/"+RELATIONSHIP) ) { pathSb.append(" summary: see node definition for valid relationships\n"); } else { pathSb.append(" summary: create or update an existing " + xmlRootElementName + "\n"); pathSb.append(" description: |\n Create or update an existing " + xmlRootElementName + ".\n #\n Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below\n"); } relationshipExamplesSb.append("[Valid relationship examples shown here](apidocs" + basePath + "/relations/"+version.toString()+"/"+useOpId.replace("RelationshipListRelationship", "")+".json)"); pathSb.append(" operationId: createOrUpdate" + useOpId + "\n"); pathSb.append(" consumes:\n"); pathSb.append(" - application/json\n"); pathSb.append(" - application/xml\n"); pathSb.append(" produces:\n"); pathSb.append(" - application/json\n"); pathSb.append(" - application/xml\n"); pathSb.append(" responses:\n"); pathSb.append(" \"default\":\n"); pathSb.append(" " + GenerateXsd.getResponsesUrl()); pathSb.append(" parameters:\n"); pathSb.append(pathParams); // for nesting pathSb.append(" - name: body\n"); pathSb.append(" in: body\n"); pathSb.append(" description: " + xmlRootElementName + " object that needs to be created or updated. "+relationshipExamplesSb.toString()+"\n"); pathSb.append(" required: true\n"); pathSb.append(" schema:\n"); String useElement = xmlRootElementName; if ( xmlRootElementName.equals("relationship")) { useElement += "-dict"; } pathSb.append(" $ref: \"#/definitions/" + useElement + "\"\n"); this.tagRelationshipPathMapEntry(); return pathSb.toString(); } public String tagRelationshipPathMapEntry() { if ( path.endsWith("/"+RELATIONSHIP) ) { PutRelationPathSet.add(useOpId, path); } return ""; } }