GatewayApiMetadataProperties interface

  • Reference
Package:
@azure/arm-appplatform

API metadata property for Spring Cloud Gateway

Properties

description

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

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

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

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

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

Property Details

description

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

description?: string

Property Value

string

documentation

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

documentation?: string

Property Value

string

serverUrl

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

serverUrl?: string

Property Value

string

title

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

title?: string

Property Value

string

version

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

version?: string

Property Value

string