Skip to content

Commit

Permalink
[WSO2-Release] [Release 2.0.5] update documentation for release 2.0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@wso2-jenkins-bot
wso2-jenkins-bot committed Dec 13, 2019
1 parent 80d7eff commit a715cb3
Show file tree
Hide file tree
Showing 5 changed files with 1,038 additions and 34 deletions.
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,25 @@ For information on <a target="_blank" href="https://siddhi.io/">Siddhi</a> and i

## Latest API Docs

Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4">2.0.4</a>.
Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5">2.0.5</a>.

## Features

* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#group-aggregate-function">group</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#aggregate-function">Aggregate Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function aggregates the JSON elements and returns a JSON object by adding enclosing.element if it is provided. If enclosing.element is not provided it aggregate the JSON elements returns a JSON array.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#groupasobject-aggregate-function">groupAsObject</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#aggregate-function">Aggregate Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function aggregates the JSON elements and returns a JSON object by adding enclosing.element if it is provided. If enclosing.element is not provided it aggregate the JSON elements returns a JSON array.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#getbool-function">getBool</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'boolean' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#getdouble-function">getDouble</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'double' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#getfloat-function">getFloat</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'float' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#getint-function">getInt</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'int' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#getlong-function">getLong</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'long' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#getobject-function">getObject</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the object specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#getstring-function">getString</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves value specified in the given path of the JSON element as a string.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#isexists-function">isExists</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function checks whether there is a JSON element present in the given path or not.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#setelement-function">setElement</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function sets JSON element into a given JSON at the specific path.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#toobject-function">toObject</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function generate JSON object from the given JSON string.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#tostring-function">toString</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function generates a JSON string corresponding to a given JSON object.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#tokenize-stream-processor">tokenize</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-processor">Stream Processor</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Stream processor tokenizes the given JSON into to multiple JSON string elements and sends them as separate events.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.4/#tokenizeasobject-stream-processor">tokenizeAsObject</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-processor">Stream Processor</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Stream processor tokenizes the given JSON into to multiple JSON object elements and sends them as separate events.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#group-aggregate-function">group</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#aggregate-function">Aggregate Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function aggregates the JSON elements and returns a JSON object by adding enclosing.element if it is provided. If enclosing.element is not provided it aggregate the JSON elements returns a JSON array.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#groupasobject-aggregate-function">groupAsObject</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#aggregate-function">Aggregate Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function aggregates the JSON elements and returns a JSON object by adding enclosing.element if it is provided. If enclosing.element is not provided it aggregate the JSON elements returns a JSON array.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#getbool-function">getBool</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'boolean' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#getdouble-function">getDouble</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'double' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#getfloat-function">getFloat</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'float' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#getint-function">getInt</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'int' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#getlong-function">getLong</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the 'long' value specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#getobject-function">getObject</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves the object specified in the given path of the JSON element.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#getstring-function">getString</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function retrieves value specified in the given path of the JSON element as a string.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#isexists-function">isExists</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function checks whether there is a JSON element present in the given path or not.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#setelement-function">setElement</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function sets JSON element into a given JSON at the specific path.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#toobject-function">toObject</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function generate JSON object from the given JSON string.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#tostring-function">toString</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Function generates a JSON string corresponding to a given JSON object.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#tokenize-stream-processor">tokenize</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-processor">Stream Processor</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Stream processor tokenizes the given JSON into to multiple JSON string elements and sends them as separate events.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-json/api/2.0.5/#tokenizeasobject-stream-processor">tokenizeAsObject</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-processor">Stream Processor</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Stream processor tokenizes the given JSON into to multiple JSON object elements and sends them as separate events.</p></p></div>

## Dependencies

Expand Down
Loading

0 comments on commit a715cb3

Please sign in to comment.