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

Interface Parameter

All Superinterfaces:

RAMLLanguageElement

All Known Subinterfaces:

BooleanTypeDeclaration, DateTypeDeclaration, FileTypeDeclaration, IntegerTypeDeclaration, NumberTypeDeclaration, StringTypeDeclaration

public interface Parameter
extends RAMLLanguageElement

Method Summary

Methods

Modifier and Type	Method and Description
Object	defaultValue() The default attribute specifies the default value to use for the property if the property is omitted or its value is not specified.
String	displayName() An alternate, human-friendly name for the parameter
String	example() (Optional) The example attribute shows an example value for the property.
ParameterLocation	location() Location of the parameter (can not be edited by user)
String	name() name of the parameter
Boolean	repeat() The repeat attribute specifies that the parameter can be repeated.
Boolean	required() Set to true if parameter is required
String	type() The type attribute specifies the primitive type of the parameter's resolved value.

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

description

Method Detail

name

String name()

name of the parameter

displayName

String displayName()

An alternate, human-friendly name for the parameter

type

String type()

The type attribute specifies the primitive type of the parameter's resolved value. API clients MUST return/throw an error if the parameter's resolved value does not match the specified type. If type is not specified, it defaults to string.

location

ParameterLocation location()

Location of the parameter (can not be edited by user)

required

Boolean required()

Set to true if parameter is required

defaultValue

Object defaultValue()

The default attribute specifies the default value to use for the property if the property is omitted or its value is not specified. This SHOULD NOT be interpreted as a requirement for the client to send the default attribute's value if there is no other value to send. Instead, the default attribute's value is the value the server uses if the client does not send a value.

example

String example()

(Optional) The example attribute shows an example value for the property. This can be used, e.g., by documentation generators to generate sample values for the property.

repeat

Boolean repeat()

The repeat attribute specifies that the parameter can be repeated. If the parameter can be used multiple times, the repeat parameter value MUST be set to 'true'. Otherwise, the default value is 'false' and the parameter may not be repeated.