Uses of Class
com.kingsrook.qqq.openapi.model.Schema

Packages that use Schema

Package	Description
com.kingsrook.qqq.esb.api.specs
com.kingsrook.qqq.middleware.javalin.health
com.kingsrook.qqq.middleware.javalin.schemabuilder
com.kingsrook.qqq.middleware.javalin.specs
com.kingsrook.qqq.middleware.javalin.specs.extensions
com.kingsrook.qqq.middleware.javalin.specs.v1
com.kingsrook.qqq.middleware.javalin.specs.v1.responses
com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components
com.kingsrook.qqq.middleware.javalin.specs.v1.utils
com.kingsrook.qqq.openapi.model	The POJOs in this package represent a model of an OpenAPI spec file.

Uses of Schema in com.kingsrook.qqq.esb.api.specs

Methods in com.kingsrook.qqq.esb.api.specs that return types with arguments of type Schema

Modifier and Type	Method	Description
static Map<String,Schema>	EsbUiApiSchemas.all()	All the component schemas, by name.
Map<String,Schema>	EsbSpecSupport.AbstractEsbSpecV1.defineComponentSchemas()

Uses of Schema in com.kingsrook.qqq.middleware.javalin.health

Methods in com.kingsrook.qqq.middleware.javalin.health that return types with arguments of type Schema

Modifier and Type	Method	Description
Map<String,Schema>	HealthSpecSupport.defineComponentSchemas()	All schemas are owned by this extension.

Uses of Schema in com.kingsrook.qqq.middleware.javalin.schemabuilder

Subclasses of Schema in com.kingsrook.qqq.middleware.javalin.schemabuilder

Modifier and Type	Class	Description
static class	SchemaBuilder.SchemaFromBuilder

Methods in com.kingsrook.qqq.middleware.javalin.schemabuilder that return Schema

Modifier and Type	Method	Description
Schema	SchemaBuilder.classToSchema(Class<?> c)
default Schema	ToSchema.toSchema()

Uses of Schema in com.kingsrook.qqq.middleware.javalin.specs

Methods in com.kingsrook.qqq.middleware.javalin.specs that return types with arguments of type Schema

Modifier and Type	Method	Description
Map<String,Schema>	AbstractEndpointSpec.defineComponentSchemas()

Uses of Schema in com.kingsrook.qqq.middleware.javalin.specs.extensions

Methods in com.kingsrook.qqq.middleware.javalin.specs.extensions that return Schema

Modifier and Type	Method	Description
protected Schema	AbstractJsonEndpointSpec.defineRequestBodySchema()	The schema of the JSON request body, or null (the default) for none.

Uses of Schema in com.kingsrook.qqq.middleware.javalin.specs.v1

Methods in com.kingsrook.qqq.middleware.javalin.specs.v1 that return Schema

Modifier and Type	Method	Description
protected Schema	TableFormAdjusterSpecV1.defineRequestBodySchema()

Methods in com.kingsrook.qqq.middleware.javalin.specs.v1 that return types with arguments of type Schema

