org.raml.v2.api.model.v08.common

Interface RAMLLanguageElement

All Known Subinterfaces:

Api, BasicSecurityScheme, BodyLike, BooleanTypeDeclaration, CustomSecurityScheme, DateTypeDeclaration, DigestSecurityScheme, FileTypeDeclaration, IntegerTypeDeclaration, JSONBody, Method, MethodBase, NumberTypeDeclaration, OAuth1SecurityScheme, OAuth2SecurityScheme, Parameter, Resource, ResourceType, Response, SecurityScheme, SecuritySchemePart, StringTypeDeclaration, Trait, XMLBody

public interface RAMLLanguageElement

Method Summary

Modifier and Type	Method and Description
MarkdownString	description() The description attribute describes the intended use or meaning of the $self.

Method Detail

description

MarkdownString description()

The description attribute describes the intended use or meaning of the $self. This value MAY be formatted using Markdown.