com.kjetland.jackson.jsonSchema.annotations.JsonSchemaString Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mbknor-jackson-jsonschema_2.12 Show documentation

mbknor-jackson-jsonSchema

The newest version!

package com.kjetland.jackson.jsonSchema.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;

/**
 * Injects custom values to the schema generated for fields or getters.
 *
 * @author bbyk
 */
@Target({METHOD, FIELD, TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface JsonSchemaString {
    /**
     * @return a slash separated path to the value in the schema
     */
    String path();

    /**
     * @return a string value to place in the schema
     */
    String value();
}