Sisk

Method

ApiDocumentationHandler.HandleApiEndpointRequestExample

Namespace
Sisk.Documenting
Assembly
Sisk.Documenting.dll

HandleApiEndpointRequestExample(ApiEndpointRequestExample, Route) #

Filters or customizes a documented request example for a route.

C#
public virtual bool HandleApiEndpointRequestExample(ApiEndpointRequestExample value, Route route)

Parameters #

value ApiEndpointRequestExample

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

route Route

The route that owns the documented request example.

Returns #

bool

true to include the request example; otherwise, false.

Type to search the documentation and the API reference.