oas-validator/oas-validator-style/src/main/java/org/apache/servicecomb/toolkit/oasv/style/validator/operation/OperationSummaryRequiredValidator.java

/*
 * 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.style.validator.operation;

import org.apache.servicecomb.toolkit.oasv.common.OasObjectType;
import org.apache.servicecomb.toolkit.oasv.validation.api.OperationValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.ObjectPropertyRequiredValidator;
import io.swagger.v3.oas.models.Operation;

/**
 * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
 * .summary required validator
 * <ul>
 *   <li>config item: operation.summary.required=*boolean*</li>
 *   <li>this field is required</li>
 * </ul>
 */
public class OperationSummaryRequiredValidator
  extends ObjectPropertyRequiredValidator<Operation, String>
  implements OperationValidator {

  public static final String CONFIG_KEY = "operation.summary.required";

  @Override
  protected String get$ref(Operation oasObject) {
    return null;
  }

  @Override
  protected String getPropertyObject(Operation oasObject) {
    return oasObject.getSummary();
  }

  @Override
  protected String getPropertyName() {
    return "summary";
  }

  @Override
  protected OasObjectType getPropertyType() {
    return null;
  }

}