org.eclipse.microprofile.openapi.annotations.info.Contact 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.info;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.eclipse.microprofile.openapi.annotations.extensions.Extension;
/**
* Contact information for the exposed API.
*
* @see OpenAPI Specification Contact Object
**/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Contact {
/**
* The identifying name of the contact person/organization.
*
* @return the name of the contact
**/
String name() default "";
/**
* The URL pointing to the contact information. Must be in the format of a URL.
*
* @return the URL of the contact
**/
String url() default "";
/**
* The email address of the contact person/organization. Must be in the format of an email address.
*
* @return the email address of the contact
**/
String email() default "";
/**
* List of extensions to be added to the {@link org.eclipse.microprofile.openapi.models.info.Contact Contact} model
* corresponding to the containing annotation.
*
* @return array of extensions
*
* @since 3.1
*/
Extension[] extensions() default {};
}