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

Interface Resource

All Superinterfaces:

Annotable, ResourceBase

public interface Resource
extends ResourceBase

Method Summary

Methods

Modifier and Type	Method and Description
String	displayName() The displayName attribute specifies the resource display name.
Resource	parentResource()
RelativeUriString	relativeUri() Relative URL of this resource from the parent resource
String	resourcePath()
List<Resource>	resources() A nested resource is identified as any property whose name begins with a slash ("/") and is therefore treated as a relative URI.

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

description, is, methods, securedBy, type, uriParameters

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

annotations

Method Detail

relativeUri

RelativeUriString relativeUri()

Relative URL of this resource from the parent resource

displayName

String displayName()

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

resources

List<Resource> resources()

A nested resource is identified as any property whose name begins with a slash ("/") and is therefore treated as a relative URI.

resourcePath

String resourcePath()

parentResource

@Nullable
Resource parentResource()