blob: a07a552b1c218d1e7c86cf6d9bf0c810a168acf9 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.servicecomb.toolkit.oasv.diffvalidation.api;
import org.apache.servicecomb.toolkit.oasv.diffvalidation.skeleton.schema.SchemaDiffValidatorEngine;
import org.apache.servicecomb.toolkit.oasv.common.OasObjectPropertyLocation;
import io.swagger.v3.oas.models.media.Schema;
import java.util.List;
public interface SchemaCompareValidator {
/**
* validate the modification situation, both left side and right side right exists.
* <p>
* there is no need to check <code>allOf, anyOf, oneOf, items, properties</code>
* </p>
* they will be recursively checked by {@link SchemaDiffValidatorEngine}
*
* @param context
* @param leftLocation
* @param leftOasObject
* @param rightLocation
* @param rightOasObject
* @return
*/
List<OasDiffViolation> validate(OasDiffValidationContext context,
OasObjectPropertyLocation leftLocation, Schema leftOasObject,
OasObjectPropertyLocation rightLocation, Schema rightOasObject);
}