org.raml.v2.api.model.v10.bodies

Interface Response

All Superinterfaces:

Annotable

public interface Response
extends Annotable

Method Summary

Methods

Modifier and Type	Method and Description
List<TypeDeclaration>	body() The body of the response: a body declaration
StatusCodeString	code() Responses MUST be a map of one or more HTTP status codes, where each status code itself is a map that describes that status code.
MarkdownString	description() A longer, human-friendly description of the response
List<TypeDeclaration>	headers() Detailed information about any response headers returned by this method

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

annotations

Method Detail

code

StatusCodeString code()

Responses MUST be a map of one or more HTTP status codes, where each status code itself is a map that describes that status code.

headers

List<TypeDeclaration> headers()

Detailed information about any response headers returned by this method

body

List<TypeDeclaration> body()

The body of the response: a body declaration

description

MarkdownString description()

A longer, human-friendly description of the response