Uses of Interface
com.kingsrook.qqq.middleware.javalin.schemabuilder.ToSchema

Packages that use ToSchema

Package	Description
com.kingsrook.qqq.middleware.javalin.routeproviders
com.kingsrook.qqq.middleware.javalin.specs.v1.responses
com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components

Uses of ToSchema in com.kingsrook.qqq.middleware.javalin.routeproviders

Classes in com.kingsrook.qqq.middleware.javalin.routeproviders that implement ToSchema

Modifier and Type	Class	Description
final class	NextDashboardCspSources	Public source additions derived from configured application features.

Uses of ToSchema in com.kingsrook.qqq.middleware.javalin.specs.v1.responses

Classes in com.kingsrook.qqq.middleware.javalin.specs.v1.responses that implement ToSchema

Modifier and Type	Class	Description
class	AuthenticationMetaDataResponseV1
class	BackChannelLogoutResponseV1	Response for the OIDC back-channel logout endpoint.
class	BasicErrorResponseV1
class	BulkLoadSuggestMappingResponseV1	A suggested mapping for an upload's header row.
class	BulkLoadUploadProfileResponseV1	The header guess and column profiles of an upload.
class	BulkLoadValidateResponseV1	The result of a bulk-load dry run (nothing is stored).
class	HelpCoverageResponseV1	HelpCoverageResponseV1 contract.
class	HelpSearchResponseV1	HelpSearchResponseV1 contract.
class	JobActionResponseV1	Jobs UI API v1 representation.
class	JobDetailV1	Jobs UI API v1 representation.
class	JobListResponseV1	Jobs UI API v1 representation.
class	JobLogLineV1	Jobs UI API v1 representation.
class	JobPhaseV1	Jobs UI API v1 representation.
class	JobProgressPollV1	Jobs UI API v1 representation.
class	JobProgressV1	Jobs UI API v1 representation.
class	JobSummaryV1	Jobs UI API v1 representation.
class	JobTrackRequestV1	Jobs UI API v1 representation.
class	LogoutResponseV1	Response for the logout endpoint.
class	ManageSessionResponseV1
class	MetaDataResponseV1
class	PossibleValuesResponseV1	Response object for possible values searches.
class	PreferenceActionRequestV1	PreferenceActionRequestV1 in the user preferences API.
class	PreferenceActionResponseV1	PreferenceActionResponseV1 in the user preferences API.
class	PreferenceActionV1	PreferenceActionV1 in the user preferences API.
class	PreferenceListV1	PreferenceListV1 in the user preferences API.
class	PreferenceRowV1	PreferenceRowV1 in the user preferences API.
class	PreferenceSecretV1	One-time secret.
class	PreferenceSectionPatchRequestV1	PreferenceSectionPatchRequestV1 in the user preferences API.
class	PreferenceSectionV1	PreferenceSectionV1 in the user preferences API.
class	PreferencesResponseV1	PreferencesResponseV1 in the user preferences API.
class	ProcessCancelResponseV1	V1 response object for process cancellation.
class	ProcessInitOrStepOrStatusResponseV1
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepComplete
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepError
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepJobStarted
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepRunning
static class	ProcessInitOrStepOrStatusResponseV1.TypedResponse
class	ProcessJobLaunchResponseV1	Response of POST /processes/{processName}/jobs.
class	ProcessMetaDataResponseV1
class	ProcessRecordsResponseV1	V1 response object for process records.
class	RecordAssociatedScriptLogsResponseV1	Response for the route that gets the logs of a record's associated script revision.
class	RecordAssociatedScriptStoreResponseV1	Response for the route that stores a new revision of a record's associated script.
class	RecordDeveloperModeResponseV1	Response for the record developer-mode route.
class	RecordDeveloperPanelsResponseV1	Response of the record developer panels endpoint.
class	RecordFeatureSummaryV1
class	RecordSearchResponseV1	Response of the record search endpoint.
class	RelatedRecordPickerAddResponseV1	Response of the relatedRecordPicker add route: the inserted rows.
class	RelatedRecordPickerPrepareResponseV1	Response of the relatedRecordPicker prepare route: unsaved child rows.
class	RelatedRecordPickerQueryResponseV1	Response of the relatedRecordPicker query route.
class	RelatedRecordPickerRemoveResponseV1	Response of the relatedRecordPicker remove route.
class	TableCountResponseV1
class	TableDeleteResponseV1
class	TableGetResponseV1
class	TableInsertResponseV1
class	TableMetaDataResponseV1
class	TableQueryResponseV1
class	TableUpdateResponseV1
class	TableVariantsResponseV1	Response for GET /table/{tableName}/variants.
class	UploadRefResponseV1	An UploadRef (spec section 3.2).
class	VersionResponseV1	Response for GET /version.
class	WidgetMetaData
class	WidgetResponseV1	V1 response object for widget rendering.

Uses of ToSchema in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components

Subinterfaces of ToSchema in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components

Modifier and Type	Interface	Description
interface	WidgetBlockStyles
interface	WidgetBlockValues

Classes in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components that implement ToSchema

