Record Class OpenAPIDocument

java.lang.Object
java.lang.Record
org.infinispan.rest.framework.openapi.OpenAPIDocument
Record Components:
openapi - : A required field with the SemVer of the OpenAPI specification.
info - : A required field that contains metadata about the API.
paths - : A required property with the paths and operation available in the API.
All Implemented Interfaces:
JsonSerialization
public record OpenAPIDocument(String openapi, Info info, Paths paths, Components components, Collection<ResourceDescription> resources) extends Record implements JsonSerialization
This is the root document object of the OpenAPI document.
See Also:

  • Constructor Details

    • OpenAPIDocument

      public OpenAPIDocument(String openapi, Info info, Paths paths, Components components, Collection<ResourceDescription> resources)
      Creates an instance of a OpenAPIDocument record class.
      Parameters:
      openapi - the value for the openapi record component
      info - the value for the info record component
      paths - the value for the paths record component
      components - the value for the components record component
      resources - the value for the resources record component

  • Method Details

    • toJson

      public Json toJson()
      Specified by:
      toJson in interface JsonSerialization

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • openapi

      public String openapi()
      Returns the value of the openapi record component.
      Returns:
      the value of the openapi record component

    • info

      public Info info()
      Returns the value of the info record component.
      Returns:
      the value of the info record component

    • paths

      public Paths paths()
      Returns the value of the paths record component.
      Returns:
      the value of the paths record component

    • components

      public Components components()
      Returns the value of the components record component.
      Returns:
      the value of the components record component

    • resources

      public Collection<ResourceDescription> resources()
      Returns the value of the resources record component.
      Returns:
      the value of the resources record component