Uses of Annotation Interface
com.kingsrook.qqq.middleware.javalin.schemabuilder.annotations.OpenAPIDescription

Packages that use OpenAPIDescription

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

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

Classes in com.kingsrook.qqq.middleware.javalin.specs.v1.responses with annotations of type OpenAPIDescription

Modifier and Type	Class	Description
static final class	AuthenticationMetaDataResponseV1.Auth0Values
static final class	AuthenticationMetaDataResponseV1.EmptyValues
static final class	AuthenticationMetaDataResponseV1.OAuth2Values
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepComplete
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepError
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepJobStarted
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepRunning

Methods in com.kingsrook.qqq.middleware.javalin.specs.v1.responses with annotations of type OpenAPIDescription

Modifier and Type	Method	Description
Map<String,Serializable>	WidgetMetaData.getDefaultValues()
List<WidgetDropdownData>	WidgetMetaData.getDropdowns()	Dropdowns the widget offers to filter its data.
String	WidgetMetaData.getFooterHTML()	HTML shown below the widget.
Integer	WidgetMetaData.getGridColumns()	Number of grid columns (of 12) the widget spans.
boolean	WidgetMetaData.getHasPermission()	Whether the user may render the widget.
Map<String,List<HelpContentV1>>	WidgetMetaData.getHelpContent()	Help content by role.
String	WidgetMetaData.getIcon()	Name of the widget's icon.
Map<String,QIcon>	WidgetMetaData.getIcons()	Icons by role (for example the widget header icon).
boolean	WidgetMetaData.getIsCard()	Whether the widget is drawn as a card.
String	WidgetMetaData.getLabel()
String	WidgetMetaData.getMinHeight()	Minimum height of the widget (a CSS length).
String	WidgetMetaData.getName()
boolean	WidgetMetaData.getShowExportButton()	Whether the widget offers an export button.
boolean	WidgetMetaData.getShowReloadButton()	Whether the widget offers a reload button.
boolean	WidgetMetaData.getStoreDropdownSelections()	Whether dropdown selections are remembered for the user.
String	WidgetMetaData.getTooltip()	Tooltip text for the widget.
String	WidgetMetaData.getType()

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

Classes in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components with annotations of type OpenAPIDescription

Modifier and Type	Class	Description
class	FrontendComponentValues
final class	WidgetBlockAudioValues
final class	WidgetBlockButtonValues
final class	WidgetBlockImageValues
final class	WidgetBlockInputFieldValues
final class	WidgetBlockTextValues

Methods in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components with annotations of type OpenAPIDescription

