Skip to content
This repository has been archived by the owner on Feb 17, 2024. It is now read-only.

Breaking Changes

Christian Vogel edited this page Apr 30, 2016 · 7 revisions

These changes list where implementation differs between versions as the spec is simplified and inconsistencies are corrected.

RAML 1.0

Defining form parameters has been removed in favour for RAML types

In RAML 0.8, you could define either schemas or form parameters for either a request or response body. Since RAML 1.0 introduces RAML types and therefore unifies the definition of the body structure to be YAML, JSON, or XML in general, there was no need for a special node anymore. To migrate existing RAML 0.8 definitions that uses form parameters to 1.0, you only need to replace formParameters with properties.

Example

RAML 0.8:

body:
  application/x-www-form-urlencoded:
    formParameters:
      name:
        description: name on account
        type: string
        example: Naruto Uzumaki
      gender:
        enum: ["male", "female"]

RAML 1.0

body:
  application/x-www-form-urlencoded:
    properties:
      name:
        description: name on account
        type: string
        example: Naruto Uzumaki
      gender:
        enum: ["male", "female"]
Clone this wiki locally