# Deprecated API

## Contents

- Terminally Deprecated
- Methods
- Annotation Type Elements

Terminally Deprecated Elements
Element
Description
org.eclipse.microprofile.openapi.annotations.headers.Header.allowEmptyValue()
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.
org.eclipse.microprofile.openapi.models.headers.Header.allowEmptyValue(Boolean)
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.
org.eclipse.microprofile.openapi.models.headers.Header.getAllowEmptyValue()
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.
org.eclipse.microprofile.openapi.models.headers.Header.setAllowEmptyValue(Boolean)
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.

Deprecated Methods
Method
Description
org.eclipse.microprofile.openapi.annotations.headers.Header.allowEmptyValue()
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.
org.eclipse.microprofile.openapi.annotations.media.Schema.example()
use `Schema.examples()`
org.eclipse.microprofile.openapi.annotations.media.SchemaProperty.example()
use `SchemaProperty.examples()`
org.eclipse.microprofile.openapi.models.headers.Header.allowEmptyValue(Boolean)
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.
org.eclipse.microprofile.openapi.models.headers.Header.getAllowEmptyValue()
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.
org.eclipse.microprofile.openapi.models.headers.Header.setAllowEmptyValue(Boolean)
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.
org.eclipse.microprofile.openapi.models.media.Schema.additionalPropertiesBoolean(Boolean)
use `Schema.additionalPropertiesSchema(Schema)` with a boolean-valued schema
org.eclipse.microprofile.openapi.models.media.Schema.example(Object)
use `Schema.examples(List)`
org.eclipse.microprofile.openapi.models.media.Schema.getAdditionalPropertiesBoolean()
use `Schema.getAdditionalPropertiesSchema()` which may return a boolean-valued schema
org.eclipse.microprofile.openapi.models.media.Schema.getExample()
use `Schema.getExamples()`
org.eclipse.microprofile.openapi.models.media.Schema.setAdditionalPropertiesBoolean(Boolean)
use `Schema.setAdditionalPropertiesSchema(Schema)` with a boolean-valued schema
org.eclipse.microprofile.openapi.models.media.Schema.setExample(Object)
use `Schema.setExamples(List)`

Deprecated Annotation Type Elements
Annotation Type Element
Description
org.eclipse.microprofile.openapi.annotations.headers.Header.allowEmptyValue()
The OpenAPI specification states that `allowEmptyValue` is only valid for `query` parameters. As the `Header` model is a specialized `Parameter`, this attribute is not valid and should not be used. Removal of this property is planned for the next major release of MicroProfile OpenAPI.
org.eclipse.microprofile.openapi.annotations.media.Schema.example()
use `Schema.examples()`
org.eclipse.microprofile.openapi.annotations.media.SchemaProperty.example()
use `SchemaProperty.examples()`