io.qameta.allure

Annotation Type Link

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
 @LinkAnnotation
 @Repeatable(value=Links.class)
public @interface Link

Use this annotation to add some links to results. Usage:

 @Link("https://qameta.io")
 public void myTest() {
     ...
 }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	name Name for link, by default url.
java.lang.String	type This type is used for create an icon for link.
java.lang.String	url Url for link.
java.lang.String	value Alias for name().

Element Detail

value

public abstract java.lang.String value

Alias for name().

Returns:

the link name.

Default:

""

name

public abstract java.lang.String name

Name for link, by default url.

Returns:

the link name.

Default:

""

url

public abstract java.lang.String url

Url for link. By default will search for system property `allure.link.{type}.pattern`, and use it to generate url.

Returns:

the link url.

Default:

""

type

public abstract java.lang.String type

This type is used for create an icon for link. Also there is few reserved types such as issue and tms.

Returns:

the link type.

Default:

"custom"