org.raml.v2.api.model.v08.methods

Interface MethodBase

All Superinterfaces:

RAMLLanguageElement

All Known Subinterfaces:

Method, SecuritySchemePart, Trait

public interface MethodBase
extends RAMLLanguageElement

Method Summary

Modifier and Type	Method and Description
List<Parameter>	baseUriParameters() A resource or a method can override a base URI template's values.
List<BodyLike>	body() Some method verbs expect the resource to be sent as a request body.
List<Parameter>	headers() Headers that allowed at this position
List<String>	protocols() A method can override an API's protocols value for that single method by setting a different value for the fields.
List<Parameter>	queryParameters() An APIs resources MAY be filtered (to return a subset of results) or altered (such as transforming a response body from JSON to XML format) by the use of query strings.
List<Response>	responses() Resource methods MAY have one or more responses.
List<SecuritySchemeRef>	securedBy() A list of the security schemas to apply, these must be defined in the securitySchemes declaration.

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

description

Method Detail

responses

List<Response> responses()

Resource methods MAY have one or more responses. Responses MAY be described using the description property, and MAY include example attributes or schema properties.

body

List<BodyLike> 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 an API's protocols value for that single method by setting a different value for the fields.

securedBy

List<SecuritySchemeRef> securedBy()

A list of the security schemas to apply, these must be defined in the securitySchemes declaration. To indicate that the method may be called without applying any securityScheme, the method may be annotated with the null securityScheme. Security schemas may also be applied to a resource with securedBy, which is equivalent to applying the security schemas to all methods that may be declared, explicitly or implicitly, by defining the resourceTypes or traits property for that 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.

queryParameters

List<Parameter> queryParameters()

An APIs resources MAY be filtered (to return a subset of results) or altered (such as transforming a response body from JSON to XML format) by the use of query strings. If the resource or its method supports a query string, the query string MUST be defined by the queryParameters property

headers

List<Parameter> headers()

Headers that allowed at this position