org.apache.juneau.http.annotation.Contact Maven / Gradle / Ivy

Go to download
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you 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.apache.juneau.http.annotation;

import static java.lang.annotation.RetentionPolicy.*;

import java.lang.annotation.*;

/**
 * Swagger contact annotation.
 *
 * 
 * The contact information for the exposed API.
 *
 * 

 * Used to populate the auto-generated Swagger documentation and UI for server-side @Rest-annotated classes.
 *
 * 
Example:
 * 
 * 	@Swagger(
 * 		contact=@Contact(
 * 			name="Juneau Development Team",
 * 			email="[email protected]",
 * 			url="http://juneau.apache.org"
 * 		)
 * 	)
 * 
 *
 * See Also:

 * 	Swagger
 * 	
Swagger Contact Object

 * 
 */
@Documented
@Retention(RUNTIME)
public @interface Contact {

	/**
	 * email field of the Swagger Contact Object.
	 *
	 * 
	 * The email address of the contact person/organization. MUST be in the format of an email address.
	 *
	 * 
Notes:

	 * 	
	 * 		The format is an email string.
	 * 	

	 * 		Supports SVL Variables (e.g. "$L{my.localized.variable}") for the swagger generator.
	 * 
	 *
	 * @return The annotation value.
	 */
	String email() default "";

	/**
	 * name field of the Swagger Contact Object.
	 *
	 * 
	 * The identifying name of the contact person/organization.
	 *
	 * 
Notes:

	 * 	
	 * 		The format is a plain-text string.
	 * 	

	 * 		Supports SVL Variables (e.g. "$L{my.localized.variable}") for the swagger generator.
	 * 
	 *
	 * @return The annotation value.
	 */
	String name() default "";

	/**
	 * url field of the Swagger Contact Object.
	 *
	 * 
	 * The URL pointing to the contact information. MUST be in the format of a URL.
	 *
	 * 
Notes:

	 * 	
	 * 		The format is a URL string.
	 * 	

	 * 		Supports SVL Variables
	 * 		(e.g. "$L{my.localized.variable}").
	 * 
	 *
	 * @return The annotation value.
	 */
	String url() default "";
}