ResourceSchema

annotation class ResourceSchema(val resourceType: String = "", val endpoint: String = "", val config: KClass<out JsonApiConfig> = JsonApiConfig::class)

Annotates a class as a JSON:API resource schema with the given endpoint.

Parameters

resourceType

The type of the JSON:API resource. If empty, it will be automatically derived from the class name (lowercase ).

endpoint

The endpoint to use for the resource. If empty, it will be automatically derived from the resource type.

config

The configuration to use for the resource. Defaults to the configuration object that extends JsonApiConfig and marked with DefaultInstance.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard