io.swagger.v3.oas.annotations.media.ExampleObject 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 io.swagger.v3.oas.annotations.extensions.Extension;
import java.lang.annotation.ElementType;
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 to add one or more examples to the definition of a parameter, request or response content,
* by defining it as field {@link io.swagger.v3.oas.annotations.Parameter#examples()} or {@link Content#examples()}
*
* @see Example (OpenAPI specification)
**/
@Target({ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ExampleObject {
/**
* A unique name to identify this particular example
*
* @return the name of the example
**/
String name() default "";
/**
* A brief summary of the purpose or context of the example
*
* @return a summary of the example
**/
String summary() default "";
/**
* A string representation of the example. This is mutually exclusive with the externalValue property, and ignored if the externalValue property is specified. If the media type associated with the example allows parsing into an object, it may be converted from a string
*
* @return the value of the example
**/
String value() default "";
/**
* A URL to point to an external document to be used as an example. This is mutually exclusive with the value property.
*
* @return an external URL of the example
**/
String externalValue() default "";
/**
* The list of optional extensions
*
* @return an optional array of extensions
*/
Extension[] extensions() default {};
/**
* A reference to a example defined in components examples.
*
* @since 2.0.3
* @return the reference
**/
String ref() default "";
}