Package io.smallrye.openapi.internal.models

Class Operation

java.lang.Object
io.smallrye.openapi.model.BaseModel<org.eclipse.microprofile.openapi.models.Operation>
io.smallrye.openapi.model.BaseExtensibleModel<org.eclipse.microprofile.openapi.models.Operation>
io.smallrye.openapi.internal.models.Operation
All Implemented Interfaces:
org.eclipse.microprofile.openapi.models.Constructible, org.eclipse.microprofile.openapi.models.Extensible<org.eclipse.microprofile.openapi.models.Operation>, org.eclipse.microprofile.openapi.models.Operation
Direct Known Subclasses:
OperationImpl
@Generated(value="io.smallrye.openapi.model.apt.SmallRyeModelProcessor", date="2026-01-25T12:11:29.528295286Z") public class Operation extends io.smallrye.openapi.model.BaseExtensibleModel<org.eclipse.microprofile.openapi.models.Operation> implements org.eclipse.microprofile.openapi.models.Operation

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Operation.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
    Operation()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Operation
    addCallback(String newKey, org.eclipse.microprofile.openapi.models.callbacks.Callback newValue)
    Operation
    addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter newValue)
    Operation
    addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement newValue)
    Operation
    addServer(org.eclipse.microprofile.openapi.models.servers.Server newValue)
    Operation
    addTag(String newValue)
    protected org.eclipse.microprofile.openapi.models.Operation
    filter(org.eclipse.microprofile.openapi.OASFilter filter)
    Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback>
    getCallbacks()
    Boolean
    getDeprecated()
    String
    getOperationId()
    List<org.eclipse.microprofile.openapi.models.parameters.Parameter>
    getParameters()
    io.smallrye.openapi.model.PropertyMetadata
    getPropertyMetadata()
     
    org.eclipse.microprofile.openapi.models.parameters.RequestBody
    getRequestBody()
    org.eclipse.microprofile.openapi.models.responses.APIResponses
    getResponses()
    List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>
    getSecurity()
    List<org.eclipse.microprofile.openapi.models.servers.Server>
    getServers()
    List<String>
    getTags()
    void
    removeCallback(String key)
    void
    removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter value)
    void
    removeSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement value)
    void
    removeServer(org.eclipse.microprofile.openapi.models.servers.Server value)
    void
    removeTag(String value)
    void
    setCallbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> newValue)
    void
    setDeprecated(Boolean newValue)
    void
    setOperationId(String newValue)
    void
    setParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> newValue)
    void
    setRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody newValue)
    void
    setResponses(org.eclipse.microprofile.openapi.models.responses.APIResponses newValue)
    void
    setSecurity(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> newValue)
    void
    setServers(List<org.eclipse.microprofile.openapi.models.servers.Server> newValue)
    void
    setTags(List<String> 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.Extensible

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

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

    callbacks, deprecated, description, externalDocs, getDescription, getExternalDocs, getSummary, operationId, parameters, requestBody, responses, security, servers, setDescription, setExternalDocs, setSummary, summary, tags

  • Field Details

    • PROPERTIES

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

  • Constructor Details

    • Operation

      public Operation()

  • 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.Operation>

    • filter

      protected org.eclipse.microprofile.openapi.models.Operation filter(org.eclipse.microprofile.openapi.OASFilter filter)
      Overrides:
      filter in class io.smallrye.openapi.model.BaseModel<org.eclipse.microprofile.openapi.models.Operation>

    • getTags

      public List<String> getTags()
      Specified by:
      getTags in interface org.eclipse.microprofile.openapi.models.Operation

    • setTags

      public void setTags(List<String> newValue)
      Specified by:
      setTags in interface org.eclipse.microprofile.openapi.models.Operation

    • addTag

      public Operation addTag(String newValue)
      Specified by:
      addTag in interface org.eclipse.microprofile.openapi.models.Operation

    • removeTag

      public void removeTag(String value)
      Specified by:
      removeTag in interface org.eclipse.microprofile.openapi.models.Operation

    • getOperationId

      public String getOperationId()
      Specified by:
      getOperationId in interface org.eclipse.microprofile.openapi.models.Operation

    • setOperationId

      public void setOperationId(String newValue)
      Specified by:
      setOperationId in interface org.eclipse.microprofile.openapi.models.Operation

    • getParameters

      public List<org.eclipse.microprofile.openapi.models.parameters.Parameter> getParameters()
      Specified by:
      getParameters in interface org.eclipse.microprofile.openapi.models.Operation

    • setParameters

      public void setParameters(List<org.eclipse.microprofile.openapi.models.parameters.Parameter> newValue)
      Specified by:
      setParameters in interface org.eclipse.microprofile.openapi.models.Operation

    • addParameter

      public Operation addParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter newValue)
      Specified by:
      addParameter in interface org.eclipse.microprofile.openapi.models.Operation

    • removeParameter

      public void removeParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter value)
      Specified by:
      removeParameter in interface org.eclipse.microprofile.openapi.models.Operation

    • getRequestBody

      public org.eclipse.microprofile.openapi.models.parameters.RequestBody getRequestBody()
      Specified by:
      getRequestBody in interface org.eclipse.microprofile.openapi.models.Operation

    • setRequestBody

      public void setRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody newValue)
      Specified by:
      setRequestBody in interface org.eclipse.microprofile.openapi.models.Operation

    • getResponses

      public org.eclipse.microprofile.openapi.models.responses.APIResponses getResponses()
      Specified by:
      getResponses in interface org.eclipse.microprofile.openapi.models.Operation

    • setResponses

      public void setResponses(org.eclipse.microprofile.openapi.models.responses.APIResponses newValue)
      Specified by:
      setResponses in interface org.eclipse.microprofile.openapi.models.Operation

    • getCallbacks

      public Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> getCallbacks()
      Specified by:
      getCallbacks in interface org.eclipse.microprofile.openapi.models.Operation

    • setCallbacks

      public void setCallbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> newValue)
      Specified by:
      setCallbacks in interface org.eclipse.microprofile.openapi.models.Operation

    • addCallback

      public Operation addCallback(String newKey, org.eclipse.microprofile.openapi.models.callbacks.Callback newValue)
      Specified by:
      addCallback in interface org.eclipse.microprofile.openapi.models.Operation

    • removeCallback

      public void removeCallback(String key)
      Specified by:
      removeCallback in interface org.eclipse.microprofile.openapi.models.Operation

    • getDeprecated

      public Boolean getDeprecated()
      Specified by:
      getDeprecated in interface org.eclipse.microprofile.openapi.models.Operation

    • setDeprecated

      public void setDeprecated(Boolean newValue)
      Specified by:
      setDeprecated in interface org.eclipse.microprofile.openapi.models.Operation

    • getServers

      public List<org.eclipse.microprofile.openapi.models.servers.Server> getServers()
      Specified by:
      getServers in interface org.eclipse.microprofile.openapi.models.Operation

    • setServers

      public void setServers(List<org.eclipse.microprofile.openapi.models.servers.Server> newValue)
      Specified by:
      setServers in interface org.eclipse.microprofile.openapi.models.Operation

    • addServer

      public Operation addServer(org.eclipse.microprofile.openapi.models.servers.Server newValue)
      Specified by:
      addServer in interface org.eclipse.microprofile.openapi.models.Operation

    • removeServer

      public void removeServer(org.eclipse.microprofile.openapi.models.servers.Server value)
      Specified by:
      removeServer in interface org.eclipse.microprofile.openapi.models.Operation

    • getSecurity

      public List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> getSecurity()
      Specified by:
      getSecurity in interface org.eclipse.microprofile.openapi.models.Operation

    • setSecurity

      public void setSecurity(List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement> newValue)
      Specified by:
      setSecurity in interface org.eclipse.microprofile.openapi.models.Operation

    • addSecurityRequirement

      public Operation addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement newValue)
      Specified by:
      addSecurityRequirement in interface org.eclipse.microprofile.openapi.models.Operation

    • removeSecurityRequirement

      public void removeSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement value)
      Specified by:
      removeSecurityRequirement in interface org.eclipse.microprofile.openapi.models.Operation