Configuration for the API Discovery feature to document your REST APIs.

Name Type Default Description

apiName

string

The name of the aggregated API.

maxSubscriptions

int
Min: 0
Max: 100

20

Specifies the maximum number of concurrent REST API clients that are listening for updates.

publicURL

string

/api

Specifies the context root for the public API documentation endpoints. The URL does not require a forward slash (/).

swaggerDefinition

string

A file location or a URL of a JSON or YAML Swagger snippet or a context root of the application that is to be taken as the aggregated Swagger definition.

webModuleDoc

Configuration for each web module that provides API documentation to be exposed.

Name Type Default Description

contextRoot

string
Required

The context root of the web module for which you are providing documentation.

docURL

string

The URL of the documentation of this web module. The URL can be relative to the context root by starting with a forward slash (/) or absolute by starting with http or https.

enabled

boolean

true

A boolean that controls the processing of documentation for this web module.

id

string

A unique configuration ID.

public

boolean

true

A boolean that controls whether the web module is displayed in public API.