Class OpenApiDocument.Response

java.lang.Object

io.helidon.openapi.OpenApiDocument.Response

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.Response
extends Object

OpenAPI Response Object.

Method Summary

Modifier and Type	Method	Description
static OpenApiDocument.ResponseBuilder	builder()	Create an empty response builder.
Optional<String>	description()	Response description.
static OpenApiDocument.Response	reference(String ref)	Create a reference response.
Optional<String>	summary()	Response summary.

Methods inherited from class Object

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

Method Details

builder

public static OpenApiDocument.ResponseBuilder builder()

Create an empty response builder.

Returns:

builder

reference

public static OpenApiDocument.Response reference(String ref)

Create a reference response.

Parameters:

ref - reference

Returns:

response

summary

public Optional<String> summary()

Response summary.

Returns:

summary

description

public Optional<String> description()

Response description.

OpenAPI 3.0 and 3.1 require a description for a Response Object, although the description can be empty. OpenAPI 3.2 makes the description optional.

Returns:

description, if present