io.apicurio.datamodels.validation.rules.other.OasIgnoredHeaderParameterRule Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 Red Hat
 *
 * 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.
 */

package io.apicurio.datamodels.validation.rules.other;

import io.apicurio.datamodels.models.Parameter;
import io.apicurio.datamodels.models.openapi.OpenApiParameter;
import io.apicurio.datamodels.validation.ValidationRule;
import io.apicurio.datamodels.validation.ValidationRuleMetaData;

/**
 * @author [email protected]
 */
public class OasIgnoredHeaderParameterRule extends ValidationRule {

    private static String[] ignoredHeaderNames = {
            "content-type", "accept", "authorization"
    };

    /**
     * Constructor.
     * @param ruleInfo
     */
    public OasIgnoredHeaderParameterRule(ValidationRuleMetaData ruleInfo) {
        super(ruleInfo);
    }

    /**
     * @see io.apicurio.datamodels.models.visitors.CombinedVisitorAdapter#visitParameter(io.apicurio.datamodels.models.Parameter)
     */
    @Override
    public void visitParameter(Parameter node) {
        OpenApiParameter param = (OpenApiParameter) node;
        if (hasValue(param.getName())) {
            boolean ignored = isValidEnumItem(param.getName().toLowerCase(), OasIgnoredHeaderParameterRule.ignoredHeaderNames);
            this.reportIf(ignored, node, "name", map("name", param.getName()));
        }
    }

}