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

Interface BodyLike

All Superinterfaces:

RAMLLanguageElement

All Known Subinterfaces:

JSONBody, XMLBody

public interface BodyLike
extends RAMLLanguageElement

Method Summary

Modifier and Type	Method and Description
ExampleString	example() Documentation generators MUST use body properties' example attributes to generate example invocations.
List<Parameter>	formParameters() Web forms REQUIRE special encoding and custom declaration.
String	name() Mime type of the request or response body
SchemaString	schema() The structure of a request or response body MAY be further specified by the schema property under the appropriate media type.
String	schemaContent() Returns schema content for the cases when schema is inlined, when schema is included, and when schema is a reference.

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

description

Method Detail

name

String name()

Mime type of the request or response body

schema

SchemaString schema()

The structure of a request or response body MAY be further specified by the schema property under the appropriate media type. The schema key CANNOT be specified if a body's media type is application/x-www-form-urlencoded or multipart/form-data. All parsers of RAML MUST be able to interpret JSON Schema and XML Schema. Schema MAY be declared inline or in an external file. However, if the schema is sufficiently large so as to make it difficult for a person to read the API definition, or the schema is reused across multiple APIs or across multiple miles in the same API, the !include user-defined data type SHOULD be used instead of including the content inline. Alternatively, the value of the schema field MAY be the name of a schema specified in the root-level schemas property, or it MAY be declared in an external file and included by using the by using the RAML !include user-defined data type.

example

ExampleString example()

Documentation generators MUST use body properties' example attributes to generate example invocations.

formParameters

List<Parameter> formParameters()

Web forms REQUIRE special encoding and custom declaration. If the API's media type is either application/x-www-form-urlencoded or multipart/form-data, the formParameters property MUST specify the name-value pairs that the API is expecting. The formParameters property is a map in which the key is the name of the web form parameter, and the value is itself a map the specifies the web form parameter's attributes.

schemaContent

String schemaContent()

Returns schema content for the cases when schema is inlined, when schema is included, and when schema is a reference.