diff --git a/README.md b/README.md index 18b5cfa..f9045f4 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,12 @@ For information on Siddhi and i ## Latest API Docs -Latest API Docs is 2.1.0. +Latest API Docs is 2.1.1. ## Features -* binary *(Sink Mapper)*

This section explains how to map events processed via Siddhi in order to publish them in the binary format.

-* binary *(Source Mapper)*

This extension is a binary input mapper that converts events received in binary format to Siddhi events before they are processed.

+* binary *(Sink Mapper)*

This section explains how to map events processed via Siddhi in order to publish them in the binary format.

+* binary *(Source Mapper)*

This extension is a binary input mapper that converts events received in binary format to Siddhi events before they are processed.

## Dependencies diff --git a/docs/api/2.1.1.md b/docs/api/2.1.1.md new file mode 100644 index 0000000..5b05101 --- /dev/null +++ b/docs/api/2.1.1.md @@ -0,0 +1,45 @@ +# API Docs - v2.1.1 + +!!! Info "Tested Siddhi Core version: *5.1.21*" + It could also support other Siddhi Core minor versions. + +## Sinkmapper + +### binary *(Sink Mapper)* +

+

This section explains how to map events processed via Siddhi in order to publish them in the binary format.

+

+Syntax + +``` +@sink(..., @map(type="binary") +``` + +Examples +EXAMPLE 1 +``` +@sink(type='inMemory', topic='WSO2', @map(type='binary')) define stream FooStream (symbol string, price float, volume long); +``` +

+

This will publish Siddhi event in binary format.

+

+## Sourcemapper + +### binary *(Source Mapper)* +

+

This extension is a binary input mapper that converts events received in binary format to Siddhi events before they are processed.

+

+Syntax + +``` +@source(..., @map(type="binary") +``` + +Examples +EXAMPLE 1 +``` +@source(type='inMemory', topic='WSO2', @map(type='binary'))define stream FooStream (symbol string, price float, volume long); +``` +

+

This query performs a mapping to convert an event of the binary format to a Siddhi event.

+

diff --git a/docs/api/latest.md b/docs/api/latest.md index f374e73..5b05101 100644 --- a/docs/api/latest.md +++ b/docs/api/latest.md @@ -1,6 +1,6 @@ -# API Docs - v2.1.0 +# API Docs - v2.1.1 -!!! Info "Tested Siddhi Core version: *5.1.14*" +!!! Info "Tested Siddhi Core version: *5.1.21*" It could also support other Siddhi Core minor versions. ## Sinkmapper diff --git a/docs/index.md b/docs/index.md index 18b5cfa..f9045f4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,12 +19,12 @@ For information on Siddhi and i ## Latest API Docs -Latest API Docs is 2.1.0. +Latest API Docs is 2.1.1. ## Features -* binary *(Sink Mapper)*

This section explains how to map events processed via Siddhi in order to publish them in the binary format.

-* binary *(Source Mapper)*

This extension is a binary input mapper that converts events received in binary format to Siddhi events before they are processed.

+* binary *(Sink Mapper)*

This section explains how to map events processed via Siddhi in order to publish them in the binary format.

+* binary *(Source Mapper)*

This extension is a binary input mapper that converts events received in binary format to Siddhi events before they are processed.

## Dependencies diff --git a/mkdocs.yml b/mkdocs.yml index 8e3985e..8611b79 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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