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

Packages that use Parameter

Package	Description
com.kingsrook.qqq.esb.api.specs
com.kingsrook.qqq.middleware.javalin.health
com.kingsrook.qqq.middleware.javalin.specs
com.kingsrook.qqq.middleware.javalin.specs.v1
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 Parameter in com.kingsrook.qqq.esb.api.specs

Methods in com.kingsrook.qqq.esb.api.specs that return Parameter

Modifier and Type	Method	Description
static Parameter	EsbSpecSupport.pathParameter(String name, String description)	a required string path parameter
static Parameter	EsbSpecSupport.queryParameter(String name, String description, Type type)	an optional query parameter

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

Modifier and Type	Method	Description
List<Parameter>	EsbDeadLettersSpecV1.defineRequestParameters()
List<Parameter>	EsbMessagesSpecV1.defineRequestParameters()
List<Parameter>	EsbOverviewSpecV1.defineRequestParameters()
List<Parameter>	EsbProcessSpecV1.defineRequestParameters()
List<Parameter>	EsbTableSpecV1.defineRequestParameters()
static List<Parameter>	EsbSpecSupport.pagingParameters()	the offset and limit paging parameters

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

Methods in com.kingsrook.qqq.middleware.javalin.health that return Parameter

Modifier and Type	Method	Description
protected Parameter	HealthSpecSupport.nameParameter()	Shared path parameter.

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

Modifier and Type	Method	Description
List<Parameter>	HealthComponentSpecV1.defineRequestParameters()	Parameters declared in the extension contract.
List<Parameter>	HealthHistorySpecV1.defineRequestParameters()	Parameters declared in the extension contract.
List<Parameter>	HealthRunSpecV1.defineRequestParameters()	Parameters declared in the extension contract.
List<Parameter>	HealthSummarySpecV1.defineRequestParameters()	Parameters declared in the extension contract.

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

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

Modifier and Type	Method	Description
List<Parameter>	AbstractEndpointSpec.defineRequestParameters()

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

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

