diff --git a/modules/ROOT/pages/documentation-openapi.adoc b/modules/ROOT/pages/documentation-openapi.adoc index b8a723699..9796256d9 100644 --- a/modules/ROOT/pages/documentation-openapi.adoc +++ b/modules/ROOT/pages/documentation-openapi.adoc @@ -221,9 +221,9 @@ For example, to include all deployed applications and modules except the `admin` If the application is deployed in the `dropins` directory or if the `name` attribute is not specified, the name defaults to the archive filename with the extension removed. + - The module name is specified in the web module's `web.xml` file. If there is no `web.xml` file or if it does not specify a name, the module name defaults to the filename with the extension removed. -+ + You can also override the `info` section of the OpenAPI document using the following configuration: -+ + [source,xml] ---- @@ -232,7 +232,7 @@ You can also override the `info` section of the OpenAPI document using the follo description="This is an example API"/> ---- -+ + This override may be useful when documenting multiple modules or applications. Without it, the `info` section would be replaced with a standard one indicating that documentation from several modules was merged. diff --git a/modules/reference/pages/feature/mpOpenAPI-3.1/examples.adoc b/modules/reference/pages/feature/mpOpenAPI-3.1/examples.adoc index 79956a5dc..c4f02784b 100644 --- a/modules/reference/pages/feature/mpOpenAPI-3.1/examples.adoc +++ b/modules/reference/pages/feature/mpOpenAPI-3.1/examples.adoc @@ -37,7 +37,7 @@ For example, the following configuration is for the `sample_app` application, wh For more information, see xref:ROOT:documentation-openapi.adoc#multi-module[Multiple application and multi-module application support with MicroProfile OpenAPI] -== mpOpenAPI-4.0 - Will be placed in another doc (Placed here for REVIEW) +=== mpOpenAPI-4.0 - Will be placed in another doc (Placed here for REVIEW) By default, all deployed applications and modules are included in the OpenAPI documentation. However, you can configure which applications and modules should be included.