io.apicurio.datamodels.openapi.models.IOasParameterParent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of data-models-test Show documentation

Open Source API Design Studio

There is a newer version: 3.5.0.Final

/*
 * 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.openapi.models;

import java.util.List;

/**
 * @author [email protected]
 */
public interface IOasParameterParent {
    
    /**
     * Gets the parameters.
     */
    public List getParameters();
    
    /**
     * Gets all parameter for a location (path, query, etc).
     * @param in
     */
    public List getParametersIn(String in);

    /**
     * Adds a parameter.
     * @param parameter
     */
    public OasParameter addParameter(OasParameter parameter);
    
    /**
     * Creates a parameter.
     */
    public OasParameter createParameter();

    /**
     * Gets a single parameter by its unique combination of "in" and "name".
     * @param _in
     * @param name
     */
    public OasParameter getParameter(String _in, String name);

}