algebra
API
Generated with
algebra/endpoints4s/endpoints4s.algebra/EndpointsWithCustomErrors/EndpointDocs

EndpointDocs

endpoints4s.algebra.EndpointsWithCustomErrors.EndpointDocs
See theEndpointDocs companion class
object EndpointDocs

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def apply(): EndpointDocs

Attributes

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

def apply(summary: Documentation, description: Documentation, tags: List[String], callbacks: Map[String, CallbacksDocs], deprecated: Boolean): EndpointDocs

Attributes

Deprecated
true
Generated with