From 344af3c38b0edf8f0d5b1bc140470bbf412eb34c Mon Sep 17 00:00:00 2001 From: Pawel Psztyc Date: Thu, 30 Mar 2017 19:04:13 +0100 Subject: [PATCH] Docs: Updated documentation for the element --- raml-json-enhance.html | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/raml-json-enhance.html b/raml-json-enhance.html index 17d0500..98442b0 100644 --- a/raml-json-enhance.html +++ b/raml-json-enhance.html @@ -31,6 +31,18 @@ }); ``` +**Note** This element MUST be used to enhance parser JSON output in order to use +any RAML related ARC element. Enhancer creates common data structure and +expands RAML types. Element expects the JSON object to contain complete data +about method / endpoint / type / security scheme and so on. It will not look for +the data in the root of raml definition. Thanks to this, you can push just a part +of the JSON object to a specific element to make it work. + +For example the `` viewer ecpects the `raml` propety to +be a method definition only (without of the rest of the RAML structure). If +enhanced with the library, the JSON object describing the method will contain +all required information to render the view. + @group Logic Elements @element raml-json-enhance @demo demo/index.html