org.raml.v2.api.model.v08.bodies

Interface Response

All Superinterfaces:

RAMLLanguageElement

public interface Response
extends RAMLLanguageElement

Method Summary

Methods

Modifier and Type	Method and Description
List<BodyLike>	body() Each response MAY contain a body property, which conforms to the same structure as request body properties (see Body).
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.
List<Parameter>	headers() An API's methods may support custom header values in responses.

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

description

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<Parameter> headers()

An API's methods may support custom header values in responses. The custom, non-standard HTTP headers MUST be specified by the headers property. API's may include the the placeholder token {?} in a header name to indicate that any number of headers that conform to the specified format can be sent in responses. This is particularly useful for APIs that allow HTTP headers that conform to some naming convention to send arbitrary, custom data.

body

List<BodyLike> body()

Each response MAY contain a body property, which conforms to the same structure as request body properties (see Body). Responses that can return more than one response code MAY therefore have multiple bodies defined. For APIs without a priori knowledge of the response types for their responses, `*/*` MAY be used to indicate that responses that do not matching other defined data types MUST be accepted. Processing applications MUST match the most descriptive media type first if `*/*` is used.