Contact Free trial Login

Modify Published RAML API Specifications to Conform Completely to RAML 0.8 or 1.0

As of January 10, 2019, the code editor (one of the two editors in Design Center’s API Designer) uses stricter validation by default for RAML API-specification projects that were create before this date. Therefore, it is possible that API specifications in projects created before this date include invalid RAML that earlier versions of the code editor did not flag.

Check your published APIs by opening them in the code editor in Design Center and enabling stricter validation in the top-right corner of the editor. (The toggle switch appears only for projects created before January 10, 2019.) You can use this guide to correct a number of common RAML problems that were validated by the code editor in the past but that are now generating messages. If you see problems that this guide does not include, refer to the specifications for RAML 0.8 and 1.0, which you can read on raml.org.

In addition to checking more precisely for RAML problems, the code editor also validates regular expressions. Any invalid expressions in published API specifications that you reopen in the editor are now flagged as errors.

You have a long grace period — at least until January 10, 2020 — to correct any invalid RAML and invalid regular expressions that your published API specifications might include. After the grace period expires, you will be unable to republish and redeploy API specifications in which such problems still exist.

You do not need to check any API specifications that were created with the visual editor, the tool in API Designer with which you can create specifications by filling in forms.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub