Sha256: 1eb2193ee979c295dac535c156227e9e7c541ec5e023d89e1cbe4762475c3563
Contents?: true
Size: 1.5 KB
Versions: 164
Compression:
Stored size: 1.5 KB
Contents
package sh.calaba.org.codehaus.jackson.schema;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Retention;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
import sh.calaba.org.codehaus.jackson.annotate.JacksonAnnotation;
/**
* Annotation that can be used to define JSON Schema definition for
* the annotated class.
*<p>
* 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
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonSerializableSchema
{
/**
* The schema type for this JsonSerializable instance.
* Possible values: "string", "number", "boolean", "object", "array", "null", "any"
*
* @return The schema type for this JsonSerializable instance.
*/
String schemaType() default "any";
/**
* If the schema type is "object", the node that defines the properties of the object.
*
* @return The node representing the schema properties, or "##irrelevant" if irrelevant.
*/
String schemaObjectPropertiesDefinition() default "##irrelevant";
/**
* If the schema type if "array", the node that defines the schema for the items in the array.
*
* @return The schema for the items in the array, or "##irrelevant" if irrelevant.
*/
String schemaItemDefinition() default "##irrelevant";
}
Version data entries
164 entries across 164 versions & 2 rubygems