Package 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 Details

    • 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

    • explode

      public Builder explode(io.swagger.v3.oas.annotations.enums.Explode val)
      Explode builder.
      Parameters:
      val - the val
      Returns:
      the builder

    • hidden

      public Builder hidden(boolean val)
      Hidden builder.
      Parameters:
      val - the val
      Returns:
      the builder

    • example

      public Builder example(String val)
      Example builder.
      Parameters:
      val - the val
      Returns:
      the builder

    • examples

      public Builder examples(io.swagger.v3.oas.annotations.media.ExampleObject[] val)
      Examples builder.
      Parameters:
      val - the val
      Returns:
      the builder

    • build

      public io.swagger.v3.oas.annotations.headers.Header build()
      Build header.
      Returns:
      the header