org.raml.v2.api.model.v10.methods

Interface MethodBase

All Superinterfaces:

Annotable, Operation

All Known Subinterfaces:

Method, Trait

public interface MethodBase
extends Operation

Method Summary

Methods

Modifier and Type	Method and Description
List<TypeDeclaration>	body() Some method verbs expect the resource to be sent as a request body.
MarkdownString	description()
String	displayName()
List<TraitRef>	is() Instantiation of applyed traits
List<String>	protocols() A method can override the protocols specified in the resource or at the API root, by employing this property.
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.

Methods inherited from interface org.raml.v2.api.model.v10.methods.Operation

headers, queryParameters, queryString, responses

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

annotations

Method Detail

body

List<TypeDeclaration> body()

Some method verbs expect the resource to be sent as a request body. For example, to create a resource, the request must include the details of the resource to create. Resources CAN have alternate representations. For example, an API might support both JSON and XML representations. A method's body is defined in the body property as a hashmap, in which the key MUST be a valid media type.

protocols

List<String> protocols()

A method can override the protocols specified in the resource or at the API root, by employing this property.

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.

description

MarkdownString description()

displayName

String displayName()