Modifier and Type	Method	Description
Map<String,Schema>	AuthenticationMetaDataSpecV1.defineComponentSchemas()
Map<String,Schema>	BackChannelLogoutSpecV1.defineComponentSchemas()
Map<String,Schema>	BulkLoadSuggestMappingSpecV1.defineComponentSchemas()
Map<String,Schema>	BulkLoadUploadProfileSpecV1.defineComponentSchemas()
Map<String,Schema>	BulkLoadValidateSpecV1.defineComponentSchemas()
Map<String,Schema>	GeneralDownloadSpecV1.defineComponentSchemas()
Map<String,Schema>	HelpCoverageSpecV1.defineComponentSchemas()	Response schema.
Map<String,Schema>	HelpSearchSpecV1.defineComponentSchemas()	Response schema.
Map<String,Schema>	JobsSpecV1.defineComponentSchemas()	All versioned jobs representations.
Map<String,Schema>	LogoutSpecV1.defineComponentSchemas()
Map<String,Schema>	ManageSessionSpecV1.defineComponentSchemas()
Map<String,Schema>	MetaDataSpecV1.defineComponentSchemas()
Map<String,Schema>	PreferenceSectionActionSpecV1.defineComponentSchemas()	Publish all preference component schemas.
Map<String,Schema>	PreferenceSectionGetSpecV1.defineComponentSchemas()	Publish all preference component schemas.
Map<String,Schema>	PreferenceSectionPatchSpecV1.defineComponentSchemas()	Publish all preference component schemas.
Map<String,Schema>	PreferencesSpecV1.defineComponentSchemas()	Publish all preference component schemas.
Map<String,Schema>	ProcessCancelSpecV1.defineComponentSchemas()
Map<String,Schema>	ProcessJobLaunchSpecV1.defineComponentSchemas()
Map<String,Schema>	ProcessMetaDataSpecV1.defineComponentSchemas()
Map<String,Schema>	ProcessPossibleValuesSpecV1.defineComponentSchemas()
Map<String,Schema>	ProcessRecordsSpecV1.defineComponentSchemas()
Map<String,Schema>	ProcessStatusSpecV1.defineComponentSchemas()	These aren't in the components sub-package, so they don't get auto-found.
Map<String,Schema>	RealtimeStreamSpecV1.defineComponentSchemas()	Every named core event is a separate schema component.
Map<String,Schema>	RealtimeSubscriptionsSpecV1.defineComponentSchemas()	Publish both sides of the subscription contract.
Map<String,Schema>	RecordAssociatedScriptLogsSpecV1.defineComponentSchemas()
Map<String,Schema>	RecordAssociatedScriptStoreSpecV1.defineComponentSchemas()
Map<String,Schema>	RecordDeveloperModeSpecV1.defineComponentSchemas()
Map<String,Schema>	RecordDeveloperPanelsSpecV1.defineComponentSchemas()
Map<String,Schema>	RecordFieldDownloadSpecV1.defineComponentSchemas()
Map<String,Schema>	RecordSearchSpecV1.defineComponentSchemas()
Map<String,Schema>	RelatedRecordPickerAddSpecV1.defineComponentSchemas()
Map<String,Schema>	RelatedRecordPickerPrepareSpecV1.defineComponentSchemas()
Map<String,Schema>	RelatedRecordPickerQuerySpecV1.defineComponentSchemas()
Map<String,Schema>	RelatedRecordPickerRemoveSpecV1.defineComponentSchemas()
Map<String,Schema>	ReportRunSpecV1.defineComponentSchemas()
Map<String,Schema>	StandalonePossibleValuesSpecV1.defineComponentSchemas()
Map<String,Schema>	TableApiDocumentSpecV1.defineComponentSchemas()
Map<String,Schema>	TableApisSpecV1.defineComponentSchemas()
Map<String,Schema>	TableCountSpecV1.defineComponentSchemas()
Map<String,Schema>	TableDeleteSpecV1.defineComponentSchemas()
Map<String,Schema>	TableExportSpecV1.defineComponentSchemas()
Map<String,Schema>	TableFormAdjusterSpecV1.defineComponentSchemas()
Map<String,Schema>	TableGetSpecV1.defineComponentSchemas()
Map<String,Schema>	TableInsertSpecV1.defineComponentSchemas()
Map<String,Schema>	TableMetaDataSpecV1.defineComponentSchemas()
Map<String,Schema>	TablePossibleValuesSpecV1.defineComponentSchemas()
Map<String,Schema>	TableQuerySpecV1.defineComponentSchemas()
Map<String,Schema>	TableRecordFeaturesSpecV1.defineComponentSchemas()
Map<String,Schema>	TableUpdateSpecV1.defineComponentSchemas()
Map<String,Schema>	TableVariantsSpecV1.defineComponentSchemas()
Map<String,Schema>	UploadsSpecV1.defineComponentSchemas()
Map<String,Schema>	VersionSpecV1.defineComponentSchemas()
Map<String,Schema>	WidgetSpecV1.defineComponentSchemas()

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

