diff --git a/SPEC_SUPPORT.md b/SPEC_SUPPORT.md index 767a830..a2cd664 100644 --- a/SPEC_SUPPORT.md +++ b/SPEC_SUPPORT.md @@ -1,4 +1,4 @@ -# Raml 1.0 (rc2) Specification support +# RAML 1.0 Specification support :white_check_mark: The feature should work as expected @@ -7,7 +7,7 @@ :x: The feature is not currently supported (PRs are welcome!) -- [Raml Root](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#the-root-of-the-document) +- [RAML Root](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#the-root-of-the-document) Property | Status | Comments ---|---|--- @@ -22,14 +22,14 @@ securitySchemes? | :white_check_mark: :warning: | Definition and merging support uses? | :x: | title | :white_check_mark: | version | :white_check_mark: | -baseUri? | :white_check_mark: | -baseUriParameters? | :white_check_mark: | -protocols? | :white_check_mark: | -mediaType? | :white_check_mark: | +baseUri? | :white_check_mark: | +baseUriParameters? | :white_check_mark: | +protocols? | :white_check_mark: | +mediaType? | :white_check_mark: | securedBy? | :warning: | Definition and merging support. Not fully tested though /resources? | :white_check_mark: | -* [Raml Data Types](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#raml-data-types) +* [RAML Data Types](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#raml-data-types) Property | Status | Comments ---|---|--- @@ -40,8 +40,16 @@ examples? | :white_check_mark: :warning: | Should complain if both example and e displayName? | :white_check_mark: | description? | :white_check_mark: | ()? | :x: | +default? | :x: | +facets? | :x: | +xml? | :x: | [XML Serialization of Type Instances](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#xml-serialization-of-type-instances) +enum? | :x: | - * [Object Data Types](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#object-types) +Extra Feature | Status +---|-- +[The "Any" Type](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#the-any-type) | :x: + + * [Object Data Types](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#object-type) Property | Status | Comments @@ -50,20 +58,45 @@ description? | :white_check_mark: | minProperties? | :warning: | Not fully tested. Need examples maxProperties? | :warning: | Not fully tested. Need examples additionalProperties? | :warning: | Declaration works. Not fully tested - patternProperties? | :warning: | Declaration works. Not fully tested - discriminator? | :x: | + patternProperties? | :warning: | Declaration works. Not fully tested. **Concept is reworked in RAML 1.0** + discriminator? | :x: | + discriminatorValue? | :x: | Extra Feature | Status ---|-- - [Alternative Syntax](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#alternative-syntax) | :white_check_mark: - [Inheritance](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#inheritance) | :warning: See inheritance - [Map types](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#map-types) | :x: + [Property declaration shortcut](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#property-declarations) | :white_check_mark: + [Inheritance](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#object-type-specialization) | :warning: See inheritance + + * [Array Types](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#array-type) + + * [Date Types](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#date) :x: There's no type `date` now (see below). + + Property | Status | Comments + ---|---|--- + date-only | :x: | + time-only | :x: | + time-only | :x: | + datetime | :x: | + + * [Nil Type](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#nil-type) :x: + + * [Type Expressions](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#type-expressions) + + Property | Status | Comments + ---|---|--- + `number{}` | :warning: | Support is dropped in RAML 1.0 + + * [Determine Default Type](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#determine-default-types) :warning: Not sure if this is implemented - * [Array Types](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#array-types) + * [Examples Facets](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#as-a-map-that-contains-additional-facets) + + Property | Status | Comments + ---|---|--- + value | :warning: | Implemented? Previously called `content` _TBC_ -* [Base URI and Base URI Parameters](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#base-uri-and-base-uri-parameters) +* [Base URI and Base URI Parameters](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#base-uri-and-base-uri-parameters) :white_check_mark: Parsing Base Uri and Base parameters as collection should works as expected @@ -72,24 +105,26 @@ _TBC_ :warning: These two properties should be mutually exclusive. -* [Protocols](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#protocols) +* [Protocols](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#protocols) :white_check_mark: Parsing protocols strings should work as expected :warning: Any protocol is currently accepted as long as they are strings. -* [Default Media Type](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#default-media-type) +* [Default Media Types](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#default-media-types) :white_check_mark: Parsing Media type and using it as default body key :warning: Media type validation -* [Default Security](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#default-security) +:x: Multiple strings array as media type value + +* [Default Security](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#default-security) :x: Although parsing security schemes is supported, applying their properties to the resources and methods is not yet implemented -* [Resources and Nested Resources](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#resources-and-nested-resources) +* [Resources and Nested Resources](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#resources-and-nested-resources) Property | Status | Comments @@ -111,7 +146,7 @@ uriParameters? | :white_check_mark: | /relativeUri as resource | :white_check_mark: | -* [Template URIs and URI Parameters](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#template-uris-and-uri-parameters) +* [Template URIs and URI Parameters](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#template-uris-and-uri-parameters) :warning: Parsing Uri Strings and Uri parameters as collection should works as expected @@ -119,7 +154,7 @@ uriParameters? | :white_check_mark: | :warning: These two properties should be mutually exclusive. -* [Methods](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#methods) +* [Methods](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#methods) Property | Status | Comments @@ -136,14 +171,14 @@ protocols? | :warning: | Protocols limitations is? | :white_check_mark: | securedBy? | :warning: | Merging of security scheme properties is not yet implemented -* [Headers](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#headers) +* [Headers](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#headers) :white_check_mark: Parsing Headers as a properties declaration should work as expected :warning: Needs more testing, specially using headers of array type -* [Query Strings and Query Parameters](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#query-strings-and-query-parameters) +* [Query Strings and Query Parameters](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#query-strings-and-query-parameters) :white_check_mark: Parsing Query Strings and Query parameters as collection should works as expected @@ -152,22 +187,22 @@ securedBy? | :warning: | Merging of security scheme properties is not yet implem :warning: These two properties should be mutually exclusive. -* [Bodies](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#bodies) +* [Bodies](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#bodies) :white_check_mark: Body declarations using both strings (and therefore, default media type) and objects -:warning: Same limitations as Raml Types +:warning: Same limitations as RAML Types -* [Responses](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#responses) +* [Responses](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#responses) :white_check_mark: Responses should work as expected -* [Resource Types and Traits](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#resource-types-and-traits) +* [Resource Types and Traits](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#resource-types-and-traits) Feature | status | comments ---|---|--- -Query Parameters, Responses, and Headers collection mergin | :white_check_mark: | +Query Parameters, Responses, and Headers collection merging | :white_check_mark: | usage description | :white_check_mark: | Optional properties (`/^?/`) | :white_check_mark: :warning: | Needs testing and real examples Algorithm of Merging Traits With Methods | :white_check_mark: :warning: | Needs testing and real examples @@ -175,7 +210,7 @@ Parameters (both custom and reserved parameters) | :white_check_mark: | Modifier functions | :white_check_mark: | -* [Security Schemes](https://github.com/raml-org/raml-spec/blob/raml-10-rc2/versions/raml-10/raml-10.md#security-schemes) +* [Security Schemes](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#security-schemes) Type | Status | Comments ---|---|--- @@ -186,28 +221,29 @@ Digest Authentication | :white_check_mark: | Pass Through| :white_check_mark: | x-{other} | :white_check_mark: | null | :white_check_mark: | - +displayName | :warning: | Implemented? +describedBy.displayName | :warning: | Support dropped in RAML 1.0 +describedBy.description | :warning: | Support dropped in RAML 1.0 +settings.signatures | :x: | :warning: Merging security schemes is not yet implemented. :warning: -* [Annotations](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#annotations) +* [Annotations](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#annotations) :x: Not even started yet :x: -* [Modularization](https://github.com/raml-org/raml-spec/blob/raml-10-rc2/versions/raml-10/raml-10.md#modularization) +* [Modularization](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#modularization) Type | Status | Comments ---|---|--- `!include ` as Type Fragments | :white_check_mark: | -`!include #` as References to inner elements | :x: | - -* [Libraries](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#libraries) +* [Libraries](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#libraries) :x: Not even started yet :x: -* [Overlays and Extensions](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#overlays-and-extensions) +* [Overlays and Extensions](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#overlays-and-extensions) :x: Not even started yet :x: