Package org.codehaus.jackson.schema
Annotation Type JsonSerializableSchema
Annotation that can be used to define JSON Schema definition for
the annotated class.
Note that annotation is often not needed: for example, regular Jackson beans that Jackson can introspect can be used without annotations, to produce JSON schema definition.
- Author:
- Ryan Heaton
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionIf the schema type if "array", the node that defines the schema for the items in the array.If the schema type is "object", the node that defines the properties of the object.The schema type for this JsonSerializable instance.
-
Element Details
-
schemaType
String schemaTypeThe schema type for this JsonSerializable instance. Possible values: "string", "number", "boolean", "object", "array", "null", "any"- Returns:
- The schema type for this JsonSerializable instance.
- Default:
"any"
-
schemaObjectPropertiesDefinition
String schemaObjectPropertiesDefinitionIf the schema type is "object", the node that defines the properties of the object.- Returns:
- The node representing the schema properties, or "##irrelevant" if irrelevant.
- Default:
"##irrelevant"
-
schemaItemDefinition
String schemaItemDefinitionIf the schema type if "array", the node that defines the schema for the items in the array.- Returns:
- The schema for the items in the array, or "##irrelevant" if irrelevant.
- Default:
"##irrelevant"
-