GatewayApiMetadataPropertiesResponse

data class GatewayApiMetadataPropertiesResponse(val description: String? = null, val documentation: String? = null, val serverUrl: String? = null, val title: String? = null, val version: String? = null)

API metadata property for Spring Cloud Gateway

Constructors

Link copied to clipboard
constructor(description: String? = null, documentation: String? = null, serverUrl: String? = null, title: String? = null, version: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val description: String? = null

Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes the API routes configured.)

Link copied to clipboard
val documentation: String? = null

Location of additional documentation for the APIs available on the Gateway instance

Link copied to clipboard
val serverUrl: String? = null

Base URL that API consumers will use to access APIs on the Gateway instance.

Link copied to clipboard
val title: String? = null

Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)

Link copied to clipboard
val version: String? = null

Version of APIs available on this Gateway instance (default: unspecified).