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

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

Related Packages

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

Class	Description
DefaultValue	Define the default keyword in the parameter schema to specify the default value for an optional parameter.
DefaultValueKey	Set the default value for a field using an i18n string.
Description	Annotation for adding a string description to a Resource Schema objects.
DescriptionKey	Annotation for adding i18n Description keys to Resource object fields.
Enumeration	Annotation for adding an enumeration of values to a Resource Schema object.
Enumeration.Provider	Interface for providing enumeration values
ExampleValue	Provide an example value for a field.
FormCategory	An annotation to include the "x-form-category" property in the schema for a field.
FormCategoryKey	An annotation to include the "x-form-category" property in the schema for a field.
FormChoices	An annotation to include the "x-form-field-settings" property in the schema for a field.
FormField	An annotation to include the "x-form-field" property in the schema for a field.
FormReferenceType	An annotation to include the "x-form-field-settings" property in the schema for a field.
Hidden	Hides a field from being discovered by the reflective schema builder found at SchemaUtil.fromType(Class, Consumer)
IsNullable	An annotation to include the "x-form-category" property in the schema for a field.
Label	Annotation for adding a string label to a Resource Schema objects.
ListType
Maximum	An annotation to provide a hint in the OpenAPI schema that a number field has a maximum value.
MaxLength	A json-schema validation that requires a string field must be a shorter than a maximum character length.
Minimum	An annotation to provide a hint in the OpenAPI schema that the number field has a minimum value.
MinLength	A json-schema validation that requires a string field must be a minimum character length.
NonSecret	This annotation is used to mark a field as non-secret.
Pattern	A json-schema validation that requires a field confirms to a regex pattern.
RefSchema	Used to annotate a type that should generate a reference schema instead of a reflectively discovered inline schema.
Required	An annotation to provide a hint in the OpenAPI schema that the field is required.
Title	Annotation for adding a string title to a Resource Schema objects.
TitleKey	Annotation for adding i18n Title keys to Resource object fields.