Top Description Methods
org.eclipse.microprofile.openapi.annotations

public @Interface PathItem

extends Annotation
Annotations
@Target
@Retention:RUNTIME
Imports
java.lang.annotation.Retention, .RetentionPolicy, .Target, org.eclipse.microprofile.openapi.annotations.extensions.Extension, org.eclipse.microprofile.openapi.annotations.parameters.Parameter, org.eclipse.microprofile.openapi.annotations.servers.Server
Describes a set of operations available on a single path.
Since
4.0

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the description
description()

The description of the path item.

public Extension[]

Returns:

the list of extensions
extensions()

List of extensions to be added to the PathItem model corresponding to the containing annotation.

public String

Returns:

the path item name
name()

The name of the Path Item object, used as the map key when the path item is used under Components#pathItems() or OpenAPIDefinition#webhooks()

public PathItemOperation[]

Returns:

the list of operations
operations()

The operations available under this Path Item.

public Parameter[]

Returns:

the list of parameters
parameters()

A list of parameters which apply to all operations under this path item.

public String

Returns:

reference to a path item object definition
ref()

Reference value to a PathItem object.

public Server[]

Returns:

the list of servers
servers()

A list of servers to be used for this Path Item, overriding those defined for the whole API.

public String

Returns:

the summary
summary()

The summary of the path item.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

descriptionback to summary
public String description()

The description of the path item.

Returns:String

the description

extensionsback to summary
public Extension[] extensions()

List of extensions to be added to the PathItem model corresponding to the containing annotation.

Returns:Extension[]

the list of extensions

nameback to summary
public String name()

The name of the Path Item object, used as the map key when the path item is used under Components#pathItems() or OpenAPIDefinition#webhooks()

Returns:String

the path item name

operationsback to summary
public PathItemOperation[] operations()

The operations available under this Path Item.

The method MUST be defined for each operation.

Returns:PathItemOperation[]

the list of operations

parametersback to summary
public Parameter[] parameters()

A list of parameters which apply to all operations under this path item.

Returns:Parameter[]

the list of parameters

refback to summary
public String ref()

Reference value to a PathItem object.

This property provides a reference to an object defined elsewhere.

Unlike ref on most MP OpenAPI annotations, this property is not mutually exclusive with other properties.

Returns:String

reference to a path item object definition

serversback to summary
public Server[] servers()

A list of servers to be used for this Path Item, overriding those defined for the whole API.

Returns:Server[]

the list of servers

summaryback to summary
public String summary()

The summary of the path item.

Returns:String

the summary