org.raml.v2.model.v10.resources

Interface ResourceType

All Superinterfaces:

AbstractWrapperNode, Annotable, BasicFragmentNode, BasicNode, ResourceBase

public interface ResourceType
extends ResourceBase

Method Summary

Methods

Modifier and Type	Method and Description
String	displayName() The displayName attribute specifies the resource type display name.
String	name() Name of the resource type
TypeInstance	parametrizedProperties() Returns object representation of parametrized properties of the resource type
String	usage() Instructions on how and when the resource type should be used.

Methods inherited from interface org.raml.v2.model.v10.resources.ResourceBase

description, is, methods, securedBy, type, uriParameters

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

annotations

Methods inherited from interface org.raml.v2.model.v10.fragment.BasicFragmentNode

fragment

Methods inherited from interface org.raml.v2.model.v10.core.BasicNode

meta, optional, optionalProperties, parent, toJSON

Method Detail

displayName

String displayName()

The displayName attribute specifies the resource 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).

name

String name()

Name of the resource type

usage

String usage()

Instructions on how and when the resource type should be used.

parametrizedProperties

TypeInstance parametrizedProperties()

Returns object representation of parametrized properties of the resource type