org.raml.v2.api.model.v08.parameters

Interface StringTypeDeclaration

All Superinterfaces:

Parameter, RAMLLanguageElement

public interface StringTypeDeclaration
extends Parameter

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() (Optional, applicable only for parameters of type string) The maxLength attribute specifies the parameter value's maximum number of characters.
Integer	minLength() (Optional, applicable only for parameters of type string) The minLength attribute specifies the parameter value's minimum number of characters.
String	pattern() (Optional, applicable only for parameters of type string) The pattern attribute is a regular expression that a parameter of type string MUST match.

Methods inherited from interface org.raml.v2.api.model.v08.parameters.Parameter

defaultValue, displayName, example, location, name, repeat, required, type

Methods inherited from interface org.raml.v2.api.model.v08.common.RAMLLanguageElement

description

Method Detail

pattern

String pattern()

(Optional, applicable only for parameters of type string) The pattern attribute is a regular expression that a parameter of type string MUST match. Regular expressions MUST follow the regular expression specification from ECMA 262/Perl 5. The pattern MAY be enclosed in double quotes for readability and clarity.

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.

minLength

Integer minLength()

(Optional, applicable only for parameters of type string) The minLength attribute specifies the parameter value's minimum number of characters.

maxLength

Integer maxLength()

(Optional, applicable only for parameters of type string) The maxLength attribute specifies the parameter value's maximum number of characters.