org.eclipse.microprofile.openapi.annotations.callbacks.Callback Maven / Gradle / Ivy
/**
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* 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 org.eclipse.microprofile.openapi.annotations.callbacks;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.eclipse.microprofile.openapi.annotations.extensions.Extension;
/**
* This object represents a callback URL that will be invoked.
*
* @see OpenAPI Specification Callback Object
**/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Callbacks.class)
@Inherited
public @interface Callback {
/**
* The friendly name used to refer to this callback. It is a REQUIRED property unless this is only a reference to a
* callback.
*
* The name is REQUIRED when the callback is defined within
* {@link org.eclipse.microprofile.openapi.annotations.Components}. The name will be used as the key to add this
* callback to the 'callbacks' map for reuse.
*
*
* @return the name of this callback
**/
String name() default "";
/**
* An absolute URL which defines the destination which will be called with the supplied operation definition.
*
* It is a REQUIRED property unless this is only a reference to a callback instance.
*
*
* @return the callback URL
*/
String callbackUrlExpression() default "";
/**
* The array of operations that will be called out-of band
*
* @return the callback operations
**/
CallbackOperation[] operations() default {};
/**
* Reference value to a Callback object.
*
* This property provides a reference to an object defined elsewhere. This property and all other properties are
* mutually exclusive. If other properties are defined in addition to the {@code ref} property then the result is
* undefined.
*
* @return reference to a callback object definition
**/
String ref() default "";
/**
* Reference value to a Path Item object, to be referenced by the Callback object.
*
* This property provides a reference to a Path Item object defined elsewhere. {@code #callbackUrlExpression()} is
* REQUIRED when this property is set. The referenced Path Item will be used for the URL expression specified.
*
* @since 4.0
*/
String pathItemRef() default "";
/**
* List of extensions to be added to the {@link org.eclipse.microprofile.openapi.models.callbacks.Callback Callback}
* model corresponding to the containing annotation.
*
* @return array of extensions
*
* @since 3.1
*/
Extension[] extensions() default {};
}