Class OpenApiDocument.Info

java.lang.Object

io.helidon.openapi.OpenApiDocument.Info

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.Info
extends Object

OpenAPI Info Object.

Method Summary

Modifier and Type	Method	Description
static OpenApiDocument.InfoBuilder	builder()	Create a new info builder.
Optional<OpenApiDocument.Contact>	contact()	Contact.
Optional<String>	description()	API description.
Optional<OpenApiDocument.License>	license()	License.
Optional<String>	summary()	API summary.
Optional<String>	termsOfService()	API terms of service.
String	title()	API title.
String	version()	API version.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static OpenApiDocument.InfoBuilder builder()

Create a new info builder.

Returns:

builder

title

public String title()

API title.

Returns:

title

version

public String version()

API version.

Returns:

version

summary

public Optional<String> summary()

API summary.

Returns:

summary

description

public Optional<String> description()

API description.

Returns:

description

termsOfService

public Optional<String> termsOfService()

API terms of service.

Returns:

terms of service

contact

public Optional<OpenApiDocument.Contact> contact()

Contact.

Returns:

contact

license

public Optional<OpenApiDocument.License> license()

License.

Returns:

license