IOpenApiHeader Interface

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: IOpenApiHeader.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the base properties for the headers object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

public interface IOpenApiHeader : Microsoft.OpenApi.IOpenApiDescribedElement, Microsoft.OpenApi.IOpenApiReadOnlyExtensible, Microsoft.OpenApi.IOpenApiReferenceable, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiHeader>

type IOpenApiHeader = interface
    interface IOpenApiDescribedElement
    interface IOpenApiElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiHeader>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Interface IOpenApiHeader
Implements IOpenApiDescribedElement, IOpenApiReadOnlyExtensible, IOpenApiReferenceable, IShallowCopyable(Of IOpenApiHeader)

Derived: Microsoft.OpenApi.OpenApiHeader

Microsoft.OpenApi.OpenApiHeaderReference

Implements: IOpenApiDescribedElement IOpenApiElement IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IShallowCopyable<IOpenApiHeader>

Properties

Name	Description
AllowEmptyValue	Sets the ability to pass empty-valued headers.
AllowReserved	Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986.
Content	A map containing the representations for the header.
Deprecated	Specifies that a header is deprecated and SHOULD be transitioned out of usage.
Description	Long description for the example. CommonMark syntax MAY be used for rich text representation. (Inherited from IOpenApiDescribedElement)
Example	Example of the media type. You must use the IsJsonNullSentinel(JsonNode) method to check whether Default was assigned a null value in the document. Assign JsonNull to use get null as a serialized value.
Examples	Examples of the media type.
Explode	When this is true, header values of type array or object generate separate parameters for each value of the array or key-value pair of the map.
Extensions	Specification extensions. (Inherited from IOpenApiReadOnlyExtensible)
Required	Determines whether this header is mandatory.
Schema	The schema defining the type used for the request body.
Style	Describes how the header value will be serialized depending on the type of the header value.

Methods

Name	Description
CreateShallowCopy()	Create a shallow copy of the current instance. (Inherited from IShallowCopyable<T>)
SerializeAsV2(IOpenApiWriter)	Serialize Open API element to v2.0. (Inherited from IOpenApiSerializable)
SerializeAsV3(IOpenApiWriter)	Serialize Open API element to v3.0. (Inherited from IOpenApiSerializable)
SerializeAsV31(IOpenApiWriter)	Serialize OpenAPI element into v3.1 (Inherited from IOpenApiSerializable)
SerializeAsV32(IOpenApiWriter)	Serialize OpenAPI element into v3.2 (Inherited from IOpenApiSerializable)

Extension Methods

Name	Description
Validate(IOpenApiElement, ValidationRuleSet)	Validate element and all child elements

Applies to