ResourceDescription

interface ResourceDescription

Provides endpoint descriptions for resource classes.

This interface should be implemented on a companion object in a resource class. You can either:

In order for the description to be taken into account, you must use the <operation>D functions (e.g. getD) instead of the regular Resources operation functions (e.g. get).

Properties

Link copied to clipboard
abstract val openApi: OperationDsl.() -> Unit

The description for the endpoint represented by this resource class.