Sisk

Class

ApiEndpointParameterExample

Namespace
Sisk.Documenting
Assembly
Sisk.Documenting.dll

Represents an example value for a request parameter in a specific situation.

C#
public sealed class ApiEndpointParameterExample

Inheritance #

object ← ApiEndpointParameterExample

Inherited Members #

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties #

NameDescription
DescriptionGets the optional description of when or why the example applies.
ExampleGets the example parameter value.
ExampleLanguageGets the language used to format the example value, if applicable.
ParameterNameGets the name of the parameter to which the example applies.
TitleGets the title that identifies the situation illustrated by the example.

Type to search the documentation and the API reference.