Methods in com.kingsrook.qqq.middleware.javalin.specs.v1.responses that return Schema

Modifier and Type	Method	Description
Schema	PreferenceActionRequestV1.toSchema()	Describe the partial update; raw properties are retained for strict core validation.
Schema	PreferenceActionResponseV1.toSchema()	Describe the wire contract.
Schema	PreferenceActionV1.toSchema()	Describe the wire contract.
Schema	PreferenceListV1.toSchema()	A list of fixed preference rows, rendered with the same typed field editors as scalar preferences.
Schema	PreferenceRowV1.toSchema()	A provider-owned row.
Schema	PreferenceSecretV1.toSchema()	Describe the wire contract.
Schema	PreferenceSectionPatchRequestV1.toSchema()	Describe the partial update; raw properties are retained for strict core validation.
Schema	PreferenceSectionV1.toSchema()	One visible section with the signed-in user's current preferences.
Schema	PreferencesResponseV1.toSchema()	Visible sections in display order, with only the signed-in user's values.
Schema	ProcessInitOrStepOrStatusResponseV1.toSchema()
Schema	ProcessMetaDataResponseV1.toSchema()
Schema	RecordFeatureSummaryV1.toSchema()
Schema	TableMetaDataResponseV1.toSchema()

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

Methods in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components that return Schema

Modifier and Type	Method	Description
Schema	BuiltInViewV1.toSchema()	This additive schema describes the built-in ownership filter without changing the older QueryFilter response's string-only values contract.
Schema	FieldAdornment.toSchema()	The generated schema, with the known keys of `values` described (they differ by adornment type; unknown keys may appear and are ignored).
Schema	RealtimeChannelRevokedEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeHelloEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeMetaDataChangedEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeRecordChangedEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeRecordDeletedEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeResyncEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeSessionEndedEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeSubscriptionRequestV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeSubscriptionResponseV1.toSchema()	Explicit schema for clients in any language.
Schema	RealtimeTableChangedEventV1.toSchema()	Explicit schema for clients in any language.
Schema	RecordConflictV1.toSchema()	Explicit schema for clients in any language.
Schema	RecordFeaturesV1.toSchema()

Uses of Schema in com.kingsrook.qqq.middleware.javalin.specs.v1.utils

Methods in com.kingsrook.qqq.middleware.javalin.specs.v1.utils that return Schema

Modifier and Type	Method	Description
static Schema	ProcessSpecUtilsV1.buildResponseSchema()
static Schema	ProcessSpecUtilsV1.defineTableVariantFormProperty()	OpenAPI definition of the (optional) tableVariant form field.

Methods in com.kingsrook.qqq.middleware.javalin.specs.v1.utils that return types with arguments of type Schema

Modifier and Type	Method	Description
static Map<String,Schema>	WidgetDataSchemas.componentSchemas()	All the component schemas: one per data class, the generic one, and the union (WidgetData).
static Map<String,Schema>	UserPreferencesSpecUtils.schemas()	Component schemas for generated clients.

Uses of Schema in com.kingsrook.qqq.openapi.model

Methods in com.kingsrook.qqq.openapi.model that return Schema

