Uses of Class
com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

Packages that use AbstractEndpointSpec

Package	Description
com.kingsrook.qqq.api.middleware.specs.v1
com.kingsrook.qqq.esb.api.specs
com.kingsrook.qqq.middleware.javalin.health
com.kingsrook.qqq.middleware.javalin.specs
com.kingsrook.qqq.middleware.javalin.specs.extensions
com.kingsrook.qqq.middleware.javalin.specs.v1

Uses of AbstractEndpointSpec in com.kingsrook.qqq.api.middleware.specs.v1

Subclasses of AbstractEndpointSpec in com.kingsrook.qqq.api.middleware.specs.v1

Modifier and Type	Class	Description
class	ApiAwareTableCountSpecV1
class	ApiAwareTableMetaDataSpecV1
class	ApiAwareTableQuerySpecV1

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

Modifier and Type	Method	Description
List<AbstractEndpointSpec<?,?,?>>	ApiAwareMiddlewareVersionV1.defineEndpointSpecs()
List<AbstractEndpointSpec<?,?,?>>	ApiAwareMiddlewareVersionV1.getEndpointSpecs()

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

Subclasses of AbstractEndpointSpec in com.kingsrook.qqq.esb.api.specs

Modifier and Type	Class	Description
class	EsbDeadLettersSpecV1	GET /esb/deadLetters/{trigger} - Dead letters of a trigger
class	EsbMessagesSpecV1	GET /esb/messages/{destination} - Messages on a destination
class	EsbOverviewSpecV1	GET /esb/overview - ESB overview
class	EsbProcessSpecV1	GET /esb/process/{process} - ESB of a process
static class	EsbSpecSupport.AbstractEsbSpecV1	base of the ESB specs: secured, tagged, JSON written with nulls kept (as the route provider before them did), success schema per operation.
class	EsbTableSpecV1	GET /esb/table/{table} - ESB of a table

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

Subclasses of AbstractEndpointSpec in com.kingsrook.qqq.middleware.javalin.health

Modifier and Type	Class	Description
class	HealthComponentSpecV1	GET /health/components/{name}.
class	HealthHistorySpecV1	GET /health/checks/{name}/history.
class	HealthRunSpecV1	POST /health/checks/{name}/run.
class	HealthSpecSupport	Shared secured table projections.
class	HealthSummarySpecV1	GET /health/summary.

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

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

Modifier and Type	Method	Description
List<AbstractEndpointSpec<?,?,?>>	AbstractMiddlewareVersion.getAllEndpointSpecs()	The core specs plus the specs registered by extensions, in route order.
abstract List<AbstractEndpointSpec<?,?,?>>	AbstractMiddlewareVersion.getEndpointSpecs()	hey - don't re-construct the endpoint-spec objects inside this method...

Methods in com.kingsrook.qqq.middleware.javalin.specs with parameters of type AbstractEndpointSpec

Modifier and Type	Method	Description
void	AbstractMiddlewareVersion.warnIfPathMethodAlreadyUsed(Method existing, CompleteOperation completeOperation, AbstractEndpointSpec<?,?,?> spec)

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

Subclasses of AbstractEndpointSpec in com.kingsrook.qqq.middleware.javalin.specs.extensions

Modifier and Type	Class	Description
class	AbstractJsonEndpointSpec	Base for extension endpoint specs whose request is path/query parameters and an optional JSON object body, and whose response is a JSON value - the common shape of module and qbit endpoints.

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

Modifier and Type	Method	Description
static AbstractEndpointSpec<?,?,?>	MiddlewareSpecExtensionsMetaData.instantiateSpec(QCodeReference reference)	Instantiate one spec reference.

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

Modifier and Type	Method	Description
List<AbstractEndpointSpec<?,?,?>>	MiddlewareSpecExtensionsMetaData.instantiateAllSpecs()	The specs of every extension, instantiated, in registration order.

Method parameters in com.kingsrook.qqq.middleware.javalin.specs.extensions with type arguments of type AbstractEndpointSpec

Modifier and Type	Method	Description
MiddlewareSpecExtension	MiddlewareSpecExtension.withSpec(Class<? extends AbstractEndpointSpec<?,?,?>> specClass)	Add a spec class.

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

Subclasses of AbstractEndpointSpec in com.kingsrook.qqq.middleware.javalin.specs.v1

