sealed trait JsonSchemaDocumentationOps[A] extends AnyRef
Documentation related methods for annotating schemas. Encoder and decoder interpreters ignore this information.
- Alphabetic
- By Inheritance
- JsonSchemaDocumentationOps
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- abstract type Self <: JsonSchema[A]
Abstract Value Members
-
abstract
def
withDescription(description: String): Self
Include a description of what this schema represents
Include a description of what this schema represents
- Encoder and decoder interpreters ignore this description,
- Documentation interpreters can show this description.
- description
information about the values described by the schema
-
abstract
def
withExample(example: A): Self
Include an example of value in this schema
Include an example of value in this schema
- Encoder and decoder interpreters ignore this value,
- Documentation interpreters can show this example value.
- example
Example value to attach to the schema
-
abstract
def
withTitle(title: String): Self
Include a title for the schema
Include a title for the schema
- Encoder and decoder interpreters ignore the title,
- Documentation interpreters can show this title.
- title
short title to attach to the schema
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )