json-schema-generic/endpoints4s.generic/name

name

case class name(value: String) extends Annotation

Defines the name of a generic schema.

Annotate a sealed trait or case class definition with this annotation to define its schema name. Setting the name of a schema explicitly means that you can control exactly what the URI of the JSON schema will be in the OpenAPI documentation.

Value parameters:
value

Name of the schema

See also:

Use title to customize the user-friendly name of the schema in the OpenAPI documentation

Note:

The name of the schema is used internally by OpenAPI in the URI that gets used to refer to the schema. Consequently, the name set here should include only characters allowed in URIs.

trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Inherited methods

def productIterator: Iterator[Any]
Inherited from:
Product