Skip to content

Commit

Permalink
[WSO2-Release] [Release 2.1.1] update documentation for release 2.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
wso2-jenkins-bot committed Feb 15, 2022
1 parent f6c1db8 commit 4718bf6
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -19,12 +19,12 @@ 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-map-binary/api/2.1.0">2.1.0</a>.
Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.1">2.1.1</a>.

## Features

* <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.0/#binary-sink-mapper">binary</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#sink-mapper">Sink Mapper</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This section explains how to map events processed via Siddhi in order to publish them in the <code>binary</code> format.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.0/#binary-source-mapper">binary</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#source-mapper">Source Mapper</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This extension is a binary input mapper that converts events received in <code>binary</code> format to Siddhi events before they are processed.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.1/#binary-sink-mapper">binary</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#sink-mapper">Sink Mapper</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This section explains how to map events processed via Siddhi in order to publish them in the <code>binary</code> format.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.1/#binary-source-mapper">binary</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#source-mapper">Source Mapper</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This extension is a binary input mapper that converts events received in <code>binary</code> format to Siddhi events before they are processed.</p></p></div>

## Dependencies

Expand Down
45 changes: 45 additions & 0 deletions docs/api/2.1.1.md
@@ -0,0 +1,45 @@
# API Docs - v2.1.1

!!! Info "Tested Siddhi Core version: *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/">5.1.21</a>*"
It could also support other Siddhi Core minor versions.

## Sinkmapper

### binary *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#sink-mapper">(Sink Mapper)</a>*
<p></p>
<p style="word-wrap: break-word;margin: 0;">This section explains how to map events processed via Siddhi in order to publish them in the <code>binary</code> format.</p>
<p></p>
<span id="syntax" class="md-typeset" style="display: block; font-weight: bold;">Syntax</span>

```
@sink(..., @map(type="binary")
```

<span id="examples" class="md-typeset" style="display: block; font-weight: bold;">Examples</span>
<span id="example-1" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 1</span>
```
@sink(type='inMemory', topic='WSO2', @map(type='binary')) define stream FooStream (symbol string, price float, volume long);
```
<p></p>
<p style="word-wrap: break-word;margin: 0;">This will publish Siddhi event in binary format.</p>
<p></p>
## Sourcemapper

### binary *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#source-mapper">(Source Mapper)</a>*
<p></p>
<p style="word-wrap: break-word;margin: 0;">This extension is a binary input mapper that converts events received in <code>binary</code> format to Siddhi events before they are processed.</p>
<p></p>
<span id="syntax" class="md-typeset" style="display: block; font-weight: bold;">Syntax</span>

```
@source(..., @map(type="binary")
```

<span id="examples" class="md-typeset" style="display: block; font-weight: bold;">Examples</span>
<span id="example-1" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 1</span>
```
@source(type='inMemory', topic='WSO2', @map(type='binary'))define stream FooStream (symbol string, price float, volume long);
```
<p></p>
<p style="word-wrap: break-word;margin: 0;">This query performs a mapping to convert an event of the <code>binary</code> format to a Siddhi event. </p>
<p></p>
4 changes: 2 additions & 2 deletions docs/api/latest.md
@@ -1,6 +1,6 @@
# API Docs - v2.1.0
# API Docs - v2.1.1

!!! Info "Tested Siddhi Core version: *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/">5.1.14</a>*"
!!! Info "Tested Siddhi Core version: *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/">5.1.21</a>*"
It could also support other Siddhi Core minor versions.

## Sinkmapper
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Expand Up @@ -19,12 +19,12 @@ 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-map-binary/api/2.1.0">2.1.0</a>.
Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.1">2.1.1</a>.

## Features

* <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.0/#binary-sink-mapper">binary</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#sink-mapper">Sink Mapper</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This section explains how to map events processed via Siddhi in order to publish them in the <code>binary</code> format.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.0/#binary-source-mapper">binary</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#source-mapper">Source Mapper</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This extension is a binary input mapper that converts events received in <code>binary</code> format to Siddhi events before they are processed.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.1/#binary-sink-mapper">binary</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#sink-mapper">Sink Mapper</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This section explains how to map events processed via Siddhi in order to publish them in the <code>binary</code> format.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-map-binary/api/2.1.1/#binary-source-mapper">binary</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#source-mapper">Source Mapper</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This extension is a binary input mapper that converts events received in <code>binary</code> format to Siddhi events before they are processed.</p></p></div>

## Dependencies

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Expand Up @@ -34,6 +34,7 @@ pages:
- Information: index.md
- API Docs:
- latest: api/latest.md
- 2.1.1: api/2.1.1.md
- 2.1.0: api/2.1.0.md
- 2.0.5: api/2.0.5.md
- 2.0.4: api/2.0.4.md
Expand Down

0 comments on commit 4718bf6

Please sign in to comment.