Home Parameter Class
Parameter Class
Cancel

Parameter Class

Namespace: Json.Schema.Api.OpenApi

Inheritance: Parameter 🡒 object

Implemented interfaces:

  • IRefTargetContainer

Models a parameter.

Properties

NameTypeSummary
AllowEmptyValuebool?Gets or sets whether the parameter is allowed to be present with an empty value.
AllowReservedbool?Gets or sets whether the parameter value should allow reserved characters.
ContentDictionary<string, MediaType>Gets or sets a collection of content.
Deprecatedbool?Gets or sets whether the parameter is deprecated.
DescriptionstringGets or sets the description.
ExampleJsonNodeGets or sets an example.
ExamplesDictionary<string, Example>Gets or sets a collection of examples.
Explodebool?Gets or sets whether this will be exploded into multiple parameters.
ExtensionDataExtensionDataGets or set extension data.
InParameterLocationGets the parameter location.
NamestringGets the name.
Requiredbool?Gets or sets whether the parameter is required.
SchemaJsonSchemaGets or sets a schema for the content.
StyleParameterStyle?Gets or sets how the parameter value will be serialized.
UnknownDataUnknownDataGets or sets properties which are not recognized by OpenAPI.

Constructors

Parameter(string name, ParameterLocation in)

Declaration

1
public Parameter(string name, ParameterLocation in)
ParameterTypeDescription
namestringThe name
inParameterLocationThe parameter location
Contents