Modifier and Type	Class	Description
class	AppMetaData
class	AppSection
class	AppTreeNode
class	AssociatedScriptMetaData	The definition of one of a table's associated scripts (a field of the table that references a script of a given type).
class	Association	A named association and its join, without recursive child table metadata.
class	Branding	Application identity (names, images, accent colors and banners) for a frontend.
class	BrandingBanner	A banner message shown in one of the frontend's banner slots.
class	BuiltInViewV1	Built-in ownership view.
class	BulkLoadColumnProfile	One column of an uploaded file: its shape, and sample values only where allowed.
class	BulkLoadColumnRef	A file column.
class	BulkLoadFieldRef	A table field.
class	BulkLoadRowError	An error group of a bulk-load dry run.
class	BulkLoadSummaryLine	A line of the bulk-insert process summary.
class	ExposedJoin
class	FieldAdornment
class	FieldMetaData
class	FilterCriteria
class	FrontendComponent
class	FrontendComponentValues
class	FrontendStep
class	HelpContentV1	Public help contract.
class	HelpCoverageEntryV1	HelpCoverageEntryV1 contract.
class	HelpCoverageTotalV1	HelpCoverageTotalV1 contract.
class	HelpSearchResultV1	HelpSearchResultV1 contract.
class	Icon
class	MaterialDashboardInstanceSettings	The settings a frontend may read from an instance's `materialDashboard` supplemental meta-data.
class	MaterialDashboardWeekdayCriteriaSettings	The weekday criteria settings from an instance's `materialDashboard` supplemental meta-data: whether query screens offer "day is any of" and "day is none of" on date and date-time fields, and the arguments to send with the WeekdayOfDateTime field function (e.g., a time zone).
class	OrderBy
class	OutputRecord
class	PossibleValueOption	A single possible value option, with an id and a label.
class	ProcessMetaData
class	ProcessMetaDataLight
class	PublicBranding	The part of the application's branding that is safe to show before a user signs in (for example on a login page): names, logo, icon and accent colors.
class	QueryFilter
class	QueryJoin
class	RealtimeChannelRevokedEventV1	Typed realtime UI API payload.
class	RealtimeEventV1	Typed realtime UI API payload.
class	RealtimeHelloEventV1	Typed realtime UI API payload.
class	RealtimeJobProgressEventV1	job.progress data, sent on the owner and job record channels.
class	RealtimeMetaDataChangedEventV1	Typed realtime UI API payload.
class	RealtimeRecordChangedEventV1	Typed realtime UI API payload.
class	RealtimeRecordDeletedEventV1	Typed realtime UI API payload.
class	RealtimeResyncEventV1	Typed realtime UI API payload.
class	RealtimeSessionEndedEventV1	Typed realtime UI API payload.
class	RealtimeSubscriptionRequestV1	Typed realtime UI API payload.
class	RealtimeSubscriptionResponseV1	Typed realtime UI API payload.
class	RealtimeTableChangedEventV1	Typed realtime UI API payload.
class	RecordConflictV1	Typed realtime UI API payload.
class	RecordDeveloperModeAssociatedScript	One of a table's associated scripts, as shown in developer mode for a record: its definition, script type, and the script the record references (if any) with its revisions, plus the fields for testing it.
class	RecordFeaturesV1
class	RecordSearchDetailV1	A secondary field value of a record search result, to show under its label.
class	RecordSearchHighlightMatchV1	One matched span in a record search highlight: character offsets into its text.
class	RecordSearchHighlightV1	A plain-text snippet of a field that matches the search term, with the matched spans.
class	RecordSearchProviderStatusV1	How the instance's record search provider fared in this search.
class	RecordSearchResultV1	One record matched by record search.
class	RecordSearchTableSummaryV1	Summary of the record search of one table.
class	RelatedRecordPicker	A related-record picker of a table (docs/RELATED-RECORD-PICKER.md): what it picks, how to show it, and what the current user may do with it.
class	ReportMetaData	A report in the instance's meta-data: what a frontend needs to list it and to run it (through its process, or the report route when it has none).
class	SupplementalInstanceMetaData	Instance-level settings from supplemental modules, for a frontend.
class	TableMenu	A menu that a table defines for a slot on a screen, for example the record view's actions menu (VIEW_SCREEN_ACTIONS) or its additional menus (VIEW_SCREEN_ADDITIONAL).
class	TableMenuItem	One item of a table menu.
class	TableMetaData	API response component for full table metadata, extending TableMetaDataLight with fields, sections, exposed joins, supplemental metadata, sharing configuration, and virtual fields.
class	TableMetaDataLight
class	TableSection
class	TableSectionCollapsible	Whether a table section can be collapsed, and whether it starts open.
class	TableVariant
class	UiApiExtensionInfo	A module or qbit extension of the UI API, as listed by the version endpoint.
class	VirtualFieldMetaData	API response component representing a virtual field's metadata, extending the base FieldMetaData with queryability flags that indicate whether the virtual field may be used as a filter criterion and/or included in query output.
class	WidgetBlock
final class	WidgetBlockAudioValues
final class	WidgetBlockBaseStyles
final class	WidgetBlockButtonStyles
final class	WidgetBlockButtonValues
final class	WidgetBlockImageStyles
final class	WidgetBlockImageValues
final class	WidgetBlockInputFieldValues
final class	WidgetBlockTextStyles
final class	WidgetBlockTextValues