Interface Paths
-
- All Superinterfaces:
Constructible
,Extensible
,java.util.Map<java.lang.String,PathItem>
public interface Paths extends Constructible, Extensible, java.util.Map<java.lang.String,PathItem>
PathsHolds 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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Paths
addPathItem(java.lang.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, entry, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
-
-
-
-
Method Detail
-
addPathItem
Paths addPathItem(java.lang.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
-
-