generator/io.github.edricchan03.koogle_api.plugin.generator.data/DirectoryItem

DirectoryItem

data class DirectoryItem(val kind: String, val id: String, val name: String, val version: String, val title: String, val description: String, val discoveryRestUrl: String, val discoveryLink: String? = null, val icons: SchemaIcons, val documentationLink: String? = null, val labels: List<String> = listOf(), val preferred: Boolean)(source)

Data class to represent an individual directory item.

Constructors

constructor(kind: String, id: String, name: String, version: String, title: String, description: String, discoveryRestUrl: String, discoveryLink: String? = null, icons: SchemaIcons, documentationLink: String? = null, labels: List<String> = listOf(), preferred: Boolean)

Properties

val description: String

The description of this API.

val discoveryLink: String? = null

A link to the discovery document.

discoveryRestUrl

val discoveryRestUrl: String

The URL for the discovery REST document.

documentationLink

val documentationLink: String? = null

A link to human readable documentation for the API.

val icons: SchemaIcons

Links to 16x16 and 32x32 icons representing the API.

The ID of this API.

val kind: String

The kind for this response.

val labels: List<String>

Labels for the status of this API, such as limited_availability or deprecated.

val name: String

The name of this API.

val preferred: Boolean

true if this version is the preferred version to use.

val title: String

The title of this API.

val version: String

The version of this API.