Class Builder
java.lang.Object
org.springdoc.core.fn.builders.parameter.Builder
The type Parameter builder.
- Author:
- bnasslahsen
-
Method Summary
Modifier and TypeMethodDescriptionallowEmptyValue
(boolean allowEmptyValue) Allow empty value parameter builder.allowReserved
(boolean allowReserved) Allow reserved parameter builder.Array parameter builder.io.swagger.v3.oas.annotations.Parameter
build()
Build parameter.Content parameter builder.deprecated
(boolean deprecated) Deprecated parameter builder.description
(String description) Description parameter builder.Example parameter builder.Examples parameter builder.explode
(io.swagger.v3.oas.annotations.enums.Explode explode) Explode parameter builder.extensions
(Builder extensionBuilder) Extensions parameter builder.hidden
(boolean hidden) Hidden parameter builder.implementation
(Class clazz) Implementation parameter builder.implementationArray
(Class clazz) Implementation array parameter builder.in
(io.swagger.v3.oas.annotations.enums.ParameterIn in) In parameter builder.Name parameter builder.static Builder
Builder parameter builder.Ref parameter builder.required
(boolean required) Required parameter builder.Schema parameter builder.style
(io.swagger.v3.oas.annotations.enums.ParameterStyle style) Style parameter builder.
-
Method Details
-
parameterBuilder
Builder parameter builder.- Returns:
- the parameter builder
-
name
Name parameter builder.- Parameters:
name
- the name- Returns:
- the parameter builder
-
in
In parameter builder.- Parameters:
in
- the in- Returns:
- the parameter builder
-
description
Description parameter builder.- Parameters:
description
- the description- Returns:
- the parameter builder
-
required
Required parameter builder.- Parameters:
required
- the required- Returns:
- the parameter builder
-
deprecated
Deprecated parameter builder.- Parameters:
deprecated
- the deprecated- Returns:
- the parameter builder
-
allowEmptyValue
Allow empty value parameter builder.- Parameters:
allowEmptyValue
- the allow empty value- Returns:
- the parameter builder
-
style
Style parameter builder.- Parameters:
style
- the style- Returns:
- the parameter builder
-
explode
Explode parameter builder.- Parameters:
explode
- the explode- Returns:
- the parameter builder
-
allowReserved
Allow reserved parameter builder.- Parameters:
allowReserved
- the allow reserved- Returns:
- the parameter builder
-
schema
Schema parameter builder.- Parameters:
schemaBuilder
- the schema builder- Returns:
- the parameter builder
-
array
Array parameter builder.- Parameters:
arraySchemaBuilder
- the array schema builder- Returns:
- the parameter builder
-
implementationArray
Implementation array parameter builder.- Parameters:
clazz
- the clazz- Returns:
- the parameter builder
-
implementation
Implementation parameter builder.- Parameters:
clazz
- the clazz- Returns:
- the parameter builder
-
content
Content parameter builder.- Parameters:
contentBuilder
- the content builder- Returns:
- the parameter builder
-
examples
Examples parameter builder.- Parameters:
exampleObjectBuilder
- the example object builder- Returns:
- the parameter builder
-
example
Example parameter builder.- Parameters:
example
- the example- Returns:
- the parameter builder
-
extensions
Extensions parameter builder.- Parameters:
extensionBuilder
- the extension builder- Returns:
- the parameter builder
-
ref
Ref parameter builder.- Parameters:
ref
- the ref- Returns:
- the parameter builder
-
build
public io.swagger.v3.oas.annotations.Parameter build()Build parameter.- Returns:
- the parameter
-