Skip to content

Commit

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

#7654
  • Loading branch information
ramkumar-k-9286 committed Nov 8, 2024
1 parent a16b237 commit 9d7f3b3
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion modules/reference/pages/feature/mpOpenAPI-3.1/examples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,36 @@ For example, the following configuration is for the `sample_app` application, wh

- The `<info>` element sets the info section for the final OpenAPI document, which documents web modules 1, 2, and 4.

For more information, see xref:ROOT:documentation-openapi.adoc#multi-module[Multiple application and multi-module application support with MicroProfile OpenAPI]
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)

By default, all deployed applications and modules are included in the OpenAPI documentation. However, you can configure which applications and modules should be included.

For example, the following configuration is for the `sample_app` application, which consists of an `EAR` file containing five web modules.

[source,xml]
----
<mpOpenAPI>
<excludeModule>sample_app/module-3</excludeModule>
<excludeModule>sample_app/module-5</excludeModule>
<info title="A multi-module sample application"
description="This is a sample application."
version="2.0.1"
termsOfService="http://example.com/sample_app/terms"
contactName="API Support"
contactUrl="http://www.example.com/sample_app/support"
contactEmail="[email protected]"
licenseName="License 2.0"
licenseUrl="https://www.example.org/licenses/LICENSE-2.0.html"
/>
</mpOpenAPI>
----

- The `<excludeModule>` elements exclude the `module-3` and `module-5` web modules.

- The `<info>` element sets the info section for the final OpenAPI document, which documents web modules 1, 2, and 4.

For more information, see xref:ROOT:documentation-openapi.adoc#multi-module[Multiple application and multi-module application support with MicroProfile OpenAPI]

0 comments on commit 9d7f3b3

Please sign in to comment.