openapi - OpenAPI (openapi)

Configuration for the OpenAPI feature.

NameTypeDefaultDescription
customizationstringSpecifies the location of an OpenAPI snippet for customization.
enablePrivateURLbooleanfalseA boolean that controls whether the private API documentation endpoints are enabled.
publicURLstring/apiSpecifies the context root for the public API documentation endpoints. The URL does not require a forward slash (/).
validationbooleanfalseA boolean that controls whether OpenAPI documents are validated.
disableFileMonitorbooleanfalseA boolean that controls whether the customization files are monitored.

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.
publicbooleantrueA boolean that controls whether the web module is displayed in public API.