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

Interface TypeDeclaration

All Superinterfaces:

Annotable

All Known Subinterfaces:

ArrayTypeDeclaration, BooleanTypeDeclaration, DateOnlyTypeDeclaration, DateTimeOnlyTypeDeclaration, DateTimeTypeDeclaration, DateTypeDeclaration, FileTypeDeclaration, IntegerTypeDeclaration, NumberTypeDeclaration, ObjectTypeDeclaration, StringTypeDeclaration, TimeOnlyTypeDeclaration, UnionTypeDeclaration

public interface TypeDeclaration
extends Annotable

Method Summary

Methods

Modifier and Type	Method and Description
List<AnnotationTarget>	allowedTargets() Restrictions on where annotations of this type can be applied.
String	defaultValue() Provides default value for a property
MarkdownString	description() A longer, human-friendly description of the type
String	displayName() The displayName attribute specifies the type display name.
ExampleSpec	example() An example of this type instance represented as string or yaml map/sequence.
List<ExampleSpec>	examples() An example of this type instance represented as string.
TypeInstance	fixedFacets() Returns facets fixed by the type.
Boolean	isAnnotation() Whether the type represents annotation
String	name() name of the parameter
Boolean	required() Sets if property is optional or not
List<String>	schema() Alias for the equivalent "type" property, for compatibility with RAML 0.8.
String	schemaContent() Returns schema/type content for the cases when schema is inlined
List<String>	type() A base type which the current type extends, or more generally a type expression.
List<ValidationResult>	validate(String payload) Validates payload against the type/schema defined

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

annotations

Method Detail

name

String name()

name of the parameter

displayName

String displayName()

The displayName attribute specifies the type display name. It is a friendly name used only for display or documentation purposes. If displayName is not specified, it defaults to the element's key (the name of the property itself).

schema

List<String> schema()

Alias for the equivalent "type" property, for compatibility with RAML 0.8. Deprecated - API definitions should use the "type" property, as the "schema" alias for that property name may be removed in a future RAML version. The "type" property allows for XML and JSON schemas.

type

List<String> type()

A base type which the current type extends, or more generally a type expression.

defaultValue

String defaultValue()

Provides default value for a property

example

ExampleSpec example()

An example of this type instance represented as string or yaml map/sequence. This can be used, e.g., by documentation generators to generate sample values for an object of this type. Cannot be present if the examples property is present.

examples

List<ExampleSpec> examples()

An example of this type instance represented as string. This can be used, e.g., by documentation generators to generate sample values for an object of this type. Cannot be present if the example property is present.

required

Boolean required()

Sets if property is optional or not

description

MarkdownString description()

A longer, human-friendly description of the type

allowedTargets

List<AnnotationTarget> allowedTargets()

Restrictions on where annotations of this type can be applied. If this property is specified, annotations of this type may only be applied on a property corresponding to one of the target names specified as the value of this property.

isAnnotation

Boolean isAnnotation()

Whether the type represents annotation

fixedFacets

TypeInstance fixedFacets()

Returns facets fixed by the type. Value is an object with properties named after facets fixed. Value of each property is a value of the corresponding facet.

validate

List<ValidationResult> validate(String payload)

Validates payload against the type/schema defined

Parameters:

payload - the payload to be validated

Returns:

the list of errors if any or an empty list if validation succeeded

schemaContent

String schemaContent()

Returns schema/type content for the cases when schema is inlined