Record Class ApiDocDetails

java.lang.Object
java.lang.Record
io.fluxzero.sdk.web.ApiDocDetails
public record ApiDocDetails(String summary, String description, String operationId, List<String> tags, boolean deprecated, List<String> security) extends Record
Human-authored documentation metadata associated with an API endpoint.

  • Constructor Details

    • ApiDocDetails

      public ApiDocDetails(String summary, String description, String operationId, List<String> tags, boolean deprecated, List<String> security)
      Creates an instance of a ApiDocDetails record class.
      Parameters:
      summary - the value for the summary record component
      description - the value for the description record component
      operationId - the value for the operationId record component
      tags - the value for the tags record component
      deprecated - the value for the deprecated record component
      security - the value for the security record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • summary

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

    • description

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

    • operationId

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

    • tags

      public List<String> tags()
      Returns the value of the tags record component.
      Returns:
      the value of the tags record component

    • deprecated

      public boolean deprecated()
      Returns the value of the deprecated record component.
      Returns:
      the value of the deprecated record component

    • security

      public List<String> security()
      Returns the value of the security record component.
      Returns:
      the value of the security record component