Package com.arc_e_tect.gradle.mirage.openapi

Record Class DescribedEndpoint

java.lang.Object
java.lang.Record
com.arc_e_tect.gradle.mirage.openapi.DescribedEndpoint
Record Components:
verb - the HTTP verb the OpenAPI operation is documented under; never HttpVerb.ANY
path - the OpenAPI path template, e.g. "/users/{id}"
operationId - the operation's operationId, or null when not set
tags - the operation's tags, in document order; empty when none are set, never null
public record DescribedEndpoint(HttpVerb verb, String path, String operationId, List<String> tags) extends Record
A single HTTP verb + path template pair described by an OpenAPI operation.

  • Constructor Details

    • DescribedEndpoint

      public DescribedEndpoint(HttpVerb verb, String path, String operationId, List<String> tags)
      Creates an instance of a DescribedEndpoint record class.
      Parameters:
      verb - the value for the verb record component
      path - the value for the path record component
      operationId - the value for the operationId record component
      tags - the value for the tags 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. 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.

    • verb

      public HttpVerb verb()
      Returns the value of the verb record component.
      Returns:
      the value of the verb record component

    • path

      public String path()
      Returns the value of the path record component.
      Returns:
      the value of the path 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