Modifier and Type	Class	Description
class	AuthenticationMetaDataSpecV1
class	BackChannelLogoutSpecV1	Endpoint spec for OIDC Back-Channel Logout.
class	BulkLoadSuggestMappingSpecV1	POST /bulkLoad/{tableName}/suggestMapping: core's suggested bulk load profile for an uploaded file's header row (assisted bulk load, design spec #1171 section 3.2).
class	BulkLoadUploadProfileSpecV1	GET /bulkLoad/uploads/{uploadRef}/profile: the header guess and column profiles of an uploaded file, for a target table (assisted bulk load, design spec #1171 section 3.2).
class	BulkLoadValidateSpecV1	POST /bulkLoad/{tableName}/validate: a dry run of a bulk load profile over an uploaded file, through the table's real bulk-insert process, stopping before anything is stored (assisted bulk load, design spec #1171 section 3.2).
class	GeneralDownloadSpecV1	Spec for the general file download endpoint (GET /download/{file}).
class	HelpCoverageSpecV1	HelpCoverageSpecV1 contract.
class	HelpSearchSpecV1	HelpSearchSpecV1 contract.
class	JobsSpecV1	Jobs tray, detail, polling and actions, registered only with the jobs tables.
class	LogoutSpecV1	Endpoint spec for logging out a session.
class	ManageSessionSpecV1
class	MetaDataSpecV1
class	PreferenceSectionActionSpecV1	Run an action on the signed-in user's preferences.
class	PreferenceSectionGetSpecV1	Read one visible section for the signed-in user.
class	PreferenceSectionPatchSpecV1	Partially update the signed-in user's preferences.
class	PreferencesSpecV1	List visible sections and the signed-in user's preferences.
class	ProcessCancelSpecV1	Endpoint spec for cancelling a running process.
class	ProcessInitSpecV1
class	ProcessJobLaunchSpecV1	POST /processes/{processName}/jobs: run any eligible process as a durable job ("Run in background").
class	ProcessMetaDataSpecV1
class	ProcessPossibleValuesSpecV1	Spec for searching possible values for a field on a process.
class	ProcessRecordsSpecV1	Endpoint spec for fetching records from a process state.
class	ProcessStatusSpecV1
class	ProcessStepSpecV1
class	RealtimeStreamSpecV1	Authenticated v1 SSE stream.
class	RealtimeSubscriptionsSpecV1	Change channels on a connection belonging to the authenticated session.
class	RecordAssociatedScriptLogsSpecV1	Get the logs of a revision of a record's associated script (developer mode).
class	RecordAssociatedScriptStoreSpecV1	Store a new revision of a record's associated script (developer mode).
class	RecordDeveloperModeSpecV1	Record "developer mode": a record, with its table's associated scripts (the script the record references, its revisions, and fields for testing).
class	RecordDeveloperPanelsSpecV1	GET /table/{tableName}/{primaryKey}/developer/panels - the panels that developer panel providers (built-in, modules, qbits) contribute to a record's developer view.
class	RecordFieldDownloadSpecV1	Spec for the record field download endpoint (GET /table/{tableName}/{primaryKey}/{fieldName}/{filename}).
class	RecordSearchSpecV1	POST /search - record search across the tables that declare search fields.
class	RelatedRecordPickerAddSpecV1	POST /table/{tableName}/relatedRecordPicker/{pickerName}/add (docs/RELATED-RECORD-PICKER.md).
class	RelatedRecordPickerPrepareSpecV1	POST /table/{tableName}/relatedRecordPicker/{pickerName}/prepare (docs/RELATED-RECORD-PICKER.md).
class	RelatedRecordPickerQuerySpecV1	POST /table/{tableName}/relatedRecordPicker/{pickerName}/query (docs/RELATED-RECORD-PICKER.md).
class	RelatedRecordPickerRemoveSpecV1	POST /table/{tableName}/relatedRecordPicker/{pickerName}/remove (docs/RELATED-RECORD-PICKER.md).
class	ReportRunSpecV1	Spec for running a report and downloading the generated file (GET /reports/{reportName}) - the v1 form of the legacy streaming report route, for reports that are not run through a process.
class	StandalonePossibleValuesSpecV1	Spec for searching a standalone possible value source (not associated with a specific table or process field).
class	TableApiDocumentSpecV1	GET /table/{tableName}/apis/{apiName}/{version}/openapi: the table's OpenAPI document in one version of an application API (one listed by GET /table/{tableName}/apis), for the developer views - so they read it through the UI API rather than from the API middleware's {api.path}{version}/{table}/openapi.json.
class	TableApisSpecV1	GET /table/{tableName}/apis: the application (model) APIs that expose a table, with their versions and the path of the table's OpenAPI document in each, for the developer views.
class	TableCountSpecV1
class	TableDeleteSpecV1
class	TableExportSpecV1	Spec for the table export endpoint (POST /table/{tableName}/export).
class	TableFormAdjusterSpecV1	POST /table/{tableName}/formAdjuster/{identifier}/{event}: run a table form's adjuster (the table's on-load adjuster, identifier `table:{name}`, or a field's on-load / on-change adjuster, by its formAdjusterIdentifier).
class	TableGetSpecV1
class	TableInsertSpecV1
class	TableMetaDataSpecV1
class	TablePossibleValuesSpecV1	Spec for searching possible values for a field on a table.
class	TableQuerySpecV1
class	TableRecordFeaturesSpecV1
class	TableUpdateSpecV1
class	TableVariantsSpecV1	Spec for listing the variants of a table whose backend uses variants (GET /table/{tableName}/variants) - the v1 form of the legacy variants route.
class	UploadsSpecV1	POST /uploads: stream a file into the uploads storage table and get an opaque UploadRef (spec section 3.2) to pass to a job launch (uploadRefs) or to the bulk-load operations.
class	VersionSpecV1	GET /version - the UI API semantic version, features and extensions.
class	WidgetSpecV1	Endpoint spec for rendering a widget via POST.

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

Modifier and Type	Method	Description
List<AbstractEndpointSpec<?,?,?>>	MiddlewareVersionV1.getEndpointSpecs()