Configuration for the OpenAPI feature.
Name | Type | Default | Description |
---|---|---|---|
customization |
string |
Specifies the location of an OpenAPI snippet for customization. |
|
disableFileMonitor |
boolean |
false |
A boolean that controls whether the customization files are monitored. |
enablePrivateURL |
boolean |
false |
A boolean that controls whether the private API documentation endpoints are enabled. |
publicURL |
string |
/api |
Specifies the context root for the public API documentation endpoints. The URL does not require a forward slash (/). |
validation |
boolean |
false |
A boolean that controls whether OpenAPI documents are validated. |
Configuration for each web module that provides API documentation to be exposed.
Name | Type | Default | Description |
---|---|---|---|
contextRoot |
string |
The context root of the web module for which you are providing documentation. |
|
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. |