Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FISH-6298 Yaml result added with the explanation about 'endpoints' #53

Merged
merged 6 commits into from Aug 9, 2022
Merged
Expand Up @@ -142,6 +142,38 @@ import org.eclipse.microprofile.openapi.annotations.Operation;
}
----

*yaml Result [http://localhost:8080/openapi]*::
luiseufrasio marked this conversation as resolved.
Show resolved Hide resolved
[source, yml]
----
openapi: 3.0.0
info:
title: A Test Application
version: "1.0"
servers:
- url: http://localhost:8080/openapi-example-1.0
description: Default Server.
- url: https://localhost:8181/openapi-example-1.0
description: Default Server.
paths:
/api/hello:
get:
operationId: hello-world
responses:
default:
content:
text/plain:
schema:
type: string
description: Default Response.
deprecated: false
endpoints:
/openapi-example-1.0:
- /api/hello
components: {}
----

IMPORTANT: The item `endpoints` is a Payara extension from the Specification. It was created to expose the endpoints for each application deployed.
luiseufrasio marked this conversation as resolved.
Show resolved Hide resolved

[[openApi-configuration]]
== OpenAPI Configuration

Expand Down
Expand Up @@ -140,6 +140,38 @@ import org.eclipse.microprofile.openapi.annotations.Operation;
}
----

*yaml Result [http://localhost:8080/openapi]*::
luiseufrasio marked this conversation as resolved.
Show resolved Hide resolved
[source, yml]
----
openapi: 3.0.0
info:
title: A Test Application
version: "1.0"
servers:
- url: http://localhost:8080/openapi-example-1.0
description: Default Server.
- url: https://localhost:8181/openapi-example-1.0
description: Default Server.
paths:
/api/hello:
get:
operationId: hello-world
responses:
default:
content:
text/plain:
schema:
type: string
description: Default Response.
deprecated: false
endpoints:
/openapi-example-1.0:
- /api/hello
components: {}
----

IMPORTANT: The item `endpoints` is a Payara extension from the Specification. It was created to expose the endpoints for each application deployed.

[[openApi-configuration]]
== OpenAPI Configuration

Expand Down