OpenApiParameter Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

Parameter Object.

public class OpenApiParameter : Microsoft.OpenApi.IOpenApiExtensible, Microsoft.OpenApi.IOpenApiParameter, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiParameter>

type OpenApiParameter = class
    interface IOpenApiExtensible
    interface IOpenApiElement
    interface IOpenApiParameter
    interface IOpenApiDescribedElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiParameter>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Class OpenApiParameter
Implements IOpenApiExtensible, IOpenApiParameter, IShallowCopyable(Of IOpenApiParameter)

Inheritance: Object
OpenApiParameter

Implements: IOpenApiDescribedElement IOpenApiElement IOpenApiExtensible IOpenApiParameter IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IShallowCopyable<IOpenApiParameter>

Constructors

Name	Description
OpenApiParameter()	A parameterless constructor

Properties

Name	Description
AllowEmptyValue	Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.
AllowReserved	Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.
Content	A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry. For more complex scenarios, the content property can define the media type and schema of the parameter. A parameter MUST contain either a schema property, or a content property, but not both. When example or examples are provided in conjunction with the schema object, the example MUST follow the prescribed serialization strategy for the parameter.
Deprecated	Specifies that a parameter 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. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. 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. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples object is mutually exclusive of the example object. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.
Explode	When this is true, parameter 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 parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
Extensions	Specification extensions.
In	REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".
Name	REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object. If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored. For all other cases, the name corresponds to the parameter name used by the in property.
Required	Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
Schema	The schema defining the type used for the parameter.
Style	Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Methods

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

Extension Methods

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

Applies to

Share via