Class WidgetDataSchemas

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.v1.utils.WidgetDataSchemas

public class WidgetDataSchemas
extends Object

Typed OpenAPI schemas for the data of each widget type (the `widgetData` of POST /widget/{name}), built from the backend's QWidgetData classes, and the discriminated union over them keyed by the data's `type`. A client renders by type, never by sniffing the shape (docs/UI-API-CLIENTS.md).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GENERIC_SCHEMA_NAME
static final String	UNION_SCHEMA_NAME

Constructor Summary

Constructors

Constructor	Description
WidgetDataSchemas()

Method Summary

Modifier and Type	Method	Description
static Map<String,Schema>	componentSchemas()	All the component schemas: one per data class, the generic one, and the union (WidgetData).
static String	schemaName(Class<?> dataClass)	The component schema name for a widget data class.
static List<String>	widgetTypeValues()	Every widget type value (as sent in widget metadata and data `type`).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GENERIC_SCHEMA_NAME

public static final String GENERIC_SCHEMA_NAME

See Also:

• Constant Field Values

UNION_SCHEMA_NAME

public static final String UNION_SCHEMA_NAME

See Also:

• Constant Field Values

Constructor Details

WidgetDataSchemas

public WidgetDataSchemas()

Method Details

schemaName

public static String schemaName(Class<?> dataClass)

The component schema name for a widget data class.

widgetTypeValues

public static List<String> widgetTypeValues()

Every widget type value (as sent in widget metadata and data `type`).

componentSchemas

public static Map<String,Schema> componentSchemas()

All the component schemas: one per data class, the generic one, and the union (WidgetData).