final case class PathItem(ref: Option[String], summary: Option[String], description: Option[Doc], get: Option[Operation], put: Option[Operation], post: Option[Operation], delete: Option[Operation], options: Option[Operation], head: Option[Operation], patch: Option[Operation], trace: Option[Operation], servers: List[Server] = List.empty, parameters: Set[ReferenceOr[Parameter]] = Set.empty) extends Product with Serializable
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.
- ref
Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined.
- summary
An optional, string summary, intended to apply to all operations in this path.
- description
A description, intended to apply to all operations in this path.
- get
A definition of a GET operation on this path.
- put
A definition of a PUT operation on this path.
- post
A definition of a POST operation on this path.
- delete
A definition of a DELETE operation on this path.
- options
A definition of a OPTIONS operation on this path.
- head
A definition of a HEAD operation on this path.
- patch
A definition of a PATCH operation on this path.
- trace
A definition of a TRACE operation on this path.
- servers
An alternative server List to service all operations in this path.
- parameters
A Set 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 Set can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.
- Alphabetic
- By Inheritance
- PathItem
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
PathItem(ref: Option[String], summary: Option[String], description: Option[Doc], get: Option[Operation], put: Option[Operation], post: Option[Operation], delete: Option[Operation], options: Option[Operation], head: Option[Operation], patch: Option[Operation], trace: Option[Operation], servers: List[Server] = List.empty, parameters: Set[ReferenceOr[Parameter]] = Set.empty)
- ref
Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined.
- summary
An optional, string summary, intended to apply to all operations in this path.
- description
A description, intended to apply to all operations in this path.
- get
A definition of a GET operation on this path.
- put
A definition of a PUT operation on this path.
- post
A definition of a POST operation on this path.
- delete
A definition of a DELETE operation on this path.
- options
A definition of a OPTIONS operation on this path.
- head
A definition of a HEAD operation on this path.
- patch
A definition of a PATCH operation on this path.
- trace
A definition of a TRACE operation on this path.
- servers
An alternative server List to service all operations in this path.
- parameters
A Set 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 Set can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addDelete(operation: Operation): PathItem
- def addGet(operation: Operation): PathItem
- def addHead(operation: Operation): PathItem
- def addOptions(operation: Operation): PathItem
- def addPatch(operation: Operation): PathItem
- def addPost(operation: Operation): PathItem
- def addPut(operation: Operation): PathItem
- def addTrace(operation: Operation): PathItem
- def any(operation: Operation): PathItem
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @IntrinsicCandidate()
- val delete: Option[Operation]
- val description: Option[Doc]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val get: Option[Operation]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- val head: Option[Operation]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- val options: Option[Operation]
- val parameters: Set[ReferenceOr[Parameter]]
- val patch: Option[Operation]
- val post: Option[Operation]
- val put: Option[Operation]
- val ref: Option[String]
- val servers: List[Server]
- val summary: Option[String]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val trace: Option[Operation]
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )