# ApiEndpointParameterExample

Kind: Class  
Namespace: `Sisk.Documenting`  
Assembly: `Sisk.Documenting.dll`  
Source: https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpointParameterExample.html

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

```csharp
public sealed class ApiEndpointParameterExample
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← 
[ApiEndpointParameterExample](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpointParameterExample.md)

#### Inherited Members

[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype), 
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring), 
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), 
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)), 
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), 
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Properties

| Name | Description |
| --- | --- |
| [Description](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpointParameterExample.Description.md#Sisk_Documenting_ApiEndpointParameterExample_Description) | Gets the optional description of when or why the example applies. |
| [Example](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpointParameterExample.Example.md#Sisk_Documenting_ApiEndpointParameterExample_Example) | Gets the example parameter value. |
| [ExampleLanguage](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpointParameterExample.ExampleLanguage.md#Sisk_Documenting_ApiEndpointParameterExample_ExampleLanguage) | Gets the language used to format the example value, if applicable. |
| [ParameterName](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpointParameterExample.ParameterName.md#Sisk_Documenting_ApiEndpointParameterExample_ParameterName) | Gets the name of the parameter to which the example applies. |
| [Title](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpointParameterExample.Title.md#Sisk_Documenting_ApiEndpointParameterExample_Title) | Gets the title that identifies the situation illustrated by the example. |