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

Interface Operation

All Superinterfaces:

Annotable

All Known Subinterfaces:

Method, MethodBase, SecuritySchemePart, Trait

public interface Operation
extends Annotable

Method Summary

Methods

Modifier and Type	Method and Description
List<TypeDeclaration>	headers() Headers that allowed at this position
List<TypeDeclaration>	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.
TypeDeclaration	queryString() Specifies the query string needed by this method.
List<Response>	responses() Information about the expected responses to a request

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

annotations

Method Detail

queryParameters

List<TypeDeclaration> 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<TypeDeclaration> headers()

Headers that allowed at this position

queryString

TypeDeclaration queryString()

Specifies the query string needed by this method. Mutually exclusive with queryParameters.

responses

List<Response> responses()

Information about the expected responses to a request