MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.Components

Method Summary

Modifier and Type	Method and Description
public Callback[]	Returns: the reusable Callback objects. callbacks() An object to hold reusable Callback Objects.
public ExampleObject[]	Returns: the reusable Example objects. examples() An object to hold reusable Example Objects.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `Components` model corresponding to the containing annotation.
public Header[]	Returns: the reusable Header objects. headers() An object to hold reusable Header Objects.
public Link[]	Returns: the reusable Link objects. links() An object to hold reusable Link Objects.
public Parameter[]	Returns: the reusable Parameter objects. parameters() An object to hold reusable Parameter Objects.
public PathItem[]	Returns: the reusable PathItem objects. pathItems() An object to hold reusable Path Item Objects.
public RequestBody[]	Returns: the reusable RequestBody objects. requestBodies() An object to hold reusable Request Body Objects.
public APIResponse[]	Returns: the reusable ApiResponse objects. responses() An object to hold reusable Response Objects.
public Schema[]	Returns: the reusable Schema objects. schemas() An object to hold reusable Schema Objects.
public SecurityScheme[]	Returns: the reusable SecurityScheme objects. securitySchemes() An object to hold reusable Security Scheme Objects.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

callbacks	back to summary
public Callback[] callbacks() An object to hold reusable Callback Objects. Returns:Callback[] the reusable Callback objects.

callbacks

back to summary

public Callback[] callbacks()

An object to hold reusable Callback Objects.

Returns:Callback[]: the reusable Callback objects.

examples	back to summary
public ExampleObject[] examples() An object to hold reusable Example Objects. Returns:ExampleObject[] the reusable Example objects.

examples

back to summary

public ExampleObject[] examples()

An object to hold reusable Example Objects.

Returns:ExampleObject[]: the reusable Example objects.

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `Components` model corresponding to the containing annotation. Returns:Extension[] array of extensions Since 3.1

public Extension[] extensions()

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

Returns:Extension[]: array of extensions
Since: 3.1

headers	back to summary
public Header[] headers() An object to hold reusable Header Objects. Returns:Header[] the reusable Header objects.

headers

back to summary

public Header[] headers()

An object to hold reusable Header Objects.

Returns:Header[]: the reusable Header objects.

links	back to summary
public Link[] links() An object to hold reusable Link Objects. Returns:Link[] the reusable Link objects.

links

back to summary

public Link[] links()

An object to hold reusable Link Objects.

Returns:Link[]: the reusable Link objects.

parameters	back to summary
public Parameter[] parameters() An object to hold reusable Parameter Objects. Returns:Parameter[] the reusable Parameter objects.

parameters

back to summary

public Parameter[] parameters()

An object to hold reusable Parameter Objects.

Returns:Parameter[]: the reusable Parameter objects.

pathItems	back to summary
public PathItem[] pathItems() An object to hold reusable Path Item Objects. Returns:PathItem[] the reusable PathItem objects. Since 4.0

pathItems

back to summary

public PathItem[] pathItems()

An object to hold reusable Path Item Objects.

Returns:PathItem[]: the reusable PathItem objects.
Since: 4.0

requestBodies	back to summary
public RequestBody[] requestBodies() An object to hold reusable Request Body Objects. Returns:RequestBody[] the reusable RequestBody objects.

requestBodies

back to summary

public RequestBody[] requestBodies()

An object to hold reusable Request Body Objects.

Returns:RequestBody[]: the reusable RequestBody objects.

responses	back to summary
public APIResponse[] responses() An object to hold reusable Response Objects. Returns:APIResponse[] the reusable ApiResponse objects.

responses

back to summary

public APIResponse[] responses()

An object to hold reusable Response Objects.

Returns:APIResponse[]: the reusable ApiResponse objects.

schemas	back to summary
public Schema[] schemas() An object to hold reusable Schema Objects. Returns:Schema[] the reusable Schema objects.

schemas

back to summary

public Schema[] schemas()

An object to hold reusable Schema Objects.

Returns:Schema[]: the reusable Schema objects.

securitySchemes	back to summary
public SecurityScheme[] securitySchemes() An object to hold reusable Security Scheme Objects. Returns:SecurityScheme[] the reusable SecurityScheme objects.

securitySchemes

back to summary

public SecurityScheme[] securitySchemes()

An object to hold reusable Security Scheme Objects.

Returns:SecurityScheme[]: the reusable SecurityScheme objects.

public @Interface Components

Method Summary

Method Detail