Package io.muserver.openapi
Class PathsObjectBuilder
- java.lang.Object
-
- io.muserver.openapi.PathsObjectBuilder
-
public class PathsObjectBuilder extends java.lang.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 Description PathsObjectBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PathsObject
build()
static PathsObjectBuilder
pathsObject()
Creates a builder for aPathsObject
PathsObjectBuilder
withPathItemObjects(java.util.Map<java.lang.String,PathItemObject> pathItemObjects)
-
-
-
Method Detail
-
withPathItemObjects
public PathsObjectBuilder withPathItemObjects(java.util.Map<java.lang.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 theServerObject
'surl
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()
- Returns:
- A new object
-
pathsObject
public static PathsObjectBuilder pathsObject()
Creates a builder for aPathsObject
- Returns:
- A new builder
-
-