org.springdoc.core.fn.builders.header

Class Builder

java.lang.Object

org.springdoc.core.fn.builders.header.Builder

public class Builder
extends Object

The type Header builder.

Author:

bnasslahsen

Method Summary

Modifier and Type	Method and Description
io.swagger.v3.oas.annotations.headers.Header	build() Build header.
Builder	deprecated(boolean deprecated) Deprecated header builder.
Builder	description(String description) Description header builder.
static Builder	headerBuilder() Builder header builder.
Builder	name(String name) Name header builder.
Builder	ref(String ref) Ref header builder.
Builder	required(boolean required) Required header builder.
Builder	schema(Builder schemaBuilder) Schema header builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

headerBuilder

public static Builder headerBuilder()

Builder header builder.

Returns:

the header builder

name

public Builder name(String name)

Name header builder.

Parameters:

name - the name

Returns:

the header builder

description

public Builder description(String description)

Description header builder.

Parameters:

description - the description

Returns:

the header builder

schema

public Builder schema(Builder schemaBuilder)

Schema header builder.

Parameters:

schemaBuilder - the schema builder

Returns:

the header builder

required

public Builder required(boolean required)

Required header builder.

Parameters:

required - the required

Returns:

the header builder

deprecated

public Builder deprecated(boolean deprecated)

Deprecated header builder.

Parameters:

deprecated - the deprecated

Returns:

the header builder

ref

public Builder ref(String ref)

Ref header builder.

Parameters:

ref - the ref

Returns:

the header builder

build

public io.swagger.v3.oas.annotations.headers.Header build()

Build header.

Returns:

the header