Package org.eclipse.microprofile.openapi.models

Interface Paths

All Superinterfaces:

Constructible, Extensible, Map<String,PathItem>

public interface Paths
extends Constructible, Extensible, Map<String,PathItem>

Paths

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

See Also:

• OpenAPI Specification Paths Object

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
Paths	addPathItem(String name, PathItem item)	Adds the given path item to this Paths and return this instance of Paths

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

addExtension, getExtensions, setExtensions

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Details

addPathItem

Paths addPathItem(String name,
 PathItem item)

Adds the given path item to this Paths and return this instance of Paths

Parameters:

name - a path name in the format valid for a Paths object. The field name MUST begin with a slash.

item - the path item added to the list of paths

Returns:

the current Paths instance