public class HeaderObjectBuilder extends Object
| Constructor and Description |
|---|
HeaderObjectBuilder() |
| Modifier and Type | Method and Description |
|---|---|
HeaderObject |
build() |
static HeaderObjectBuilder |
headerObject()
Creates a builder for a
HeaderObject |
HeaderObjectBuilder |
withContent(Map<String,MediaTypeObject> content) |
HeaderObjectBuilder |
withDeprecated(boolean deprecated) |
HeaderObjectBuilder |
withDescription(String description) |
HeaderObjectBuilder |
withExample(Object example) |
HeaderObjectBuilder |
withExamples(Map<String,ExampleObject> examples) |
HeaderObjectBuilder |
withExplode(String explode) |
HeaderObjectBuilder |
withRequired(boolean required) |
HeaderObjectBuilder |
withSchema(SchemaObject schema) |
HeaderObjectBuilder |
withStyle(String style) |
public HeaderObjectBuilder withDescription(String description)
description - A brief description of the header. This could contain examples of use.
CommonMark syntax MAY be used for rich text representation.public HeaderObjectBuilder withRequired(boolean required)
required - Determines whether this header is mandatory. The default value is false.public HeaderObjectBuilder withDeprecated(boolean deprecated)
deprecated - Specifies that a header is deprecated and SHOULD be transitioned out of usage.public HeaderObjectBuilder withStyle(String style)
style - Describes how the parameter value will be serialized depending on the type of the parameter value.
Default value is simple.
In order to support common ways of serializing simple parameters, a set of style values are defined.
style |
type |
Comments |
|---|---|---|
| simple | array |
Simple style parameters defined by RFC6570. This option replaces collectionFormat with a csv value from OpenAPI 2.0. |
public HeaderObjectBuilder withExplode(String explode)
explode - When this is true, parameter values of type array or object generate
separate parameters for each value of the array or key-value pair of the map. For other types
of parameters this property has no effect. When style is form, the
default value is true. For all other styles, the default value is false.public HeaderObjectBuilder withSchema(SchemaObject schema)
schema - The schema defining the type used for the header.public HeaderObjectBuilder withExample(Object example)
example - Example of the media type. The example SHOULD match the specified schema and encoding properties
if present. The example field is mutually exclusive of the examples
field. Furthermore, if referencing a schema which contains an example, the
example value SHALL override the example provided by the schema.
To represent examples of media types that cannot naturally be represented in JSON or YAML,
a string value can contain the example with escaping where necessary.public HeaderObjectBuilder withExamples(Map<String,ExampleObject> examples)
examples - Examples of the media type. Each example SHOULD contain a value in the correct format as
specified in the parameter encoding. The examples field is mutually exclusive
of the example field. Furthermore, if referencing a schema which
contains an example, the examples value SHALL override the example
provided by the schema.public HeaderObjectBuilder withContent(Map<String,MediaTypeObject> content)
content - A map containing the representations for the parameter. The key is the media type and the value describes it.
The map MUST only contain one entry.public HeaderObject build()
public static HeaderObjectBuilder headerObject()
HeaderObjectCopyright © 2017–2019. All rights reserved.