Macrocosm/space.maxus.macrocosm.api

Package-level declarations

Contains the code related to the Macrocosm HTTP API implementation

Types

Type of permission for an API Key

Type of api state

data class InlinedKeyData(val format: APIState, val createdAt: Instant, val permissions: List<APIPermission>, val owner: UUID)

Represents byte-inlined data (previously) stored in the key as base64

data class KeyData(val key: String, val data: InlinedKeyData)

Macrocosm API Access Key data

A global key manage for operations with API Keys

fun Application.module()

The main configuration of the Macrocosm API, to find more detailed endpoint information view the swagger spec

Builds up the embedded macrocosm Rest API server using the Netty ktor backend

suspend fun spinApi(): Deferred<Unit>

Spins up the macrocosm Rest API, basically wrapping serverSpin in coroutine scope

Represents current API state