io.muserver.openapi

Class PathItemObjectBuilder

java.lang.Object

io.muserver.openapi.PathItemObjectBuilder

public class PathItemObjectBuilder
extends Object

Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

Constructor Summary

Constructors

Constructor and Description
PathItemObjectBuilder()

Method Summary

Modifier and Type	Method and Description
PathItemObject	build()
static PathItemObjectBuilder	pathItemObject() Creates a builder for a PathItemObject
PathItemObjectBuilder	withDescription(String description)
PathItemObjectBuilder	withOperations(Map<String,OperationObject> operations)
PathItemObjectBuilder	withParameters(List<ParameterObject> parameters)
PathItemObjectBuilder	withServers(List<ServerObject> servers)
PathItemObjectBuilder	withSummary(String summary)

Methods inherited from class java.lang.Object

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

Constructor Detail

PathItemObjectBuilder

public PathItemObjectBuilder()

Method Detail

withSummary

public PathItemObjectBuilder withSummary(String summary)

Parameters:

summary - An optional, string summary, intended to apply to all operations in this path.

Returns:

The current builder

withDescription

public PathItemObjectBuilder withDescription(String description)

Parameters:

description - An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.

Returns:

The current builder

withOperations

public PathItemObjectBuilder withOperations(Map<String,OperationObject> operations)

Parameters:

operations - The operations allowed on this path, where the keys to the map are GET, POST etc.

Returns:

The current builder

withServers

public PathItemObjectBuilder withServers(List<ServerObject> servers)

Parameters:

servers - An alternative server array to service all operations in this path.

Returns:

The current builder

withParameters

public PathItemObjectBuilder withParameters(List<ParameterObject> parameters)

Parameters:

parameters - A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.

Returns:

The current builder

build

public PathItemObject build()

pathItemObject

public static PathItemObjectBuilder pathItemObject()

Creates a builder for a PathItemObject

Returns:

A new builder