OpenApiHeaderReference Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: OpenApiHeaderReference.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.

Header Object Reference.

public class OpenApiHeaderReference : Microsoft.OpenApi.BaseOpenApiReferenceHolder<Microsoft.OpenApi.OpenApiHeader,Microsoft.OpenApi.IOpenApiHeader,Microsoft.OpenApi.OpenApiReferenceWithDescription>, Microsoft.OpenApi.IOpenApiHeader, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiHeader>

type OpenApiHeaderReference = class
    inherit BaseOpenApiReferenceHolder<OpenApiHeader, IOpenApiHeader, OpenApiReferenceWithDescription>
    interface IOpenApiHeader
    interface IOpenApiDescribedElement
    interface IOpenApiElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiHeader>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Class OpenApiHeaderReference
Inherits BaseOpenApiReferenceHolder(Of OpenApiHeader, IOpenApiHeader, OpenApiReferenceWithDescription)
Implements IOpenApiHeader, IShallowCopyable(Of IOpenApiHeader)

Inheritance: Object

BaseOpenApiReferenceHolder<OpenApiHeader,IOpenApiHeader,OpenApiReferenceWithDescription>
OpenApiHeaderReference

Implements: IOpenApiDescribedElement IOpenApiElement IOpenApiHeader IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IShallowCopyable<IOpenApiHeader>

Constructors

Name	Description
OpenApiHeaderReference(String, OpenApiDocument, String)	Constructor initializing the reference object.

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.
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.
RecursiveTarget	Gets the recursively resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Reference	Reference object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
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.
Target	Gets the resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data (Inherited from BaseOpenApiReferenceHolder<T,U,V>)

Methods

Name	Description
CopyReference(OpenApiReferenceWithDescription)	Copy the reference as a target element with overrides.
CopyReference(V)	Copy the reference as a target element with overrides. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
CopyReferenceAsTargetElementWithOverrides(IOpenApiHeader)	Copy the reference as a target element with overrides.
CopyReferenceAsTargetElementWithOverrides(U)	Copy the reference as a target element with overrides. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
CreateShallowCopy()	Create a shallow copy of the current instance.
SerializeAsV2(IOpenApiWriter)	Serialize Open API element to v2.0. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV3(IOpenApiWriter)	Serialize Open API element to v3.0. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV31(IOpenApiWriter)	Serialize OpenAPI element into v3.1 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV32(IOpenApiWriter)	Serialize OpenAPI element into v3.2 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)

Extension Methods

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

Applies to

Share via