API Discovery (apiDiscovery)

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

Attribute name Data type Default value Description
apiName string   The name of the aggregated API.
id string   A unique configuration ID.
maxSubscriptions int

Minimum: 0

Maximum: 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 (/).
webModuleDoc
Description: Configuration for each web module that provides API documentation to be exposed.
Required: false
Data type:
Attribute name Data type Default value Description
contextRoot string   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.

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: Monday, 5 December 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rwlp_config_apiDiscovery
File name: rwlp_config_apiDiscovery.html