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

Packages that use Example

Package	Description
com.kingsrook.qqq.api.model.metadata.fields
com.kingsrook.qqq.middleware.javalin.specs
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 Example in com.kingsrook.qqq.api.model.metadata.fields

Methods in com.kingsrook.qqq.api.model.metadata.fields that return Example

Modifier and Type	Method	Description
Example	ApiFieldMetaData.getExample()	Getter for example

Methods in com.kingsrook.qqq.api.model.metadata.fields that return types with arguments of type Example

Modifier and Type	Method	Description
Map<String,Example>	ApiFieldMetaData.getExamples()	Getter for examples

Methods in com.kingsrook.qqq.api.model.metadata.fields with parameters of type Example

Modifier and Type	Method	Description
void	ApiFieldMetaData.setExample(Example example)	Setter for example
ApiFieldMetaData	ApiFieldMetaData.withExample(Example example)	Fluent setter for example

Method parameters in com.kingsrook.qqq.api.model.metadata.fields with type arguments of type Example

Modifier and Type	Method	Description
void	ApiFieldMetaData.setExamples(Map<String,Example> examples)	Setter for examples
ApiFieldMetaData	ApiFieldMetaData.withExamples(Map<String,Example> examples)	Fluent setter for examples

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

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

Modifier and Type	Method	Description
Map<String,Example>	BasicResponse.examples()	Returns the value of the examples record component.

Constructor parameters in com.kingsrook.qqq.middleware.javalin.specs with type arguments of type Example

Modifier	Constructor	Description
	BasicResponse(io.javalin.http.HttpStatus status, String description, String schemaRefName, Map<String,Example> examples)	Constructor
	BasicResponse(String contentType, io.javalin.http.HttpStatus status, String description, String schemaRefName, Map<String,Example> examples)	Creates an instance of a BasicResponse record class.
	BasicResponse(String description, String schemaRefName, Map<String,Example> examples)	Constructor

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

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

Modifier and Type	Method	Description
static LinkedHashMap<String,Example>	ProcessSpecUtilsV1.buildResponseExample()

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

Subclasses of Example in com.kingsrook.qqq.openapi.model

Modifier and Type	Class	Description
class	ExampleWithListValue
class	ExampleWithSingleValue

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

Modifier and Type	Method	Description
Example	Example.withRef(String ref)	Fluent setter for ref
Example	Example.withSummary(String summary)	Fluent setter for summary
Example	Example.withValue(Object value)	Fluent setter for value

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

Modifier and Type	Method	Description
Map<String,Example>	Components.getExamples()	Getter for examples
Map<String,Example>	Content.getExamples()	Getter for examples
Map<String,Example>	Parameter.getExamples()	Getter for examples
Map<String,Example>	Schema.getExamples()	Getter for examples

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

Modifier and Type	Method	Description
void	Parameter.setExample(Example example)	Setter for example
Parameter	Parameter.withExample(Example example)	Fluent setter for example
Schema	Schema.withExample(String name, Example example)	Fluent setter for examples

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

Modifier and Type	Method	Description
void	Components.setExamples(Map<String,Example> examples)	Setter for examples
void	Content.setExamples(Map<String,Example> examples)	Setter for examples
void	Parameter.setExamples(Map<String,Example> examples)	Setter for examples
void	Schema.setExamples(Map<String,Example> examples)	Setter for examples
Components	Components.withExamples(Map<String,Example> examples)	Fluent setter for examples
Content	Content.withExamples(Map<String,Example> examples)	Fluent setter for examples
Parameter	Parameter.withExamples(Map<String,Example> examples)	Fluent setter for examples
Schema	Schema.withExamples(Map<String,Example> examples)	Fluent setter for examples