Skip to content

Commit

Permalink
7654-Documentation-MicroProfile-OpenAPI-4.0-4
Browse files Browse the repository at this point in the history
7654-Documentation-MicroProfile-OpenAPI-4.0-4

#7654
  • Loading branch information
ramkumar-k-9286 committed Nov 13, 2024
1 parent 997badc commit 4f5c7fb
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions modules/ROOT/pages/documentation-openapi.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
<mpOpenAPI>
Expand All @@ -232,7 +232,7 @@ You can also override the `info` section of the OpenAPI document using the follo
description="This is an example API"/>
</mpOpenAPI>
----
+

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.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 4f5c7fb

Please sign in to comment.