Modifier and Type	Method	Description
Schema	Schema.getItems()	Getter for items
Schema	Content.getSchema()	Getter for schema
Schema	Parameter.getSchema()	Getter for schema
Schema	Schema.withAdditionalProperties(Schema additionalProperties)	Fluent setter for additionalProperties
Schema	Schema.withAdditionalProperties(Boolean additionalProperties)	Fluent setter for additionalProperties
Schema	Schema.withAllOf(List<Schema> allOf)	Fluent setter for allOf
Schema	Schema.withAnyOf(List<Schema> anyOf)	Fluent setter for anyOf
Schema	Schema.withDescription(String description)	Fluent setter for description
Schema	Schema.withDiscriminator(Discriminator discriminator)	Fluent setter for discriminator
Schema	Schema.withEnumValues(List<String> enumValues)	Fluent setter for enumValues
Schema	Schema.withExample(Object example)	Fluent setter for example
Schema	Schema.withExample(String example)	Fluent setter for example
Schema	Schema.withExample(String name, Example example)	Fluent setter for examples
Schema	Schema.withExample(List<?> example)	Fluent setter for example
Schema	Schema.withExamples(Map<String,Example> examples)	Fluent setter for examples
Schema	Schema.withFormat(String format)	Fluent setter for format
Schema	Schema.withItems(Schema items)	Fluent setter for items
Schema	Schema.withMaxLength(Integer maxLength)	Fluent setter for maxLength
Schema	Schema.withNullable(Boolean nullable)	Fluent setter for nullable
Schema	Schema.withOneOf(List<Schema> oneOf)	Fluent setter for oneOf
Schema	Schema.withProperties(Map<String,Schema> properties)	Fluent setter for properties
Schema	Schema.withProperty(String key, Schema schema)	Fluent setter for properties
Schema	Schema.withReadOnly(Boolean readOnly)	Fluent setter for readOnly
Schema	Schema.withRef(String ref)	Fluent setter for ref
Schema	Schema.withRefToSchema(String componentName)
Schema	Schema.withType(Type type)	Fluent setter for type

Methods in com.kingsrook.qqq.openapi.model that return types with arguments of type Schema

Modifier and Type	Method	Description
List<Schema>	Schema.getAllOf()	Getter for allOf
List<Schema>	Schema.getAnyOf()	Getter for anyOf
List<Schema>	Schema.getOneOf()	Getter for oneOf
Map<String,Schema>	Schema.getProperties()	Getter for properties
Map<String,Schema>	Components.getSchemas()	Getter for schemas

Methods in com.kingsrook.qqq.openapi.model with parameters of type Schema

Modifier and Type	Method	Description
void	Schema.setAdditionalProperties(Schema additionalProperties)	Setter for additionalProperties
void	Schema.setItems(Schema items)	Setter for items
void	Content.setSchema(Schema schema)	Setter for schema
void	Parameter.setSchema(Schema schema)	Setter for schema
Schema	Schema.withAdditionalProperties(Schema additionalProperties)	Fluent setter for additionalProperties
Schema	Schema.withItems(Schema items)	Fluent setter for items
Schema	Schema.withProperty(String key, Schema schema)	Fluent setter for properties
Content	Content.withSchema(Schema schema)	Fluent setter for schema
Parameter	Parameter.withSchema(Schema schema)	Fluent setter for schema

Method parameters in com.kingsrook.qqq.openapi.model with type arguments of type Schema

Modifier and Type	Method	Description
void	Schema.setAllOf(List<Schema> allOf)	Setter for allOf
void	Schema.setAnyOf(List<Schema> anyOf)	Setter for anyOf
void	Schema.setOneOf(List<Schema> oneOf)	Setter for oneOf
void	Schema.setProperties(Map<String,Schema> properties)	Setter for properties
void	Components.setSchemas(Map<String,Schema> schemas)	Setter for schemas
Schema	Schema.withAllOf(List<Schema> allOf)	Fluent setter for allOf
Schema	Schema.withAnyOf(List<Schema> anyOf)	Fluent setter for anyOf
Schema	Schema.withOneOf(List<Schema> oneOf)	Fluent setter for oneOf
Schema	Schema.withProperties(Map<String,Schema> properties)	Fluent setter for properties
Components	Components.withSchemas(Map<String,Schema> schemas)	Fluent setter for schemas