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

HttpEndpointMetadata

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)(source)

Aggregated metadata describing a Tapik HTTP endpoint.

Constructors

HttpEndpointMetadata

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

Properties

val description: String?

optional short summary of the endpoint.

val details: String?

optional long-form documentation.

stable identifier for the endpoint.

val imports: List<String>

fully-qualified imports required when generating clients.

val input: InputMetadata

input definition describing headers and body expected from the caller.

val method: String

HTTP method handled by the endpoint.

val outputs: List<OutputMetadata>

possible response alternatives together with their headers and bodies.

val packageName: String

package containing the endpoint declaration.

val parameters: List<ParameterMetadata>

parameters captured by the endpoint.

val path: List<String>

ordered list of path segments and placeholders.

val propertyName: String

backing property or function used to expose the endpoint.

val rawType: String

string representation of the original endpoint type.

val sourceFile: String

Kotlin file hosting the endpoint declaration.