Multiplatform Ktor schema declaration • opensavvy.spine.api • Resource

Resource

sealed class Resource

Common parent for all resource types.

Users of the library cannot directly subclass this. Instead, they should subclass one of its subtypes.

Inheritors

• DynamicResource
• RootResource
• StaticResource

Properties

children

val children: Sequence<Resource>

Returns resources that are direct children of the current resource.

directEndpoints

val directEndpoints: Sequence<AnyEndpoint>

Returns all endpoints that are declared on this resource.

endpoints

val Resource.endpoints: Sequence<AnyEndpoint>

Returns all endpoints that are declared on this resource or any of its children.

fullSlug

val Resource.fullSlug: String

The complete URL of this resource, starting from the RootResource, to this resource.

hierarchy

val Resource.hierarchy: Sequence<Resource>

Returns the hierarchy of this resource: following the parent chain.

parent

abstract val parent: Resource?

The parent resource of this resource.

slug

val slug: String

The URL segment relating to this specific resource.