Modifier and Type	Method	Description
List<Parameter>	BulkLoadSuggestMappingSpecV1.defineRequestParameters()
List<Parameter>	BulkLoadUploadProfileSpecV1.defineRequestParameters()
List<Parameter>	BulkLoadValidateSpecV1.defineRequestParameters()
List<Parameter>	GeneralDownloadSpecV1.defineRequestParameters()
List<Parameter>	HelpCoverageSpecV1.defineRequestParameters()	Query parameters.
List<Parameter>	HelpSearchSpecV1.defineRequestParameters()	Query parameters.
List<Parameter>	JobsSpecV1.defineRequestParameters()	Typed query and path parameters.
List<Parameter>	ManageSessionSpecV1.defineRequestParameters()
List<Parameter>	MetaDataSpecV1.defineRequestParameters()
List<Parameter>	PreferenceSectionActionSpecV1.defineRequestParameters()	Path parameters; userId query parameters are never read.
List<Parameter>	PreferenceSectionGetSpecV1.defineRequestParameters()	Path parameters; userId query parameters are never read.
List<Parameter>	PreferenceSectionPatchSpecV1.defineRequestParameters()	Path parameters; userId query parameters are never read.
List<Parameter>	PreferencesSpecV1.defineRequestParameters()	Path parameters; userId query parameters are never read.
List<Parameter>	ProcessCancelSpecV1.defineRequestParameters()
List<Parameter>	ProcessInitSpecV1.defineRequestParameters()
List<Parameter>	ProcessJobLaunchSpecV1.defineRequestParameters()
List<Parameter>	ProcessMetaDataSpecV1.defineRequestParameters()
List<Parameter>	ProcessPossibleValuesSpecV1.defineRequestParameters()
List<Parameter>	ProcessRecordsSpecV1.defineRequestParameters()
List<Parameter>	ProcessStatusSpecV1.defineRequestParameters()
List<Parameter>	ProcessStepSpecV1.defineRequestParameters()
List<Parameter>	RealtimeStreamSpecV1.defineRequestParameters()	A reconnect cursor never grants ownership of another session connection.
List<Parameter>	RecordAssociatedScriptLogsSpecV1.defineRequestParameters()
List<Parameter>	RecordAssociatedScriptStoreSpecV1.defineRequestParameters()
List<Parameter>	RecordDeveloperModeSpecV1.defineRequestParameters()
List<Parameter>	RecordDeveloperPanelsSpecV1.defineRequestParameters()
List<Parameter>	RecordFieldDownloadSpecV1.defineRequestParameters()
List<Parameter>	RelatedRecordPickerAddSpecV1.defineRequestParameters()
List<Parameter>	RelatedRecordPickerPrepareSpecV1.defineRequestParameters()
List<Parameter>	RelatedRecordPickerQuerySpecV1.defineRequestParameters()
List<Parameter>	RelatedRecordPickerRemoveSpecV1.defineRequestParameters()
List<Parameter>	ReportRunSpecV1.defineRequestParameters()
List<Parameter>	StandalonePossibleValuesSpecV1.defineRequestParameters()
List<Parameter>	TableApiDocumentSpecV1.defineRequestParameters()
List<Parameter>	TableApisSpecV1.defineRequestParameters()
List<Parameter>	TableCountSpecV1.defineRequestParameters()
List<Parameter>	TableDeleteSpecV1.defineRequestParameters()
List<Parameter>	TableExportSpecV1.defineRequestParameters()
List<Parameter>	TableFormAdjusterSpecV1.defineRequestParameters()
List<Parameter>	TableGetSpecV1.defineRequestParameters()
List<Parameter>	TableInsertSpecV1.defineRequestParameters()
List<Parameter>	TableMetaDataSpecV1.defineRequestParameters()
List<Parameter>	TablePossibleValuesSpecV1.defineRequestParameters()
List<Parameter>	TableQuerySpecV1.defineRequestParameters()
List<Parameter>	TableRecordFeaturesSpecV1.defineRequestParameters()
List<Parameter>	TableUpdateSpecV1.defineRequestParameters()
List<Parameter>	TableVariantsSpecV1.defineRequestParameters()
List<Parameter>	UploadsSpecV1.defineRequestParameters()
List<Parameter>	WidgetSpecV1.defineRequestParameters()

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

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

Modifier and Type	Method	Description
static Parameter	ProcessSpecUtilsV1.defineTableVariantQueryParameter()	OpenAPI definition of the (optional) tableVariant query parameter.

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

Modifier and Type	Method	Description
static List<Parameter>	UserPreferencesSpecUtils.actionParameters()	Action and section names come only from the URL path.
static List<Parameter>	RelatedRecordPickerSpecUtils.defineRequestParameters()	The tableName and pickerName path parameters.
static List<Parameter>	UserPreferencesSpecUtils.sectionParameters()	Section name comes only from the URL path.

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

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

Modifier and Type	Method	Description
Parameter	Parameter.withDescription(String description)	Fluent setter for description
Parameter	Parameter.withExample(Example example)	Fluent setter for example
Parameter	Parameter.withExample(String example)	Fluent setter for example
Parameter	Parameter.withExamples(Map<String,Example> examples)	Fluent setter for examples
Parameter	Parameter.withExplode(Boolean explode)	Fluent setter for explode
Parameter	Parameter.withIn(In in)	Fluent setter for in
Parameter	Parameter.withName(String name)	Fluent setter for name
Parameter	Parameter.withRequired(Boolean required)	Fluent setter for required
Parameter	Parameter.withSchema(Schema schema)	Fluent setter for schema

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

Modifier and Type	Method	Description
List<Parameter>	Method.getParameters()	Getter for parameters

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

Modifier and Type	Method	Description
void	Method.setParameters(List<Parameter> parameters)	Setter for parameters
Method	Method.withParameters(List<Parameter> parameters)	Fluent setter for parameters