Package io.smallrye.openapi.internal.models.responses

Class APIResponse

java.lang.Object

io.smallrye.openapi.model.BaseModel<org.eclipse.microprofile.openapi.models.responses.APIResponse>

io.smallrye.openapi.model.BaseExtensibleModel<org.eclipse.microprofile.openapi.models.responses.APIResponse>

io.smallrye.openapi.internal.models.responses.APIResponse

All Implemented Interfaces:

org.eclipse.microprofile.openapi.models.Constructible, org.eclipse.microprofile.openapi.models.Extensible<org.eclipse.microprofile.openapi.models.responses.APIResponse>, org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.responses.APIResponse>, org.eclipse.microprofile.openapi.models.responses.APIResponse

Direct Known Subclasses:

APIResponseImpl

@Generated(value="io.smallrye.openapi.model.apt.SmallRyeModelProcessor",
           date="2026-01-25T12:11:29.540788993Z")
public class APIResponse
extends io.smallrye.openapi.model.BaseExtensibleModel<org.eclipse.microprofile.openapi.models.responses.APIResponse>
implements org.eclipse.microprofile.openapi.models.responses.APIResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	APIResponse.Properties

Nested classes/interfaces inherited from class io.smallrye.openapi.model.BaseModel

io.smallrye.openapi.model.BaseModel.MergeDirective

Field Summary

Fields

Modifier and Type	Field	Description
static final io.smallrye.openapi.model.PropertyMetadata	PROPERTIES

Constructor Summary

Constructors

Constructor	Description
APIResponse()

Method Summary

Modifier and Type	Method	Description
APIResponse	addHeader(String newKey, org.eclipse.microprofile.openapi.models.headers.Header newValue)
APIResponse	addLink(String newKey, org.eclipse.microprofile.openapi.models.links.Link newValue)
protected org.eclipse.microprofile.openapi.models.responses.APIResponse	filter(org.eclipse.microprofile.openapi.OASFilter filter)
org.eclipse.microprofile.openapi.models.media.Content	getContent()
Map<String,org.eclipse.microprofile.openapi.models.headers.Header>	getHeaders()
Map<String,org.eclipse.microprofile.openapi.models.links.Link>	getLinks()
io.smallrye.openapi.model.PropertyMetadata	getPropertyMetadata()
void	removeHeader(String key)
void	removeLink(String key)
void	setContent(org.eclipse.microprofile.openapi.models.media.Content newValue)
void	setHeaders(Map<String,org.eclipse.microprofile.openapi.models.headers.Header> newValue)
void	setLinks(Map<String,org.eclipse.microprofile.openapi.models.links.Link> newValue)

Methods inherited from class io.smallrye.openapi.model.BaseExtensibleModel

addExtension, addListPropertyEntry, equals, getAllExtensions, getAllProperties, getExtension, getExtensions, getListProperty, getMapProperty, getProperty, getProperty, hasExtension, hashCode, isExtension, merge, putMapPropertyEntry, removeExtension, removeListPropertyEntry, removeMapPropertyEntry, setAllProperties, setExtensions, setListProperty, setMapProperty, setProperty

Methods inherited from class io.smallrye.openapi.model.BaseModel

constructible, deepCopy, deepCopy, filter, getDescription, getExternalDocs, getModCount, getName, getProperties, getRef, getSummary, incrementModCount, merge, mergeDirective, setDescription, setExternalDocs, setName, setRef, setSummary, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.microprofile.openapi.models.responses.APIResponse

content, description, getDescription, headers, links, setDescription

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

addExtension, extensions, getExtension, getExtensions, hasExtension, removeExtension, setExtensions

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

getRef, ref, setRef

Field Details

PROPERTIES

public static final io.smallrye.openapi.model.PropertyMetadata PROPERTIES

Constructor Details

APIResponse

public APIResponse()

Method Details

getPropertyMetadata

public io.smallrye.openapi.model.PropertyMetadata getPropertyMetadata()

Specified by:

getPropertyMetadata in class io.smallrye.openapi.model.BaseModel<org.eclipse.microprofile.openapi.models.responses.APIResponse>

filter

protected org.eclipse.microprofile.openapi.models.responses.APIResponse filter(org.eclipse.microprofile.openapi.OASFilter filter)

Overrides:

filter in class io.smallrye.openapi.model.BaseModel<org.eclipse.microprofile.openapi.models.responses.APIResponse>

getHeaders

public Map<String,org.eclipse.microprofile.openapi.models.headers.Header> getHeaders()

Specified by:

getHeaders in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

setHeaders

public void setHeaders(Map<String,org.eclipse.microprofile.openapi.models.headers.Header> newValue)

Specified by:

setHeaders in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

addHeader

public APIResponse addHeader(String newKey,
 org.eclipse.microprofile.openapi.models.headers.Header newValue)

Specified by:

addHeader in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

removeHeader

public void removeHeader(String key)

Specified by:

removeHeader in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

getContent

public org.eclipse.microprofile.openapi.models.media.Content getContent()

Specified by:

getContent in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

setContent

public void setContent(org.eclipse.microprofile.openapi.models.media.Content newValue)

Specified by:

setContent in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

getLinks

public Map<String,org.eclipse.microprofile.openapi.models.links.Link> getLinks()

Specified by:

getLinks in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

setLinks

public void setLinks(Map<String,org.eclipse.microprofile.openapi.models.links.Link> newValue)

Specified by:

setLinks in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

addLink

public APIResponse addLink(String newKey,
 org.eclipse.microprofile.openapi.models.links.Link newValue)

Specified by:

addLink in interface org.eclipse.microprofile.openapi.models.responses.APIResponse

removeLink

public void removeLink(String key)

Specified by:

removeLink in interface org.eclipse.microprofile.openapi.models.responses.APIResponse