Class OpenApiDocument.ExternalDocsBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.ExternalDocsBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.ExternalDocsBuilder, OpenApiDocument.ExternalDocs>, Supplier<OpenApiDocument.ExternalDocs>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.ExternalDocsBuilder
extends Object
implements Builder<OpenApiDocument.ExternalDocsBuilder, OpenApiDocument.ExternalDocs>

OpenAPI external documentation builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.ExternalDocs	build()	Build the instance from this builder.
OpenApiDocument.ExternalDocsBuilder	description(String description)	Set description.
OpenApiDocument.ExternalDocsBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.ExternalDocsBuilder	url(String url)	Set URL.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default OpenApiDocument.ExternalDocs	get()
default OpenApiDocument.ExternalDocsBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.ExternalDocsBuilder	update(Consumer<OpenApiDocument.ExternalDocsBuilder> consumer)	Update the builder in a fluent API way.

Method Details

url

public OpenApiDocument.ExternalDocsBuilder url(String url)

Set URL.

Parameters:

url - URL

Returns:

updated builder

description

public OpenApiDocument.ExternalDocsBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

extension

public OpenApiDocument.ExternalDocsBuilder extension(String name,
 JsonValue value)

Add an extension.

Extension names must start with x-.

Parameters:

name - extension name

value - extension value

Returns:

updated builder

build

public OpenApiDocument.ExternalDocs build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.ExternalDocsBuilder, OpenApiDocument.ExternalDocs>

Returns:

instance of the built type