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

Interface StringTypeDeclaration

All Superinterfaces:

Annotable, TypeDeclaration

public interface StringTypeDeclaration
extends TypeDeclaration

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	enumValues() (Optional, applicable only for parameters of type string) The enum attribute provides an enumeration of the parameter's valid values.
Integer	maxLength() Maximum length of the string
Integer	minLength() Minimum length of the string
String	pattern() Regular expression that this string should path

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

pattern

String pattern()

Regular expression that this string should path

minLength

Integer minLength()

Minimum length of the string

maxLength

Integer maxLength()

Maximum length of the string

enumValues

List<String> enumValues()

(Optional, applicable only for parameters of type string) The enum attribute provides an enumeration of the parameter's valid values. This MUST be an array. If the enum attribute is defined, API clients and servers MUST verify that a parameter's value matches a value in the enum array. If there is no matching value, the clients and servers MUST treat this as an error.