SPEC_SUPPORT.md

Raml 1.0 (rc2) Specification support

✅ The feature should work as expected

⚠️ The feature is not completed yet (see comments)

❌ The feature is not currently supported (PRs are welcome!)

• Raml Root

Property	Status	Comments
description	✅
(annotationName)?	❌
schemas?	⚠️	Basic support. See Types support
types?	⚠️	Basic support. See Types support
traits?	✅ ⚠️	Definition and merging support. Not fully tested though
resourceTypes?	✅ ⚠️	Definition and merging support. Not fully tested though
annotationTypes?	❌
securitySchemes?	✅ ⚠️	Definition and merging support. Not fully tested though
uses?	❌
title	✅
version	✅
baseUri?	✅
baseUriParameters?	✅
protocols?	✅
mediaType?	✅
securedBy?	⚠️	Definition and merging support. Not fully tested though
/resources?	✅

• Raml Data Types

Property	Status	Comments
schema?	✅ ⚠️	Show deprecation notice when using RAML 1.0
type?	✅ ⚠️	Some inheritance and merging strategies might not work
example?	✅ ⚠️	Should complain if both example and examples are present
examples?	✅ ⚠️	Should complain if both example and examples are present
displayName?	✅
description?	✅
()?	❌

• Object Data Types

Property	Status	Comments
properties?	✅ ⚠️	Some property limitations. See properties
minProperties?	⚠️	Not fully tested. Need examples
maxProperties?	⚠️	Not fully tested. Need examples
additionalProperties?	⚠️	Declaration works. Not fully tested
patternProperties?	⚠️	Declaration works. Not fully tested
discriminator?	❌

Extra Feature	Status
Alternative Syntax	✅
Inheritance	⚠️ See inheritance
Map types	❌

• Array Types

TBC

• Base URI and Base URI Parameters

✅ Parsing Base Uri and Base parameters as collection should works as expected

⚠️ Template validation.

⚠️ These two properties should be mutually exclusive.

• Protocols

✅ Parsing protocols strings should work as expected

⚠️ Any protocol is currently accepted as long as they are strings.

• Default Media Type

✅ Parsing Media type and using it as default body key

⚠️ Media type validation

• Default Security

❌ Although parsing security schemes is supported, applying their properties to the resources and methods is not yet implemented

• Resources and Nested Resources

Property	Status	Comments
displayName	✅
description	✅
(annotationName)?	❌
get?	✅
patch?	✅
put?	✅
post?	✅
delete?	✅
options?	✅
head?	✅
is?	✅
type?	✅
securedBy?	⚠️	Merging of security scheme properties is not yet implemented
uriParameters?	✅
/relativeUri as resource	✅

• Template URIs and URI Parameters

⚠️ Parsing Uri Strings and Uri parameters as collection should works as expected

⚠️ Template validation.

⚠️ These two properties should be mutually exclusive.

• Methods

Property	Status	Comments
displayName	✅
description	✅
(annotationName)?	❌
queryParameters?	✅
headers?	✅
queryString?	✅
responses?	✅
body?	⚠️	Same Type limitations
protocols?	⚠️	Protocols limitations
is?	✅
securedBy?	⚠️	Merging of security scheme properties is not yet implemented

• Headers

✅ Parsing Headers as a properties declaration should work as expected

⚠️ Needs more testing, specially using headers of array type

• Query Strings and Query Parameters

✅ Parsing Query Strings and Query parameters as collection should works as expected

⚠️ Template validation.

⚠️ These two properties should be mutually exclusive.

• Bodies

✅ Body declarations using both strings (and therefore, default media type) and objects

⚠️ Same limitations as Raml Types

• Responses

✅ Responses should work as expected

• Resource Types and Traits

Feature	status	comments
Query Parameters, Responses, and Headers collection mergin	✅
usage description	✅
Optional properties (/^?/)	✅ ⚠️	Needs testing and real examples
Algorithm of Merging Traits With Methods	✅ ⚠️	Needs testing and real examples
Parameters (both custom and reserved parameters)	✅
Modifier functions	✅

• Security Schemes

Type	Status	Comments
OAuth 1.0	✅
OAuth 2.0	✅
Basic Authentication	✅
Digest Authentication	✅
Pass Through	✅
x-{other}	✅
null	✅

⚠️ Merging security schemes is not yet implemented. ⚠️

• Annotations

❌ Not even started yet ❌

• Modularization

Type	Status	Comments
!include <absolute or relative url> as Type Fragments	✅
!include <absolute or relative url>#<reference> as References to inner elements	❌

• Libraries

❌ Not even started yet ❌

• Overlays and Extensions

❌ Not even started yet ❌