Package io.smallrye.openapi.internal.models

Class Components

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

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Components
    addCallback(String newKey, org.eclipse.microprofile.openapi.models.callbacks.Callback newValue)
    Components
    addExample(String newKey, org.eclipse.microprofile.openapi.models.examples.Example newValue)
    Components
    addHeader(String newKey, org.eclipse.microprofile.openapi.models.headers.Header newValue)
    Components
    addLink(String newKey, org.eclipse.microprofile.openapi.models.links.Link newValue)
    Components
    addParameter(String newKey, org.eclipse.microprofile.openapi.models.parameters.Parameter newValue)
    Components
    addPathItem(String newKey, org.eclipse.microprofile.openapi.models.PathItem newValue)
    Components
    addRequestBody(String newKey, org.eclipse.microprofile.openapi.models.parameters.RequestBody newValue)
    Components
    addResponse(String newKey, org.eclipse.microprofile.openapi.models.responses.APIResponse newValue)
    Components
    addSchema(String newKey, org.eclipse.microprofile.openapi.models.media.Schema newValue)
    Components
    addSecurityScheme(String newKey, org.eclipse.microprofile.openapi.models.security.SecurityScheme newValue)
    Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback>
    getCallbacks()
    Map<String,org.eclipse.microprofile.openapi.models.examples.Example>
    getExamples()
    Map<String,org.eclipse.microprofile.openapi.models.headers.Header>
    getHeaders()
    Map<String,org.eclipse.microprofile.openapi.models.links.Link>
    getLinks()
    Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter>
    getParameters()
    Map<String,org.eclipse.microprofile.openapi.models.PathItem>
    getPathItems()
    io.smallrye.openapi.model.PropertyMetadata
    getPropertyMetadata()
     
    Map<String,org.eclipse.microprofile.openapi.models.parameters.RequestBody>
    getRequestBodies()
    Map<String,org.eclipse.microprofile.openapi.models.responses.APIResponse>
    getResponses()
    Map<String,org.eclipse.microprofile.openapi.models.media.Schema>
    getSchemas()
    Map<String,org.eclipse.microprofile.openapi.models.security.SecurityScheme>
    getSecuritySchemes()
    void
    removeCallback(String key)
    void
    removeExample(String key)
    void
    removeHeader(String key)
    void
    removeLink(String key)
    void
    removeParameter(String key)
    void
    removePathItem(String key)
    void
    removeRequestBody(String key)
    void
    removeResponse(String key)
    void
    removeSchema(String key)
    void
    removeSecurityScheme(String key)
    void
    setCallbacks(Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback> newValue)
    void
    setExamples(Map<String,org.eclipse.microprofile.openapi.models.examples.Example> 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)
    void
    setParameters(Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter> newValue)
    void
    setPathItems(Map<String,org.eclipse.microprofile.openapi.models.PathItem> newValue)
    void
    setRequestBodies(Map<String,org.eclipse.microprofile.openapi.models.parameters.RequestBody> newValue)
    void
    setResponses(Map<String,org.eclipse.microprofile.openapi.models.responses.APIResponse> newValue)
    void
    setSchemas(Map<String,org.eclipse.microprofile.openapi.models.media.Schema> newValue)
    void
    setSecuritySchemes(Map<String,org.eclipse.microprofile.openapi.models.security.SecurityScheme> 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, 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.Components

    callbacks, examples, headers, links, parameters, pathItems, requestBodies, responses, schemas, securitySchemes

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

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

  • Field Details

    • PROPERTIES

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

  • Constructor Details

    • Components

      public Components()

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

    • getSchemas

      public Map<String,org.eclipse.microprofile.openapi.models.media.Schema> getSchemas()
      Specified by:
      getSchemas in interface org.eclipse.microprofile.openapi.models.Components

    • setSchemas

      public void setSchemas(Map<String,org.eclipse.microprofile.openapi.models.media.Schema> newValue)
      Specified by:
      setSchemas in interface org.eclipse.microprofile.openapi.models.Components

    • addSchema

      public Components addSchema(String newKey, org.eclipse.microprofile.openapi.models.media.Schema newValue)
      Specified by:
      addSchema in interface org.eclipse.microprofile.openapi.models.Components

    • removeSchema

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

    • getResponses

      public Map<String,org.eclipse.microprofile.openapi.models.responses.APIResponse> getResponses()
      Specified by:
      getResponses in interface org.eclipse.microprofile.openapi.models.Components

    • setResponses

      public void setResponses(Map<String,org.eclipse.microprofile.openapi.models.responses.APIResponse> newValue)
      Specified by:
      setResponses in interface org.eclipse.microprofile.openapi.models.Components

    • addResponse

      public Components addResponse(String newKey, org.eclipse.microprofile.openapi.models.responses.APIResponse newValue)
      Specified by:
      addResponse in interface org.eclipse.microprofile.openapi.models.Components

    • removeResponse

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

    • getParameters

      public Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter> getParameters()
      Specified by:
      getParameters in interface org.eclipse.microprofile.openapi.models.Components

    • setParameters

      public void setParameters(Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter> newValue)
      Specified by:
      setParameters in interface org.eclipse.microprofile.openapi.models.Components

    • addParameter

      public Components addParameter(String newKey, org.eclipse.microprofile.openapi.models.parameters.Parameter newValue)
      Specified by:
      addParameter in interface org.eclipse.microprofile.openapi.models.Components

    • removeParameter

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

    • getExamples

      public Map<String,org.eclipse.microprofile.openapi.models.examples.Example> getExamples()
      Specified by:
      getExamples in interface org.eclipse.microprofile.openapi.models.Components

    • setExamples

      public void setExamples(Map<String,org.eclipse.microprofile.openapi.models.examples.Example> newValue)
      Specified by:
      setExamples in interface org.eclipse.microprofile.openapi.models.Components

    • addExample

      public Components addExample(String newKey, org.eclipse.microprofile.openapi.models.examples.Example newValue)
      Specified by:
      addExample in interface org.eclipse.microprofile.openapi.models.Components

    • removeExample

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

    • getRequestBodies

      public Map<String,org.eclipse.microprofile.openapi.models.parameters.RequestBody> getRequestBodies()
      Specified by:
      getRequestBodies in interface org.eclipse.microprofile.openapi.models.Components

    • setRequestBodies

      public void setRequestBodies(Map<String,org.eclipse.microprofile.openapi.models.parameters.RequestBody> newValue)
      Specified by:
      setRequestBodies in interface org.eclipse.microprofile.openapi.models.Components

    • addRequestBody

      public Components addRequestBody(String newKey, org.eclipse.microprofile.openapi.models.parameters.RequestBody newValue)
      Specified by:
      addRequestBody in interface org.eclipse.microprofile.openapi.models.Components

    • removeRequestBody

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

    • getHeaders

      public Map<String,org.eclipse.microprofile.openapi.models.headers.Header> getHeaders()
      Specified by:
      getHeaders in interface org.eclipse.microprofile.openapi.models.Components

    • setHeaders

      public void setHeaders(Map<String,org.eclipse.microprofile.openapi.models.headers.Header> newValue)
      Specified by:
      setHeaders in interface org.eclipse.microprofile.openapi.models.Components

    • addHeader

      public Components addHeader(String newKey, org.eclipse.microprofile.openapi.models.headers.Header newValue)
      Specified by:
      addHeader in interface org.eclipse.microprofile.openapi.models.Components

    • removeHeader

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

    • getSecuritySchemes

      public Map<String,org.eclipse.microprofile.openapi.models.security.SecurityScheme> getSecuritySchemes()
      Specified by:
      getSecuritySchemes in interface org.eclipse.microprofile.openapi.models.Components

    • setSecuritySchemes

      public void setSecuritySchemes(Map<String,org.eclipse.microprofile.openapi.models.security.SecurityScheme> newValue)
      Specified by:
      setSecuritySchemes in interface org.eclipse.microprofile.openapi.models.Components

    • addSecurityScheme

      public Components addSecurityScheme(String newKey, org.eclipse.microprofile.openapi.models.security.SecurityScheme newValue)
      Specified by:
      addSecurityScheme in interface org.eclipse.microprofile.openapi.models.Components

    • removeSecurityScheme

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

    • getLinks

      public Map<String,org.eclipse.microprofile.openapi.models.links.Link> getLinks()
      Specified by:
      getLinks in interface org.eclipse.microprofile.openapi.models.Components

    • setLinks

      public void setLinks(Map<String,org.eclipse.microprofile.openapi.models.links.Link> newValue)
      Specified by:
      setLinks in interface org.eclipse.microprofile.openapi.models.Components

    • addLink

      public Components addLink(String newKey, org.eclipse.microprofile.openapi.models.links.Link newValue)
      Specified by:
      addLink in interface org.eclipse.microprofile.openapi.models.Components

    • removeLink

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

    • getCallbacks

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

    • setCallbacks

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

    • addCallback

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

    • removeCallback

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

    • getPathItems

      public Map<String,org.eclipse.microprofile.openapi.models.PathItem> getPathItems()
      Specified by:
      getPathItems in interface org.eclipse.microprofile.openapi.models.Components

    • setPathItems

      public void setPathItems(Map<String,org.eclipse.microprofile.openapi.models.PathItem> newValue)
      Specified by:
      setPathItems in interface org.eclipse.microprofile.openapi.models.Components

    • addPathItem

      public Components addPathItem(String newKey, org.eclipse.microprofile.openapi.models.PathItem newValue)
      Specified by:
      addPathItem in interface org.eclipse.microprofile.openapi.models.Components

    • removePathItem

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