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

Interface Resource

All Superinterfaces:

RAMLLanguageElement

public interface Resource
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
List<TraitRef>	is() Instantiation of applyed traits
List<Method>	methods() Methods that can be called on this resource
Resource	parentResource()
RelativeUriString	relativeUri() Relative URL of this resource from the parent resource
String	resourcePath()
List<Resource>	resources() Children resources
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

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

description

Method Detail

relativeUri

RelativeUriString relativeUri()

Relative URL of this resource from the parent resource

type

ResourceTypeRef type()

Instantiation of applyed resource type

is

List<TraitRef> is()

Instantiation of applyed traits

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

methods

List<Method> methods()

Methods that can be called on this resource

resources

List<Resource> resources()

Children resources

displayName

String displayName()

An alternate, human-friendly name for the resource

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.

resourcePath

String resourcePath()

parentResource

@Nullable
Resource parentResource()