Modifier and Type	Method	Description
String	Branding.getAccentColor()
String	PublicBranding.getAccentColor()
String	Branding.getAccentColorLight()
String	PublicBranding.getAccentColorLight()
FieldAccessTier	FieldMetaData.getAccessTier()	Effective tier; HIDDEN fields are omitted from table metadata.
String	WidgetBlockButtonValues.getActionCode()
Map<String,Serializable>	BrandingBanner.getAdditionalStyles()
List<FieldAdornment>	FieldMetaData.getAdornments()
String	QueryJoin.getAlias()
List<String>	FieldMetaData.getAllowedFilterOperators()	Exact-match operators may also be disabled by the resolver.
Map<String,TableSection>	TableSection.getAlternatives()
String	Branding.getAppName()
String	PublicBranding.getAppName()
Map<String,List<OutputRecord>>	OutputRecord.getAssociatedRecords()	Getter for associatedRecords - only present when associations were requested (record get with includeAssociations) or written (insert/update).
AssociatedScriptMetaData	RecordDeveloperModeAssociatedScript.getAssociatedScript()
String	Association.getAssociatedTableName()
String	RelatedRecordPicker.getAssociationName()
List<Association>	TableMetaData.getAssociations()
Boolean	WidgetBlockInputFieldValues.getAutoFocus()
Boolean	WidgetBlockAudioValues.getAutoPlay()
String	BrandingBanner.getBackgroundColor()
String	WidgetBlockBaseStyles.getBackgroundColor()
String	FrontendStep.getBackStepName()
Map<String,BrandingBanner>	Branding.getBanners()
String	QueryJoin.getBaseTableOrAlias()
List<String>	FieldMetaData.getBehaviors()	Names of the behaviors a frontend applies while a value is edited (e.g., TO_UPPER_CASE applied as the user types, QRun-IO/qqq#723), as the legacy table meta-data lists them.
String	WidgetBlock.getBlockId()
WidgetBlock.BlockType	WidgetBlock.getBlockType()
String	WidgetBlock.getBlockTypeName()
QQueryFilter.BooleanOperator	QueryFilter.getBooleanOperator()
List<BuiltInViewV1>	TableMetaData.getBuiltInViews()	Built-in session-relative views published by core.
Boolean	RelatedRecordPicker.getCanAddChildren()
Boolean	RelatedRecordPicker.getCanCreateTarget()
Boolean	RelatedRecordPicker.getCanRemoveChildren()
Map<String,Boolean>	RecordFeaturesV1.getCapabilities()
List<String>	TableMetaDataLight.getCapabilities()
Map<String,AppTreeNode>	AppMetaData.getChildMap()
List<AppTreeNode>	AppMetaData.getChildren()
List<AppTreeNode>	AppTreeNode.getChildren()
String	RelatedRecordPicker.getChildTableName()
String	RelatedRecordPicker.getChildTargetFieldName()
TableSectionCollapsible	TableSection.getCollapsible()
String	Icon.getColor()
String	WidgetBlockButtonStyles.getColor()
String	WidgetBlockTextStyles.getColor()
List<String>	RelatedRecordPicker.getColumns()
String	Branding.getCompanyName()
String	PublicBranding.getCompanyName()
String	Branding.getCompanyUrl()
List<FrontendComponent>	FrontendStep.getComponents()
String	WidgetBlock.getConditional()
String	HelpContentV1.getContent()	Getter for content
String	HelpContentV1.getContentAsHtml()	Getter for contentAsHtml
String	HelpSearchResultV1.getContentAsHtml()	Getter for contentAsHtml
String	WidgetBlockButtonValues.getControlCode()
List<FilterCriteria>	QueryFilter.getCriteria()
QueryFilter	RelatedRecordPicker.getDefaultFilter()
String	FieldMetaData.getDefaultValue()
Boolean	TableMetaDataLight.getDeletePermission()
List<RecordSearchDetailV1>	RecordSearchResultV1.getDetails()
String	FieldMetaData.getDisplayFormat()
String	RecordSearchDetailV1.getDisplayValue()
Map<String,String>	OutputRecord.getDisplayValues()	Getter for displayValues
Boolean	ProcessMetaDataLight.getDurableJobAlways()
Boolean	ProcessMetaDataLight.getDurableJobEligible()
Boolean	TableMetaDataLight.getEditPermission()
Integer	RecordSearchHighlightMatchV1.getEnd()
Icon	WidgetBlockButtonValues.getEndIcon()
Icon	WidgetBlockTextValues.getEndIcon()
List<String>	OutputRecord.getErrors()	Getter for errors
List<ExposedJoin>	TableMetaData.getExposedJoins()
String	RecordSearchProviderStatusV1.getFailureClass()
List<RecordFeature>	RecordFeaturesV1.getFeatures()
String	RecordSearchDetailV1.getFieldLabel()
String	RecordSearchHighlightV1.getFieldLabel()
FieldMetaData	WidgetBlockInputFieldValues.getFieldMetaData()
String	AssociatedScriptMetaData.getFieldName()
String	FilterCriteria.getFieldName()
String	OrderBy.getFieldName()
String	RecordSearchDetailV1.getFieldName()
String	RecordSearchHighlightV1.getFieldName()
String	RelatedRecordPicker.getFieldName()
List<String>	TableSection.getFieldNames()
Map<String,FieldMetaData>	TableMetaData.getFields()
QueryFilter	RelatedRecordPicker.getFilter()
String	FrontendStep.getFormat()
HelpFormat	HelpContentV1.getFormat()	Getter for format
String	WidgetBlockButtonStyles.getFormat()
String	WidgetBlockTextStyles.getFormat()
List<FieldMetaData>	FrontendStep.getFormFields()
List<FrontendStep>	ProcessMetaData.getFrontendSteps()
Integer	FieldMetaData.getGridColumns()	Width of the field in a 12-column grid, as the Material dashboard lays out record forms and views (QRun-IO/qqq#723).
Integer	TableSection.getGridColumns()
Boolean	HelpCoverageEntryV1.getHasContent()	Getter for hasContent
Boolean	RecordSearchTableSummaryV1.getHasMore()
Boolean	ProcessMetaDataLight.getHasPermission()
boolean	ReportMetaData.getHasPermission()	Getter for hasPermission
Boolean	TableMetaData.getHasRestrictedFields()	Whether the current session has any restricted fields on this table.
Boolean	HelpCoverageEntryV1.getHasSummary()	Getter for hasSummary
String	WidgetBlockImageStyles.getHeight()
Map<String,List<HelpContentV1>>	AppMetaData.getHelpContents()	Help content by slot, filtered for the current session.
List<HelpContentV1>	FieldMetaData.getHelpContents()	help content for the field (e.g., shown on view, edit and insert screens, per each entry's roles), as in the legacy table meta-data.
List<HelpContentV1>	FrontendStep.getHelpContents()
Map<String,List<HelpContentV1>>	ProcessMetaDataLight.getHelpContents()	Help content by slot, filtered for the current session.
Map<String,List<HelpContentV1>>	ReportMetaData.getHelpContents()	Help content by slot, filtered for the current session.
Map<String,List<HelpContentV1>>	TableMetaDataLight.getHelpContents()
List<HelpContentV1>	TableSection.getHelpContents()
Boolean	HelpCoverageEntryV1.getHidden()	Getter for hidden
Boolean	WidgetBlockInputFieldValues.getHideSoftKeyboard()
List<RecordSearchHighlightV1>	RecordSearchResultV1.getHighlights()
String	HelpSearchResultV1.getHref()	Getter for href
Icon	AppMetaData.getIcon()
Icon	AppSection.getIcon()
Icon	AppTreeNode.getIcon()
String	Branding.getIcon()
Icon	ProcessMetaDataLight.getIcon()
String	PublicBranding.getIcon()
Icon	TableMenu.getIcon()
Icon	TableMenuItem.getIcon()
Icon	TableMetaDataLight.getIcon()
Icon	TableSection.getIcon()
String	ProcessMetaDataLight.getIconName()
String	ReportMetaData.getIconName()	Getter for iconName
Boolean	TableSectionCollapsible.getInitiallyOpen()
QPossibleValueSource	FieldMetaData.getInlinePossibleValueSource()	Inline possible values declared on a field, as in frontend metadata.
Boolean	TableMetaDataLight.getInsertPermission()
Boolean	OrderBy.getIsAscending()
Boolean	TableSectionCollapsible.getIsCollapsible()
Boolean	FieldMetaData.getIsEditable()
Boolean	FieldMetaData.getIsHeavy()
Boolean	FieldMetaData.getIsHidden()
Boolean	ProcessMetaDataLight.getIsHidden()
Boolean	TableMetaDataLight.getIsHidden()
Boolean	ExposedJoin.getIsMany()
Boolean	VirtualFieldMetaData.getIsQueryCriteria()
Boolean	VirtualFieldMetaData.getIsQuerySelectable()
Boolean	FieldMetaData.getIsRequired()
Boolean	FieldMetaData.getIsSortable()	Sorting is available only for FULL fields.
List<TableMenuItem>	TableMenu.getItems()
String	TableMenuItem.getItemType()
QJoinMetaData	Association.getJoin()
String	QueryJoin.getJoinName()
List<QJoinMetaData>	ExposedJoin.getJoinPath()
TableMetaData	ExposedJoin.getJoinTable()
String	QueryJoin.getJoinTable()
String	HelpCoverageEntryV1.getKey()	Getter for key
String	HelpSearchResultV1.getKey()	Getter for key
String	HelpCoverageEntryV1.getKind()	Getter for kind
String	HelpCoverageTotalV1.getKind()	Getter for kind
String	HelpSearchResultV1.getKind()	Getter for kind
String	AppMetaData.getLabel()
String	AppSection.getLabel()
String	AppTreeNode.getLabel()
String	ExposedJoin.getLabel()
String	FieldMetaData.getLabel()
String	FrontendStep.getLabel()
String	HelpCoverageEntryV1.getLabel()	Getter for label
String	HelpSearchResultV1.getLabel()	Getter for label
String	ProcessMetaDataLight.getLabel()
String	RelatedRecordPicker.getLabel()
String	ReportMetaData.getLabel()	Getter for label
String	TableMenu.getLabel()
String	TableMenuItem.getLabel()
String	TableMetaDataLight.getLabel()
String	TableSection.getLabel()
String	WidgetBlockButtonValues.getLabel()
CompositeWidgetData.Layout	WidgetBlock.getLayout()
Integer	QueryFilter.getLimit()
String	Branding.getLogo()
String	PublicBranding.getLogo()
List<RecordSearchHighlightMatchV1>	RecordSearchHighlightV1.getMatches()
Integer	ProcessMetaDataLight.getMaxInputRecords()
Integer	FieldMetaData.getMaxLength()
Integer	RelatedRecordPicker.getMaxSelections()
String	FieldMetaData.getMaxValue()	The largest value a field accepts, when its value range rejects larger ones.
List<TableMenu>	TableMetaData.getMenus()
String	RecordSearchProviderStatusV1.getMessage()
String	BrandingBanner.getMessageHTML()
String	BrandingBanner.getMessageText()
Long	TableMetaDataLight.getMetaDataGeneration()	Publish the current runtime metadata generation.
Integer	ProcessMetaDataLight.getMinInputRecords()
String	FieldMetaData.getMinValue()	The smallest value a field accepts, when its value range rejects smaller ones, so a form can say so before the user saves.
CompositeWidgetData.ModalMode	WidgetBlock.getModalMode()
String	RelatedRecordPicker.getMode()
String	AppMetaData.getName()
String	AppSection.getName()
String	AppTreeNode.getName()
String	Association.getName()
String	FieldMetaData.getName()
String	FrontendStep.getName()
String	HelpSearchResultV1.getName()	Getter for name
String	Icon.getName()
String	ProcessMetaDataLight.getName()
String	RelatedRecordPicker.getName()
String	ReportMetaData.getName()	Getter for name
String	TableMetaDataLight.getName()
String	TableSection.getName()
QCriteriaOperator	FilterCriteria.getOperator()
List<OrderBy>	QueryFilter.getOrderBys()
BaseStyles.Directional<String>	WidgetBlockBaseStyles.getPadding()
BaseStyles.Directional<String>	WidgetBlockImageStyles.getPadding()
String	HelpCoverageEntryV1.getParentKey()	Getter for parentKey
String	Icon.getPath()
String	WidgetBlockAudioValues.getPath()
String	WidgetBlockImageValues.getPath()
QPossibleValuePicker	FieldMetaData.getPicker()	The record picker declared by this field's possible value source, if any.
String	FieldMetaData.getPickerTableName()	The table behind this field's picker (for its field labels and types).
String	WidgetBlockInputFieldValues.getPlaceholder()
String	FieldMetaData.getPossibleValueSourceDependencyBehavior()	Behavior while any dependency is unset.
List<String>	FieldMetaData.getPossibleValueSourceDependsOn()	Other input fields that control this field's possible values.
String	FieldMetaData.getPossibleValueSourceName()
List<String>	RelatedRecordPicker.getPreviewFields()
String	TableMetaData.getPrimaryKeyField()
String	HelpSearchResultV1.getProcess()	Getter for process
List<String>	AppSection.getProcesses()
String	ReportMetaData.getProcessName()	Getter for processName
String	TableMetaData.getQuickCreateSectionName()
Boolean	TableMetaDataLight.getReadPermission()
RecordFeaturesV1	TableMetaDataLight.getRecordFeatures()	Publish the session-specific collaboration metadata.
String	RecordSearchResultV1.getRecordId()
String	OutputRecord.getRecordLabel()	Getter for tableName
String	RecordSearchResultV1.getRecordLabel()
List<FieldMetaData>	FrontendStep.getRecordListFields()
List<RelatedRecordPicker>	TableMetaData.getRelatedRecordPickers()
List<String>	AppSection.getReports()
Integer	RecordSearchTableSummaryV1.getResultCount()
List<String>	RelatedRecordPicker.getReviewFieldNames()
List<String>	HelpContentV1.getRoles()	Getter for roles
List<String>	HelpCoverageEntryV1.getRoles()	Getter for roles
Double	RecordSearchResultV1.getScore()
OutputRecord	RecordDeveloperModeAssociatedScript.getScript()
List<OutputRecord>	RecordDeveloperModeAssociatedScript.getScriptRevisions()
OutputRecord	RecordDeveloperModeAssociatedScript.getScriptType()
Serializable	AssociatedScriptMetaData.getScriptTypeId()
List<String>	TableMetaDataLight.getSearchFields()
List<AppSection>	AppMetaData.getSections()
List<TableSection>	TableMetaData.getSections()
Boolean	QueryJoin.getSelect()
Map<RecordFeature,Map<String,Serializable>>	RecordFeaturesV1.getSettings()
String	BrandingBanner.getSeverity()
ShareableTableMetaData	TableMetaData.getShareableTableMetaData()
Boolean	WidgetBlockAudioValues.getShowControls()
String	WidgetBlockTextStyles.getSize()
Integer	QueryFilter.getSkip()
String	TableMenu.getSlot()
RecordSearchSource	RecordSearchTableSummaryV1.getSource()
Integer	RecordSearchHighlightMatchV1.getStart()
Icon	WidgetBlockButtonValues.getStartIcon()
Icon	WidgetBlockTextValues.getStartIcon()
RecordSearchProviderState	RecordSearchProviderStatusV1.getStatus()
String	ProcessMetaDataLight.getStepFlow()
WidgetBlockStyles	WidgetBlock.getStyles()
List<WidgetBlock>	WidgetBlock.getSubBlocks()
Boolean	WidgetBlockInputFieldValues.getSubmitOnEnter()
String	HelpContentV1.getSummary()	Getter for summary
String	HelpSearchResultV1.getSummary()	Getter for summary
Map<String,Object>	AppMetaData.getSupplementalAppMetaData()
Map<String,QSupplementalFieldMetaData>	FieldMetaData.getSupplementalMetaData()	Frontend-visible field settings, including Material form adjusters.
Map<String,QSupplementalTableMetaData>	TableMetaData.getSupplementalMetaData()
String	HelpSearchResultV1.getTable()	Getter for table
String	RecordSearchResultV1.getTableLabel()
String	RecordSearchTableSummaryV1.getTableLabel()
String	OutputRecord.getTableName()	Getter for tableName
String	ProcessMetaDataLight.getTableName()
String	RecordSearchResultV1.getTableName()
String	RecordSearchTableSummaryV1.getTableName()
List<String>	AppSection.getTables()
String	RelatedRecordPicker.getTargetTableName()
List<FieldMetaData>	RecordDeveloperModeAssociatedScript.getTestInputFields()
List<FieldMetaData>	RecordDeveloperModeAssociatedScript.getTestOutputFields()
String	HelpSearchResultV1.getText()	Getter for text
String	RecordSearchHighlightV1.getText()
String	WidgetBlockTextValues.getText()
String	BrandingBanner.getTextColor()
String	RelatedRecordPicker.getThumbnailField()
String	TableSection.getTier()
Integer	HelpCoverageTotalV1.getTotal()	Getter for total
Integer	RecordSearchTableSummaryV1.getTotalCount()
String	AppTreeNode.getType()
AdornmentType	FieldAdornment.getType()
String	FieldMetaData.getType()
QComponentType	FrontendComponent.getType()
QueryJoin.Type	QueryJoin.getType()
String	RecordSearchResultV1.getUpdatedAt()
Boolean	TableMetaData.getUsesVariants()
Map<String,Serializable>	FieldAdornment.getValues()
List<String>	FilterCriteria.getValues()
Map<String,Serializable>	FrontendComponent.getValues()	Getter for values
Map<String,Serializable>	OutputRecord.getValues()	Getter for values
Map<String,Object>	TableMenuItem.getValues()
WidgetBlockValues	WidgetBlock.getValues()
String	TableMetaDataLight.getVariantTableLabel()
List<FieldMetaData>	FrontendStep.getViewFields()
Map<String,VirtualFieldMetaData>	TableMetaData.getVirtualFields()
List<String>	OutputRecord.getWarnings()	Getter for warnings
String	WidgetBlockTextStyles.getWeight()
String	TableSection.getWidgetName()
List<String>	AppMetaData.getWidgets()
String	WidgetBlockImageStyles.getWidth()
Integer	HelpCoverageTotalV1.getWithHelp()	Getter for withHelp
Boolean	TableSection.isHidden()