OpenApiEncoding Class

Reference

Definition

Namespace:: Microsoft.OpenApi.Models

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v1.6.0

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.

ExternalDocs object.

public class OpenApiEncoding : Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable

type OpenApiEncoding = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible

Public Class OpenApiEncoding
Implements IOpenApiExtensible, IOpenApiSerializable

Inheritance: Object
OpenApiEncoding

Implements: IOpenApiElement IOpenApiExtensible IOpenApiSerializable

Constructors

OpenApiEncoding()	Parameter-less constructor
OpenApiEncoding(OpenApiEncoding)	Initializes a copy of an OpenApiEncoding object

Properties

AllowReserved	Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
ContentType	The Content-Type for encoding a specific property. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.
Explode	When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
Extensions	This object MAY be extended with Specification Extensions.
Headers	A map allowing additional information to be provided as headers.
Style	Describes how a specific property value will be serialized depending on its type.

Methods

SerializeAsV2(IOpenApiWriter)	Serialize OpenApiExternalDocs to Open Api v2.0.
SerializeAsV3(IOpenApiWriter)	Serialize OpenApiExternalDocs to Open Api v3.0.

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)

Validate element and all child elements

Applies to

Share via