common-plugin/dev.akif.tapik.plugin.metadata

Package-level declarations

Types

data class BodyMetadata(val type: TypeMetadata, val name: String? = null, val mediaType: String? = null)

Metadata describing an HTTP body definition.

data class HeaderMetadata(val name: String, val type: TypeMetadata, val required: Boolean = true, val values: List<String> = emptyList())

Metadata describing a Tapik header definition.

data class HttpEndpointMetadata(val id: String, val propertyName: String, val description: String?, val details: String?, val method: String, val path: List<String>, val parameters: List<ParameterMetadata>, val input: InputMetadata, val outputs: List<OutputMetadata>, val packageName: String, val sourceFile: String, val imports: List<String>, val rawType: String)

Aggregated metadata describing a Tapik HTTP endpoint.

Aggregated metadata describing HTTP input expectations.

data class OutputMetadata(val description: String, val headers: List<HeaderMetadata>, val body: BodyMetadata)

Metadata describing a single output alternative including headers and body.

Marker interface implemented by endpoint parameter metadata types.

Metadata describing a Tapik path variable parameter.

data class QueryParameterMetadata(val name: String, val type: TypeMetadata, val required: Boolean = false, val default: String? = null) : ParameterMetadata

Metadata describing a Tapik query parameter.

data class TypeMetadata(val name: String, val nullable: Boolean? = false, val arguments: List<TypeMetadata> = emptyList())

Describes a Kotlin type used while rendering generated clients.