algebra/endpoints4s.algebra/EndpointsWithCustomErrors/EndpointDocs

EndpointDocs

object EndpointDocs
Companion:
class
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply(): EndpointDocs
Returns:

An empty documentation value, with no summary, no description, no tags, no callbacks, and the deprecated flag set to false. You can transform the returned EndpointDocs value by using the withXxx operations:

 EndpointDocs().withSummary(Some("endpoint summary"))

Deprecated methods

@deprecated("Use `EndpointDocs().withXxx(...)` instead of `EndpointDocs(xxx = ...)`", "1.0.0")
def apply(summary: Documentation, description: Documentation, tags: List[String], callbacks: Map[String, CallbacksDocs], deprecated: Boolean): EndpointDocs
Deprecated