Package com.kingsrook.qqq.middleware.javalin.specs.v1
package com.kingsrook.qqq.middleware.javalin.specs.v1
-
ClassDescriptionEndpoint spec for OIDC Back-Channel Logout.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).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).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).Spec for the general file download endpoint (GET /download/{file}).HelpCoverageSpecV1 contract.HelpSearchSpecV1 contract.Endpoint spec for logging out a session.Version 1 of the QQQ UI API (`/qqq/v1`).Run an action on the signed-in user's preferences.Read one visible section for the signed-in user.Partially update the signed-in user's preferences.List visible sections and the signed-in user's preferences.Endpoint spec for cancelling a running process.POST /processes/{processName}/jobs: run any eligible process as a durable job ("Run in background").Spec for searching possible values for a field on a process.Endpoint spec for fetching records from a process state.Authenticated v1 SSE stream.Change channels on a connection belonging to the authenticated session.Get the logs of a revision of a record's associated script (developer mode).Store a new revision of a record's associated script (developer mode).Record "developer mode": a record, with its table's associated scripts (the script the record references, its revisions, and fields for testing).GET /table/{tableName}/{primaryKey}/developer/panels - the panels that developer panel providers (built-in, modules, qbits) contribute to a record's developer view.Spec for the record field download endpoint (GET /table/{tableName}/{primaryKey}/{fieldName}/{filename}).POST /search - record search across the tables that declare search fields.POST /table/{tableName}/relatedRecordPicker/{pickerName}/add (docs/RELATED-RECORD-PICKER.md).POST /table/{tableName}/relatedRecordPicker/{pickerName}/prepare (docs/RELATED-RECORD-PICKER.md).POST /table/{tableName}/relatedRecordPicker/{pickerName}/query (docs/RELATED-RECORD-PICKER.md).POST /table/{tableName}/relatedRecordPicker/{pickerName}/remove (docs/RELATED-RECORD-PICKER.md).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.Spec for searching a standalone possible value source (not associated with a specific table or process field).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.Lists the application (model) APIs that expose a table, for GET /qqq/v1/table/{tableName}/apis (TableApisSpecV1).One API that exposes the table.One version of an API.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.Spec for the table export endpoint (POST /table/{tableName}/export).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).Spec for searching possible values for a field on a table.Spec for listing the variants of a table whose backend uses variants (GET /table/{tableName}/variants) - the v1 form of the legacy variants route.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.GET /version - the UI API semantic version, features and extensions.Endpoint spec for rendering a widget via POST.