Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GatewayApiMetadataProperties

Package version

API metadata property for Spring Cloud Gateway

Hierarchy

  • GatewayApiMetadataProperties

Index

Properties

Optional description

description: undefined | string

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

Optional documentation

documentation: undefined | string

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

Optional serverUrl

serverUrl: undefined | string

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

Optional title

title: undefined | string

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

Optional version

version: undefined | string

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

Generated using TypeDoc