apiDiscovery - API Discovery (apiDiscovery)

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

NameTypeDefaultDescription
maxSubscriptionsint
Min: 0

Max: 100
20Specifies the maximum number of concurrent REST API clients that are listening for updates.
apiNamestringThe name of the aggregated API.
publicURLstring/apiSpecifies the context root for the public API documentation endpoints. The URL does not require a forward slash (/).
swaggerDefinitionstringA 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.

NameTypeDefaultDescription
idstringA unique configuration ID.
contextRootstringThe context root of the web module for which you are providing documentation.
enabledbooleantrueA boolean that controls the processing of documentation for this web module.
docURLstringThe 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.
publicbooleantrueA boolean that controls whether the web module is displayed in public API.