org.raml.v2.api.model.v10.resources

Interface ResourceBase

All Superinterfaces:

Annotable

All Known Subinterfaces:

Resource

public interface ResourceBase
extends Annotable

Method Summary

Modifier and Type	Method and Description
MarkdownString	description()
List<TraitRef>	is() A list of the traits to apply to all methods declared (implicitly or explicitly) for this resource.
List<Method>	methods() Methods that are part of this resource type definition
List<SecuritySchemeRef>	securedBy() The security schemes that apply to all methods declared (implicitly or explicitly) for this resource.
ResourceTypeRef	type() The resource type which this resource inherits.
List<TypeDeclaration>	uriParameters() Detailed information about any URI parameters of this resource

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

annotations

Method Detail

methods

List<Method> methods()

Methods that are part of this resource type definition

is

List<TraitRef> is()

A list of the traits to apply to all methods declared (implicitly or explicitly) for this resource. Individual methods may override this declaration

type

ResourceTypeRef type()

The resource type which this resource inherits.

description

MarkdownString description()

securedBy

List<SecuritySchemeRef> securedBy()

The security schemes that apply to all methods declared (implicitly or explicitly) for this resource.

uriParameters

List<TypeDeclaration> uriParameters()

Detailed information about any URI parameters of this resource