Sisk

Method

ApiDocumentationHandler.HandleApiEndpointParameterExample

Namespace
Sisk.Documenting
Assembly
Sisk.Documenting.dll

HandleApiEndpointParameterExample(ApiEndpointParameterExample, Route) #

Filters or customizes a documented request parameter example for a route.

C#
public virtual bool HandleApiEndpointParameterExample(ApiEndpointParameterExample value, Route route)

Parameters #

value ApiEndpointParameterExample

The parameter example collected from the route or one of its request handlers.

route Route

The route that owns the documented parameter example.

Returns #

bool

true to include the parameter example; otherwise, false.

Type to search the documentation and the API reference.