Package io.swagger.v3.oas.models.media

Class AbstractSchema

java.lang.Object
io.swagger.v3.oas.models.media.AbstractSchema
public abstract class AbstractSchema extends Object
This class is updated for OpenAPI 3.0 compliance and is compatible with Spring Boot 3. It replaces the concept of "Property" from Swagger 2 with "Schema" in OpenAPI 3.

  • Field Details

    • name

      protected String name

    • type

      protected String type

    • format

      protected String format

    • example

      protected Object example

    • xml

      protected io.swagger.v3.oas.models.media.XML xml

    • required

      protected boolean required

    • position

      protected Integer position

    • description

      protected String description

    • title

      protected String title

    • readOnly

      protected Boolean readOnly

    • allowEmptyValue

      protected Boolean allowEmptyValue

    • access

      protected String access

    • vendorExtensions

      protected Map<String,Object> vendorExtensions

  • Constructor Details

    • AbstractSchema

      public AbstractSchema()

  • Method Details

    • name

      public AbstractSchema name(String name)

    • type

      public AbstractSchema type(String type)

    • format

      public AbstractSchema format(String format)

    • example

      public AbstractSchema example(Object example)

    • xml

      public AbstractSchema xml(io.swagger.v3.oas.models.media.XML xml)

    • required

      public AbstractSchema required(boolean required)

    • position

      public AbstractSchema position(Integer position)

    • description

      public AbstractSchema description(String description)

    • title

      public AbstractSchema title(String title)

    • readOnly

      public AbstractSchema readOnly(Boolean readOnly)

    • allowEmptyValue

      public AbstractSchema allowEmptyValue(Boolean allowEmptyValue)

    • access

      public AbstractSchema access(String access)

    • vendorExtension

      public AbstractSchema vendorExtension(String name, Object value)

    • vendorExtensions

      public AbstractSchema vendorExtensions(Map<String,Object> vendorExtensions)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getType

      public String getType()

    • setType

      public void setType(String type)

    • getFormat

      public String getFormat()

    • setFormat

      public void setFormat(String format)

    • getExample

      public Object getExample()

    • setExample

      public void setExample(Object example)

    • getXml

      public io.swagger.v3.oas.models.media.XML getXml()

    • setXml

      public void setXml(io.swagger.v3.oas.models.media.XML xml)

    • isRequired

      public boolean isRequired()

    • setRequired

      public void setRequired(boolean required)

    • getPosition

      public Integer getPosition()

    • setPosition

      public void setPosition(Integer position)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getTitle

      public String getTitle()

    • setTitle

      public void setTitle(String title)

    • getReadOnly

      public Boolean getReadOnly()

    • setReadOnly

      public void setReadOnly(Boolean readOnly)

    • getAllowEmptyValue

      public Boolean getAllowEmptyValue()

    • setAllowEmptyValue

      public void setAllowEmptyValue(Boolean allowEmptyValue)

    • getAccess

      public String getAccess()

    • setAccess

      public void setAccess(String access)

    • getVendorExtensions

      public Map<String,Object> getVendorExtensions()

    • setVendorExtension

      public void setVendorExtension(String name, Object value)

    • setVendorExtensions

      public void setVendorExtensions(Map<String,Object> vendorExtensions)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object