Package com.inductiveautomation.ignition.gateway.dataroutes.openapi.annotations

Annotation Interface DescriptionKey

@Target(FIELD)
@Retention(RUNTIME)
public @interface DescriptionKey

Annotation for adding i18n Description keys to Resource object fields. This annotation gets parsed by SchemaUtil.fromType by querying BundleUtil with the given value(). In the case that this annotation and Description both exist on a given field, Description will win out.

See Also:

• The @Description annotation for adding a raw string description.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value

Element Details

value

String value