io.swagger.v3.oas.annotations.media.DiscriminatorMapping Maven / Gradle / Ivy
/**
* Copyright 2017 SmartBear Software
*
* 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.swagger.v3.oas.annotations.media;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The annotation may be used in {@link Schema#discriminatorMapping()} to define an optional mapping definition
* in scenarios involving composition / inheritance where the value of the discriminator field does not match the schema
* name or implicit mapping is not possible.
*
*
Use {@link Schema#discriminatorProperty()} to define a discriminator property.
*
* @see Discriminator (OpenAPI specification)
* @see Schema
**/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface DiscriminatorMapping {
/**
* The property value that will be mapped to a Schema
*
* @return the property value
**/
String value() default "";
/**
* The schema that is being mapped to a property value
*
* @return the Schema reference
**/
Class schema() default Void.class;
}