org.raml.v2.api.model.v08.resources

Interface ResourceType

All Superinterfaces:

RAMLLanguageElement

public interface ResourceType
extends RAMLLanguageElement

Method Summary

Methods

Modifier and Type	Method and Description
List<Parameter>	baseUriParameters() A resource or a method can override a base URI template's values.
String	displayName() An alternate, human-friendly name for the resource type
List<TraitRef>	is() Instantiation of applyed traits
List<Method>	methods() Methods that are part of this resource type definition
String	name() Name of the resource type
TypeInstance	parametrizedProperties() Returns object representation of parametrized properties of the resource type
List<SecuritySchemeRef>	securedBy() securityScheme may also be applied to a resource by using the securedBy key, which is equivalent to applying the securityScheme to all methods that may be declared, explicitly or implicitly, by defining the resourceTypes or traits property for that resource.
ResourceTypeRef	type() Instantiation of applyed resource type
List<Parameter>	uriParameters() Uri parameters of this resource
String	usage() Instructions on how and when the resource type should be used.

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

description

Method Detail

name

String name()

Name of the resource type

usage

String usage()

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

methods

List<Method> methods()

Methods that are part of this resource type definition

is

List<TraitRef> is()

Instantiation of applyed traits

type

ResourceTypeRef type()

Instantiation of applyed resource type

securedBy

List<SecuritySchemeRef> securedBy()

securityScheme may also be applied to a resource by using the securedBy key, which is equivalent to applying the securityScheme to all methods that may be declared, explicitly or implicitly, by defining the resourceTypes or traits property for that resource. To indicate that the method may be called without applying any securityScheme, the method may be annotated with the null securityScheme.

uriParameters

List<Parameter> uriParameters()

Uri parameters of this resource

displayName

String displayName()

An alternate, human-friendly name for the resource type

baseUriParameters

List<Parameter> baseUriParameters()

A resource or a method can override a base URI template's values. This is useful to restrict or change the default or parameter selection in the base URI. The baseUriParameters property MAY be used to override any or all parameters defined at the root level baseUriParameters property, as well as base URI parameters not specified at the root level.

parametrizedProperties

TypeInstance parametrizedProperties()

Returns object representation of parametrized properties of the resource type