Class OpenApiDocument.PathItem

java.lang.Object

io.helidon.openapi.OpenApiDocument.PathItem

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.PathItem
extends Object

OpenAPI Path Item Object.

Method Summary

Modifier and Type	Method	Description
Map<String, OpenApiDocument.Operation>	additionalOperations()	Additional operations keyed by method name.
static OpenApiDocument.PathItemBuilder	builder()	Create a new path item builder.
String	name()	OpenAPI path template, webhook name, or callback expression.
Map<String, OpenApiDocument.Operation>	operations()	Operations keyed by lowercase HTTP method or query.
List<OpenApiDocument.Parameter>	parameters()	Common parameters.

Methods inherited from class Object

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

Method Details

builder

public static OpenApiDocument.PathItemBuilder builder()

Create a new path item builder.

Returns:

builder

name

public String name()

OpenAPI path template, webhook name, or callback expression.

Returns:

path template or webhook name

operations

public Map<String, OpenApiDocument.Operation> operations()

Operations keyed by lowercase HTTP method or query.

Returns:

operations

additionalOperations

public Map<String, OpenApiDocument.Operation> additionalOperations()

Additional operations keyed by method name.

Returns:

additional operations

parameters

public List<OpenApiDocument.Parameter> parameters()

Common parameters.

Returns:

common parameters