Home ParameterRef Class
ParameterRef Class
Cancel

ParameterRef Class

Namespace: Json.Schema.Api.OpenApi

Inheritance: ParameterRef 🡒 Parameter 🡒 object

Implemented interfaces:

  • IRefTargetContainer
  • IComponentRef

Models a $ref to 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.
IsResolvedboolGets whether the reference has been resolved.
NamestringGets the name.
RefUriThe URI for the reference.
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.
SummarystringGets or sets the summary.
UnknownDataUnknownDataGets or sets properties which are not recognized by OpenAPI.

Constructors

ParameterRef(Uri reference)

Declaration

1
public ParameterRef(Uri reference)
ParameterTypeDescription
referenceUriThe reference URI

ParameterRef(string reference)

Declaration

1
public ParameterRef(string reference)
ParameterTypeDescription
referencestringThe reference URI
Contents