org.apache.juneau.annotation.ExternalDocs 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.annotation;

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

import java.lang.annotation.*;

/**
 * Swagger external documentation annotation.
 *
 * 
 * Allows referencing an external resource for extended documentation.
 *
 * 

 * Used to populate the auto-generated Swagger documentation and UI for server-side @Rest-annotated classes.
 *
 * 
Example:
 * 
 * 	@Swagger(
 * 		externalDocs=@ExternalDocs(
 * 			description="Apache Juneau",
 * 			url="http://juneau.apache.org"
 * 		)
 * 	)
 * 
 *
 * See Also:

 * 	Swagger
 * 	
Swagger ExternalDocumentation Object
 * 
 */
@Documented
@Retention(RUNTIME)
public @interface ExternalDocs {

	/**
	 * description field of the Swagger ExternalDocumentation Object.
	 *
	 * 
	 * A short description of the target documentation.
	 *
	 * 
Notes:

	 * 	
	 * 		The format is a plain-text string.
	 * 		
Multiple lines are concatenated with newlines.
	 * 	

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

	/**
	 * url field of the Swagger ExternalDocumentation Object.
	 *
	 * 
	 * The URL for the target documentation. Value MUST be in the format of a URL.
	 *
	 * 
Notes:

	 * 	
	 * 		The value is required.
	 * 	

	 * 		The format is a URL string.
	 * 	

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