Class OpenApiDocument.Example

java.lang.Object

io.helidon.openapi.OpenApiDocument.Example

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.Example
extends Object

OpenAPI Example Object.

Method Summary

Modifier and Type	Method	Description
static OpenApiDocument.ExampleBuilder	builder()	Create a new example builder.
static OpenApiDocument.Example	reference(String ref)	Create a reference example.

Methods inherited from class Object

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

Method Details

builder

public static OpenApiDocument.ExampleBuilder builder()

Create a new example builder.

Returns:

builder

reference

public static OpenApiDocument.Example reference(String ref)

Create a reference example.

Parameters:

ref - reference

Returns:

example