org.raml.v2.api.model.v10.datamodel

Interface ObjectTypeDeclaration

All Superinterfaces:

Annotable, TypeDeclaration

public interface ObjectTypeDeclaration
extends TypeDeclaration

Method Summary

Methods

Modifier and Type	Method and Description
TypeDeclaration	additionalProperties() JSON schema style syntax for declaring maps
String	discriminator() Type property name to be used as discriminator, or boolean
String	discriminatorValue() The value of discriminator for the type.
Integer	maxProperties() The maximum number of properties allowed for instances of this type.
Integer	minProperties() The minimum number of properties allowed for instances of this type.
List<TypeDeclaration>	patternProperties() JSON schema style syntax for declaring key restricted maps
List<TypeDeclaration>	properties() The properties that instances of this type may or must have.

Methods inherited from interface org.raml.v2.api.model.v10.datamodel.TypeDeclaration

allowedTargets, defaultValue, description, displayName, example, examples, fixedFacets, isAnnotation, name, required, schema, schemaContent, type, validate

Methods inherited from interface org.raml.v2.api.model.v10.common.Annotable

annotations

Method Detail

properties

List<TypeDeclaration> properties()

The properties that instances of this type may or must have.

minProperties

Integer minProperties()

The minimum number of properties allowed for instances of this type.

maxProperties

Integer maxProperties()

The maximum number of properties allowed for instances of this type.

additionalProperties

TypeDeclaration additionalProperties()

JSON schema style syntax for declaring maps

patternProperties

List<TypeDeclaration> patternProperties()

JSON schema style syntax for declaring key restricted maps

discriminator

String discriminator()

Type property name to be used as discriminator, or boolean

discriminatorValue

String discriminatorValue()

The value of discriminator for the type.