Class OpenApiDocument.Operation

java.lang.Object

io.helidon.openapi.OpenApiDocument.Operation

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.Operation
extends Object

OpenAPI Operation Object.

Method Summary

Modifier and Type	Method	Description
static OpenApiDocument.OperationBuilder	builder()	Create a new operation builder.
Map<String, OpenApiDocument.Callback>	callbacks()	Operation callbacks.
Optional<String>	operationId()	Operation id.
List<OpenApiDocument.Parameter>	parameters()	Operation parameters.
Optional<OpenApiDocument.RequestBody>	requestBody()	Request body.
Map<String, OpenApiDocument.Response>	responses()	Operation responses.

Methods inherited from class Object

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

Method Details

builder

public static OpenApiDocument.OperationBuilder builder()

Create a new operation builder.

Returns:

builder

operationId

public Optional<String> operationId()

Operation id.

Returns:

operation id

parameters

public List<OpenApiDocument.Parameter> parameters()

Operation parameters.

Returns:

operation parameters

requestBody

public Optional<OpenApiDocument.RequestBody> requestBody()

Request body.

Returns:

request body

responses

public Map<String, OpenApiDocument.Response> responses()

Operation responses.

OpenAPI 3.0 and 3.1 require at least one response. OpenAPI 3.2 permits responses to be omitted. If the Responses Object is present, it must contain at least one status-code, status-code-range, or default response; extensions alone do not satisfy this requirement.

Returns:

responses keyed by status code, status-code range, or default

callbacks

public Map<String, OpenApiDocument.Callback> callbacks()

Operation callbacks.

Returns:

callbacks keyed by callback name