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

Commit

Permalink
Docs: Updated documentation for the element
Browse files Browse the repository at this point in the history
  • Loading branch information
jarrodek committed Mar 30, 2017
1 parent ae7f8fc commit 344af3c
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions raml-json-enhance.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<raml-docs-method-viewer>` 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
Expand Down

0 comments on commit 344af3c

Please sign in to comment.