Skip to content

Commit

Permalink
[WSO2-Release] [Release 2.0.1] update documentation for release 2.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@wso2-jenkins-bot
wso2-jenkins-bot committed May 27, 2019
1 parent 837431e commit f5a2716
Show file tree
Hide file tree
Showing 5 changed files with 703 additions and 29 deletions.
28 changes: 14 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Find some useful links below:

## Latest API Docs

Latest API Docs is <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0">2.0.0</a>.
Latest API Docs is <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1">2.0.1</a>.

## How to use

Expand Down Expand Up @@ -47,19 +47,19 @@ directory.

## Features

* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#getbool-function">getBool</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns a 'boolean' value, either 'true' or 'false', based on the valuespecified against the JSON element present in the given path.In case there is no valid boolean value found in the given path, the method still returns 'false'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#getdouble-function">getDouble</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the double value of the JSON element present in the given path. If there is no valid double value in the given path, the method returns 'null'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#getfloat-function">getFloat</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the float value of the JSON element present in the given path.If there is no valid float value in the given path, the method returns 'null'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#getint-function">getInt</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the integer value of the JSON element present in the given path. If there is no valid integer value in the given path, the method returns 'null'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#getlong-function">getLong</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the long value of the JSON element present in the given path. Ifthere is no valid long value in the given path, the method returns 'null'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#getobject-function">getObject</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the object of the JSON element present in the given path.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#getstring-function">getString</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the string value of the JSON element present in the given path.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#isexists-function">isExists</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method checks whether there is a JSON element present in the given path or not.If there is a valid JSON element in the given path, it returns 'true'. If there is no valid JSON element, it returns 'false'</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#setelement-function">setElement</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method allows to insert elements into a given JSON present in a specific path. If there is no valid path given, it returns the original JSON. Otherwise, it returns the new JSON.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#toobject-function">toObject</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the JSON object related to a given JSON string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#tostring-function">toString</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the JSON string corresponding to a given JSON object.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#tokenize-stream-processor">tokenize</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#stream-processor">(Stream Processor)</a>*<br><div style="padding-left: 1em;"><p>This tokenizes the given json according the path provided</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.0/#tokenizeasobject-stream-processor">tokenizeAsObject</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#stream-processor">(Stream Processor)</a>*<br><div style="padding-left: 1em;"><p>This tokenizes the given JSON based on the path provided and returns the response as an object.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#getbool-function">getBool</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns a 'boolean' value, either 'true' or 'false', based on the valuespecified against the JSON element present in the given path.In case there is no valid boolean value found in the given path, the method still returns 'false'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#getdouble-function">getDouble</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the double value of the JSON element present in the given path. If there is no valid double value in the given path, the method returns 'null'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#getfloat-function">getFloat</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the float value of the JSON element present in the given path.If there is no valid float value in the given path, the method returns 'null'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#getint-function">getInt</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the integer value of the JSON element present in the given path. If there is no valid integer value in the given path, the method returns 'null'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#getlong-function">getLong</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the long value of the JSON element present in the given path. Ifthere is no valid long value in the given path, the method returns 'null'.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#getobject-function">getObject</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the object of the JSON element present in the given path.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#getstring-function">getString</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the string value of the JSON element present in the given path.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#isexists-function">isExists</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method checks whether there is a JSON element present in the given path or not.If there is a valid JSON element in the given path, it returns 'true'. If there is no valid JSON element, it returns 'false'</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#setelement-function">setElement</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method allows to insert elements into a given JSON present in a specific path. If there is no valid path given, it returns the original JSON. Otherwise, it returns the new JSON.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#toobject-function">toObject</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the JSON object related to a given JSON string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#tostring-function">toString</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This method returns the JSON string corresponding to a given JSON object.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#tokenize-stream-processor">tokenize</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#stream-processor">(Stream Processor)</a>*<br><div style="padding-left: 1em;"><p>This tokenizes the given json according the path provided</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-json/api/2.0.1/#tokenizeasobject-stream-processor">tokenizeAsObject</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#stream-processor">(Stream Processor)</a>*<br><div style="padding-left: 1em;"><p>This tokenizes the given JSON based on the path provided and returns the response as an object.</p></div>

## How to Contribute

Expand Down
Loading

0 comments on commit f5a2716

Please sign in to comment.