@Version(value="1.0")

# Package org.eclipse.microprofile.openapi.models.headers

An interface of a programmable model to represent a single header object.

See: Description

Interface Summary
Header: Header

Enum Summary
Header.Style: Controls the style of serialization.

## Package org.eclipse.microprofile.openapi.models.headers Description

An interface of a programmable model to represent a single header object.

The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.

Example usage:

     .components(OASFactory.createObject(Components.class)
      .headers(new HashMap<String, Header>())
              .addHeader("Max-Rate", OASFactory.createObject(Header.class)
                  .description("Maximum rate")
                  .schema(OASFactory.createObject(Schema.class)
                      .type(Schema.SchemaType.INTEGER))
                  .required(true)
                  .allowEmptyValue(true)
                  .deprecated(true))
              .addHeader("Request-Limit", OASFactory.createObject(Header.class)
                  .description("The number of allowed requests in the current period")
                  .schema(OASFactory.createObject(Schema.class)
                      .type(Schema.SchemaType.INTEGER)))