Package io.smallrye.openapi.internal.models

Class AbstractOpenAPI

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

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    AbstractOpenAPI
    addSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement newValue)
    AbstractOpenAPI
    addServer(org.eclipse.microprofile.openapi.models.servers.Server newValue)
    AbstractOpenAPI
    addTag(org.eclipse.microprofile.openapi.models.tags.Tag newValue)
    AbstractOpenAPI
    addWebhook(String newKey, org.eclipse.microprofile.openapi.models.PathItem newValue)
    protected org.eclipse.microprofile.openapi.models.OpenAPI
    filter(org.eclipse.microprofile.openapi.OASFilter filter)
    org.eclipse.microprofile.openapi.models.Components
    getComponents()
    org.eclipse.microprofile.openapi.models.info.Info
    getInfo()
    String
    getJsonSchemaDialect()
    String
    getOpenapi()
    org.eclipse.microprofile.openapi.models.Paths
    getPaths()
    io.smallrye.openapi.model.PropertyMetadata
    getPropertyMetadata()
     
    List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>
    getSecurity()
    List<org.eclipse.microprofile.openapi.models.servers.Server>
    getServers()
    List<org.eclipse.microprofile.openapi.models.tags.Tag>
    getTags()
    Map<String,org.eclipse.microprofile.openapi.models.PathItem>
    getWebhooks()
    void
    removeSecurityRequirement(org.eclipse.microprofile.openapi.models.security.SecurityRequirement value)
    void
    removeServer(org.eclipse.microprofile.openapi.models.servers.Server value)
    void
    removeTag(org.eclipse.microprofile.openapi.models.tags.Tag value)
    void
    removeWebhook(String key)
    void
    setComponents(org.eclipse.microprofile.openapi.models.Components newValue)
    void
    setInfo(org.eclipse.microprofile.openapi.models.info.Info newValue)
    void
    setJsonSchemaDialect(String newValue)
    void
    setOpenapi(String newValue)
    void
    setPaths(org.eclipse.microprofile.openapi.models.Paths 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<org.eclipse.microprofile.openapi.models.tags.Tag> newValue)
    void
    setWebhooks(Map<String,org.eclipse.microprofile.openapi.models.PathItem> 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.OpenAPI

    components, externalDocs, getExternalDocs, info, jsonSchemaDialect, openapi, paths, security, servers, setExternalDocs, tags, webhooks

  • Field Details

    • PROPERTIES

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

  • Constructor Details

    • AbstractOpenAPI

      public AbstractOpenAPI()

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

    • filter

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

    • getOpenapi

      public String getOpenapi()
      Specified by:
      getOpenapi in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • setOpenapi

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

    • getInfo

      public org.eclipse.microprofile.openapi.models.info.Info getInfo()
      Specified by:
      getInfo in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • setInfo

      public void setInfo(org.eclipse.microprofile.openapi.models.info.Info newValue)
      Specified by:
      setInfo in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • getServers

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

    • setServers

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

    • addServer

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

    • removeServer

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

    • getSecurity

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

    • setSecurity

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

    • addSecurityRequirement

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

    • removeSecurityRequirement

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

    • getTags

      public List<org.eclipse.microprofile.openapi.models.tags.Tag> getTags()
      Specified by:
      getTags in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • setTags

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

    • addTag

      public AbstractOpenAPI addTag(org.eclipse.microprofile.openapi.models.tags.Tag newValue)
      Specified by:
      addTag in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • removeTag

      public void removeTag(org.eclipse.microprofile.openapi.models.tags.Tag value)
      Specified by:
      removeTag in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • getPaths

      public org.eclipse.microprofile.openapi.models.Paths getPaths()
      Specified by:
      getPaths in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • setPaths

      public void setPaths(org.eclipse.microprofile.openapi.models.Paths newValue)
      Specified by:
      setPaths in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • getWebhooks

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

    • setWebhooks

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

    • addWebhook

      public AbstractOpenAPI addWebhook(String newKey, org.eclipse.microprofile.openapi.models.PathItem newValue)
      Specified by:
      addWebhook in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • removeWebhook

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

    • getComponents

      public org.eclipse.microprofile.openapi.models.Components getComponents()
      Specified by:
      getComponents in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • setComponents

      public void setComponents(org.eclipse.microprofile.openapi.models.Components newValue)
      Specified by:
      setComponents in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • getJsonSchemaDialect

      public String getJsonSchemaDialect()
      Specified by:
      getJsonSchemaDialect in interface org.eclipse.microprofile.openapi.models.OpenAPI

    • setJsonSchemaDialect

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