org.apache.juneau.jsonschema.annotation

Annotation Type JsonSchemaConfig

@Documented
 @Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
 @PropertyStoreApply(value=JsonSchemaConfigApply.class)
public @interface JsonSchemaConfig

Annotation for specifying config properties defined in JsonSchemaGenerator.

Used primarily for specifying bean configuration properties on REST classes and methods.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	addDescriptionsTo Configuration property: Add descriptions to types.
String	addExamplesTo Configuration property: Add examples.
String	allowNestedDescriptions Configuration property: Allow nested descriptions.
String	allowNestedExamples Configuration property: Allow nested examples.
Schema[]	applySchema Dynamically applies @Schema annotations to specified classes/methods/fields.
Class<? extends BeanDefMapper>	beanDefMapper Configuration property: Bean schema definition mapper.
CS[]	defaultSchemas Configuration property: Default schemas.
String	ignoreTypes Configuration property: Ignore types from schema definitions.
int	rank Optional rank for this config.
String	useBeanDefs Configuration property: Use bean definitions.

Element Detail

rank

public abstract int rank

Optional rank for this config.

Can be used to override default ordering and application of config annotations.

Default:

0

addDescriptionsTo

public abstract String addDescriptionsTo

Configuration property: Add descriptions to types.

Identifies which categories of types that descriptions should be automatically added to generated schemas.

The description is the result of calling ClassMeta.getFullName().

• The format is a comma-delimited list of any of the following values:
  • "BEAN"
  • "COLLECTION"
  • "ARRAY"
  • "MAP"
  • "STRING"
  • "NUMBER"
  • "BOOLEAN"
  • "ANY"
  • "OTHER"
• Supports Overview > juneau-marshall > Simple Variable Language > VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

• JsonSchemaGenerator.JSONSCHEMA_addDescriptionsTo

Default:

""

addExamplesTo

public abstract String addExamplesTo

Configuration property: Add examples.

Identifies which categories of types that examples should be automatically added to generated schemas.

The examples come from calling ClassMeta.getExample(BeanSession) which in turn gets examples from the following:

• Example
• BeanContext.BEAN_examples

• The format is a comma-delimited list of any of the following values:
  • "BEAN"
  • "COLLECTION"
  • "ARRAY"
  • "MAP"
  • "STRING"
  • "NUMBER"
  • "BOOLEAN"
  • "ANY"
  • "OTHER"
• Supports Overview > juneau-marshall > Simple Variable Language > VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

• JsonSchemaGenerator.JSONSCHEMA_addDescriptionsTo

Default:

""

allowNestedDescriptions

public abstract String allowNestedDescriptions

Configuration property: Allow nested descriptions.

Identifies whether nested descriptions are allowed in schema definitions.

• Possible values:
  • "true"
  • "false" (default)
• Supports Overview > juneau-marshall > Simple Variable Language > VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

• JsonSchemaGenerator.JSONSCHEMA_allowNestedDescriptions

Default:

""

allowNestedExamples

public abstract String allowNestedExamples

Configuration property: Allow nested examples.

Identifies whether nested examples are allowed in schema definitions.

• Possible values:
  • "true"
  • "false" (default)
• Supports Overview > juneau-marshall > Simple Variable Language > VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

• JsonSchemaGenerator.JSONSCHEMA_allowNestedExamples

Default:

""

applySchema

public abstract Schema[] applySchema

Dynamically applies @Schema annotations to specified classes/methods/fields.

Provides an alternate approach for applying annotations using @Schema.on to specify the names to apply the annotation to.

• Overview > juneau-marshall > Dynamically Applied Annotations

Default:

{}

beanDefMapper

public abstract Class<? extends BeanDefMapper> beanDefMapper

Configuration property: Bean schema definition mapper.

Interface to use for converting Bean classes to definition IDs and URIs.

Used primarily for defining common definition sections for beans in Swagger JSON.

• This setting is ignored if JsonSchemaGenerator.JSONSCHEMA_useBeanDefs is not enabled.

• JsonSchemaGenerator.JSONSCHEMA_beanDefMapper

Default:

org.apache.juneau.jsonschema.BeanDefMapper.Null.class

defaultSchemas

public abstract CS[] defaultSchemas

Configuration property: Default schemas.

Allows you to override or provide custom schema information for particular class types.

• Keys are the class.
  Values are Simple-JSON objects.
• Supports Overview > juneau-marshall > Simple Variable Language > VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

• JsonSchemaGenerator.JSONSCHEMA_defaultSchemas

Default:

{}

ignoreTypes

public abstract String ignoreTypes

Configuration property: Ignore types from schema definitions.

Defines class name patterns that should be ignored when generating schema definitions in the generated Swagger documentation.

• Format: Comma-delimited list of patterns
• Supports Overview > juneau-marshall > Simple Variable Language > VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

• JsonSchemaGenerator.JSONSCHEMA_ignoreTypes

Default:

""

useBeanDefs

public abstract String useBeanDefs

Configuration property: Use bean definitions.

When enabled, schemas on beans will be serialized as the following:

{ type: 'object', '$ref': '#/definitions/TypeId' }

The definitions can then be retrieved from the session using JsonSchemaGeneratorSession.getBeanDefs().

Definitions can also be added programmatically using JsonSchemaGeneratorSession.addBeanDef(String, OMap).

• Possible values:
  • "true"
  • "false" (default)
• Supports Overview > juneau-marshall > Simple Variable Language > VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

• JsonSchemaGenerator.JSONSCHEMA_useBeanDefs

Default:

""