Skip to content

Commit

Permalink
Small adjustments to the feature wording
Browse files Browse the repository at this point in the history
  • Loading branch information
fturizo committed Aug 9, 2022
1 parent 2654aee commit ad4b688
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
Expand Up @@ -142,7 +142,7 @@ import org.eclipse.microprofile.openapi.annotations.Operation;
}
----

*Here's an example of how the OpenAPI document of a sample application would look like:*::
Here's an example of how the OpenAPI document of a sample application would look like::
[source, yml]
----
openapi: 3.0.0
Expand Down Expand Up @@ -172,10 +172,14 @@ endpoints:
components: {}
----

==== Deployed endpoints
In case we have more than one application deployed, a merge is done in the OpenAPI document. The resultant document has all applications and paths. In order to make the document more legible, the attribute `endpoints` was added as a Payara Platform specific extension which lists all deployed endpoints grouped by the application context root.
[[deployed-endpointts]]
==== Deployed Endpoints

*The following example shows an OpenAPI document for two applications deployed:*::
When more than one application is deployed, a merge is done in the OpenAPI document. The resulting document will contain all application and path definitions present. To improve the its readability, an `endpoints` attribute which lists all deployed endpoints grouped by their application context roots has been added to the document.

NOTE: The `endpoints` attribute is an proprietary Payara Platform extension and it's not portable.

The following example shows an OpenAPI document generated when 2 different applications are deployed::
[source, yml]
----
openapi: 3.0.0
Expand Down
Expand Up @@ -140,7 +140,7 @@ import org.eclipse.microprofile.openapi.annotations.Operation;
}
----

*Here's an example of how the OpenAPI document of a sample application would look like:*::
Here's an example of how the OpenAPI document of a sample application would look like::
[source, yml]
----
openapi: 3.0.0
Expand Down Expand Up @@ -170,10 +170,14 @@ endpoints:
components: {}
----

==== Deployed endpoints
In case we have more than one application deployed, a merge is done in the OpenAPI document. The resultant document has all applications and paths. In order to make the document more legible, the attribute `endpoints` was added as a Payara Platform specific extension which lists all deployed endpoints grouped by the application context root.
[[deployed-endpointts]]
==== Deployed Endpoints

*The following example shows an OpenAPI document for two applications deployed:*::
When more than one application is deployed, a merge is done in the OpenAPI document. The resulting document will contain all application and path definitions present. To improve the its readability, an `endpoints` attribute which lists all deployed endpoints grouped by their application context roots has been added to the document.

NOTE: The `endpoints` attribute is an proprietary Payara Platform extension and it's not portable.

The following example shows an OpenAPI document generated when 2 different applications are deployed::
[source, yml]
----
openapi: 3.0.0
Expand Down

0 comments on commit ad4b688

Please sign in to comment.