io.muserver.openapi

Class PathsObjectBuilder

java.lang.Object

io.muserver.openapi.PathsObjectBuilder

public class PathsObjectBuilder
extends Object

Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the ServerObject in order to construct the full URL. The Paths MAY be empty, due to ACL constraints.

Constructor Summary

Constructors

Constructor and Description
PathsObjectBuilder()

Method Summary

Modifier and Type	Method and Description
PathsObject	build()
static PathsObjectBuilder	pathsObject() Creates a builder for a PathsObject
PathsObjectBuilder	withPathItemObjects(Map<String,PathItemObject> pathItemObjects)

Methods inherited from class java.lang.Object

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

Constructor Detail

PathsObjectBuilder

public PathsObjectBuilder()

Method Detail

withPathItemObjects

public PathsObjectBuilder withPathItemObjects(Map<String,PathItemObject> pathItemObjects)

Parameters:

pathItemObjects - A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended (no relative URL resolution) to the expanded URL from the ServerObject's url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use.

Returns:

The current builder

build

public PathsObject build()

pathsObject

public static PathsObjectBuilder pathsObject()

Creates a builder for a PathsObject

Returns:

A new builder