You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2023/06/13 15:13:14 UTC
[streampipes-website] branch master updated (780a18c4 -> da48527d)
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
from 780a18c4 chore(python-docs): update python doc assets to recent development state (#86)
new 2afccbf5 Bump fast-xml-parser and is-svg in /documentation/website (#87)
new da48527d chore(python-docs): update python doc assets to recent development state (#88)
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs-python/dev/assets/_mkdocstrings.css | 58 +++++++++----
docs-python/dev/img/interrogate_badge.svg | 8 +-
docs-python/dev/reference/client/client/index.html | 40 ++++++---
docs-python/dev/reference/client/config/index.html | 16 +++-
.../client/credential_provider/index.html | 32 +++++--
.../endpoint/api/data_lake_measure/index.html | 44 +++++++---
.../dev/reference/endpoint/api/version/index.html | 20 +++--
.../dev/reference/endpoint/endpoint/index.html | 46 +++++++---
.../dev/reference/endpoint/exceptions/index.html | 4 +-
.../function_zoo/river_function/index.html | 96 +++++++++++++++------
.../reference/functions/broker/broker/index.html | 12 ++-
.../functions/broker/broker_handler/index.html | 24 ++++--
.../reference/functions/broker/consumer/index.html | 12 ++-
.../broker/kafka/kafka_consumer/index.html | 8 +-
.../broker/kafka/kafka_message_fetcher/index.html | 8 +-
.../broker/kafka/kafka_publisher/index.html | 12 ++-
.../functions/broker/nats/nats_consumer/index.html | 8 +-
.../broker/nats/nats_publisher/index.html | 12 ++-
.../functions/broker/output_collector/index.html | 20 +++--
.../functions/broker/publisher/index.html | 8 +-
.../functions/function_handler/index.html | 32 +++++--
.../reference/functions/registration/index.html | 16 +++-
.../functions/streampipes_function/index.html | 52 ++++++++---
.../functions/utils/async_iter_handler/index.html | 20 +++--
.../functions/utils/data_stream_context/index.html | 20 +++--
.../utils/data_stream_generator/index.html | 40 ++++++---
.../functions/utils/function_context/index.html | 28 ++++--
docs-python/dev/reference/model/common/index.html | 8 +-
.../model/container/resource_container/index.html | 48 ++++++++---
.../reference/model/container/versions/index.html | 4 +-
.../model/resource/data_lake_measure/index.html | 4 +-
.../model/resource/data_series/index.html | 20 +++--
.../model/resource/data_stream/index.html | 12 ++-
.../model/resource/function_definition/index.html | 40 ++++++---
.../model/resource/query_result/index.html | 12 ++-
.../reference/model/resource/resource/index.html | 12 ++-
.../reference/model/resource/version/index.html | 4 +-
docs-python/dev/scripts/gen_ref_pages/index.html | 12 +--
docs-python/dev/search/search_index.json | 2 +-
docs-python/dev/sitemap.xml | 96 ++++++++++-----------
docs-python/dev/sitemap.xml.gz | Bin 705 -> 705 bytes
documentation/website/package-lock.json | 64 +++++++++-----
42 files changed, 741 insertions(+), 293 deletions(-)
[streampipes-website] 02/02: chore(python-docs): update python doc assets to recent development state (#88)
Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
commit da48527df48716afb5ad4b4852689c25a68316dd
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Tue Jun 13 17:12:07 2023 +0200
chore(python-docs): update python doc assets to recent development state (#88)
Co-authored-by: bossenti <bo...@users.noreply.github.com>
---
docs-python/dev/assets/_mkdocstrings.css | 58 +++++++++----
docs-python/dev/img/interrogate_badge.svg | 8 +-
docs-python/dev/reference/client/client/index.html | 40 ++++++---
docs-python/dev/reference/client/config/index.html | 16 +++-
.../client/credential_provider/index.html | 32 +++++--
.../endpoint/api/data_lake_measure/index.html | 44 +++++++---
.../dev/reference/endpoint/api/version/index.html | 20 +++--
.../dev/reference/endpoint/endpoint/index.html | 46 +++++++---
.../dev/reference/endpoint/exceptions/index.html | 4 +-
.../function_zoo/river_function/index.html | 96 +++++++++++++++------
.../reference/functions/broker/broker/index.html | 12 ++-
.../functions/broker/broker_handler/index.html | 24 ++++--
.../reference/functions/broker/consumer/index.html | 12 ++-
.../broker/kafka/kafka_consumer/index.html | 8 +-
.../broker/kafka/kafka_message_fetcher/index.html | 8 +-
.../broker/kafka/kafka_publisher/index.html | 12 ++-
.../functions/broker/nats/nats_consumer/index.html | 8 +-
.../broker/nats/nats_publisher/index.html | 12 ++-
.../functions/broker/output_collector/index.html | 20 +++--
.../functions/broker/publisher/index.html | 8 +-
.../functions/function_handler/index.html | 32 +++++--
.../reference/functions/registration/index.html | 16 +++-
.../functions/streampipes_function/index.html | 52 ++++++++---
.../functions/utils/async_iter_handler/index.html | 20 +++--
.../functions/utils/data_stream_context/index.html | 20 +++--
.../utils/data_stream_generator/index.html | 40 ++++++---
.../functions/utils/function_context/index.html | 28 ++++--
docs-python/dev/reference/model/common/index.html | 8 +-
.../model/container/resource_container/index.html | 48 ++++++++---
.../reference/model/container/versions/index.html | 4 +-
.../model/resource/data_lake_measure/index.html | 4 +-
.../model/resource/data_series/index.html | 20 +++--
.../model/resource/data_stream/index.html | 12 ++-
.../model/resource/function_definition/index.html | 40 ++++++---
.../model/resource/query_result/index.html | 12 ++-
.../reference/model/resource/resource/index.html | 12 ++-
.../reference/model/resource/version/index.html | 4 +-
docs-python/dev/scripts/gen_ref_pages/index.html | 12 +--
docs-python/dev/search/search_index.json | 2 +-
docs-python/dev/sitemap.xml | 96 ++++++++++-----------
docs-python/dev/sitemap.xml.gz | Bin 705 -> 705 bytes
41 files changed, 697 insertions(+), 273 deletions(-)
diff --git a/docs-python/dev/assets/_mkdocstrings.css b/docs-python/dev/assets/_mkdocstrings.css
index a65078d0..049a254b 100644
--- a/docs-python/dev/assets/_mkdocstrings.css
+++ b/docs-python/dev/assets/_mkdocstrings.css
@@ -1,18 +1,13 @@
-/* Don't capitalize names. */
-h5.doc-heading {
- text-transform: none !important;
-}
-
-/* Avoid breaking parameters name, etc. in table cells. */
+/* Avoid breaking parameter names, etc. in table cells. */
.doc-contents td code {
word-break: normal !important;
}
-/* For pieces of Markdown rendered in table cells. */
-.doc-contents td p {
- margin-top: 0 !important;
- margin-bottom: 0 !important;
+/* No line break before first paragraph of descriptions. */
+.doc-md-description,
+.doc-md-description>p:first-child {
+ display: inline;
}
/* Max width for docstring sections tables. */
@@ -21,16 +16,49 @@ h5.doc-heading {
display: table !important;
width: 100%;
}
+
.doc .md-typeset__table tr {
display: table-row;
}
-/* Avoid line breaks in rendered fields. */
-.field-body p {
- display: inline;
-}
-
/* Defaults in Spacy table style. */
.doc-param-default {
float: right;
}
+
+/* Keep headings consistent. */
+h1.doc-heading,
+h2.doc-heading,
+h3.doc-heading,
+h4.doc-heading,
+h5.doc-heading,
+h6.doc-heading {
+ font-weight: 400;
+ line-height: 1.5;
+ color: inherit;
+ text-transform: none;
+}
+
+h1.doc-heading {
+ font-size: 1.6rem;
+}
+
+h2.doc-heading {
+ font-size: 1.2rem;
+}
+
+h3.doc-heading {
+ font-size: 1.15rem;
+}
+
+h4.doc-heading {
+ font-size: 1.10rem;
+}
+
+h5.doc-heading {
+ font-size: 1.05rem;
+}
+
+h6.doc-heading {
+ font-size: 1rem;
+}
\ No newline at end of file
diff --git a/docs-python/dev/img/interrogate_badge.svg b/docs-python/dev/img/interrogate_badge.svg
index c4d5627d..ea7a3fa7 100644
--- a/docs-python/dev/img/interrogate_badge.svg
+++ b/docs-python/dev/img/interrogate_badge.svg
@@ -1,5 +1,5 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="140" height="20" role="img" aria-label="interrogate: 100%">
- <title>interrogate: 100%</title>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="140" height="20" role="img" aria-label="interrogate: 99.7%">
+ <title>interrogate: 99.7%</title>
<linearGradient id="s" x2="0" y2="100%">
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
<stop offset="1" stop-opacity=".1"/>
@@ -15,8 +15,8 @@
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110">
<text aria-hidden="true" x="590" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="610">interrogate</text>
<text x="590" y="140" transform="scale(.1)" fill="#fff" textLength="610">interrogate</text>
- <text aria-hidden="true" x="1160" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="330">100%</text>
- <text x="1160" y="140" transform="scale(.1)" fill="#fff" textLength="330" data-interrogate="result">100%</text>
+ <text aria-hidden="true" x="1160" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">99.7%</text>
+ <text x="1160" y="140" transform="scale(.1)" fill="#fff" textLength="370" data-interrogate="result">99.7%</text>
</g>
<g id="logo-shadow" transform="matrix(0.854876,0,0,0.854876,-6.73514,1.732)">
<g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
diff --git a/docs-python/dev/reference/client/client/index.html b/docs-python/dev/reference/client/client/index.html
index 27521991..76ba628c 100644
--- a/docs-python/dev/reference/client/client/index.html
+++ b/docs-python/dev/reference/client/client/index.html
@@ -1920,7 +1920,9 @@ API.</p>
<tr>
<td><code>client_config</code></td>
<td class="doc-param-details">
- <p>Configures the client to connect properly to the StreamPipes instance.</p>
+ <div class="doc-md-description">
+ <p>Configures the client to connect properly to the StreamPipes instance.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1932,7 +1934,9 @@ API.</p>
<tr>
<td><code>logging_level</code></td>
<td class="doc-param-details">
- <p>Influences the log messages emitted by the <code>StreamPipesClient</code></p>
+ <div class="doc-md-description">
+ <p>Influences the log messages emitted by the <code>StreamPipesClient</code></p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1959,7 +1963,9 @@ API.</p>
<tr>
<td><code>dataLakeMeasureApi</code></td>
<td class="doc-attribute-details">
- <p>Instance of the data lake measure endpoint</p>
+ <div class="doc-md-description">
+ <p>Instance of the data lake measure endpoint</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -1971,7 +1977,9 @@ API.</p>
<tr>
<td><code>dataStreamApi</code></td>
<td class="doc-attribute-details">
- <p>Instance of the data stream endpoint</p>
+ <div class="doc-md-description">
+ <p>Instance of the data stream endpoint</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2058,7 +2066,9 @@ intended to be consistent with the StreamPipes Java client.
<code>base_api_path</code>
</td>
<td class="doc-returns-details">
- <p>basic API path of the connected StreamPipes instance</p>
+ <div class="doc-md-description">
+ <p>basic API path of the connected StreamPipes instance</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2106,7 +2116,9 @@ provider and additional required headers (currently this is only the application
<code>http_headers</code>
</td>
<td class="doc-returns-details">
- <p>header information for HTTP requests as string key-value pairs.</p>
+ <div class="doc-md-description">
+ <p>header information for HTTP requests as string key-value pairs.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2153,7 +2165,9 @@ provider and additional required headers (currently this is only the application
<tr>
<td><code>client_config</code></td>
<td class="doc-param-details">
- <p>Configures the client to connect properly to the StreamPipes instance.</p>
+ <div class="doc-md-description">
+ <p>Configures the client to connect properly to the StreamPipes instance.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2165,7 +2179,9 @@ provider and additional required headers (currently this is only the application
<tr>
<td><code>logging_level</code></td>
<td class="doc-param-details">
- <p>Influences the log messages emitted by the <code>StreamPipesClient</code>.</p>
+ <div class="doc-md-description">
+ <p>Influences the log messages emitted by the <code>StreamPipesClient</code>.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2196,7 +2212,9 @@ provider and additional required headers (currently this is only the application
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2235,7 +2253,9 @@ provider and additional required headers (currently this is only the application
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/client/config/index.html b/docs-python/dev/reference/client/config/index.html
index 7a58455f..5fc2dbf1 100644
--- a/docs-python/dev/reference/client/config/index.html
+++ b/docs-python/dev/reference/client/config/index.html
@@ -1850,7 +1850,9 @@
<tr>
<td><code>credential_provider</code></td>
<td class="doc-param-details">
- <p>Provides the credentials to authenticate with the StreamPipes API.</p>
+ <div class="doc-md-description">
+ <p>Provides the credentials to authenticate with the StreamPipes API.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1862,8 +1864,10 @@
<tr>
<td><code>host_address</code></td>
<td class="doc-param-details">
- <p>Host address of the StreamPipes instance to connect to.
+ <div class="doc-md-description">
+ <p>Host address of the StreamPipes instance to connect to.
Should be provided without the protocol/scheme, e.g. as <code>localhost</code> or <code>streampipes.xyz</code>.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1875,7 +1879,9 @@ Should be provided without the protocol/scheme, e.g. as <code>localhost</code> o
<tr>
<td><code>https_disabled</code></td>
<td class="doc-param-details">
- <p>Determines whether https is used to connect to StreamPipes.</p>
+ <div class="doc-md-description">
+ <p>Determines whether https is used to connect to StreamPipes.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1891,8 +1897,10 @@ Should be provided without the protocol/scheme, e.g. as <code>localhost</code> o
<tr>
<td><code>port</code></td>
<td class="doc-param-details">
- <p>Specifies the port under which the StreamPipes API is available,
+ <div class="doc-md-description">
+ <p>Specifies the port under which the StreamPipes API is available,
e.g., <code>80</code> (with http) or <code>443</code> (with https)</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/client/credential_provider/index.html b/docs-python/dev/reference/client/credential_provider/index.html
index cda117d9..c3d40b56 100644
--- a/docs-python/dev/reference/client/credential_provider/index.html
+++ b/docs-python/dev/reference/client/credential_provider/index.html
@@ -1945,7 +1945,9 @@ Must be inherited by all credential providers.</p>
<tr>
<td><code>http_headers</code></td>
<td class="doc-param-details">
- <p>Additional HTTP headers the generated headers are extended by.</p>
+ <div class="doc-md-description">
+ <p>Additional HTTP headers the generated headers are extended by.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1974,9 +1976,11 @@ Must be inherited by all credential providers.</p>
<code>https_headers</code>
</td>
<td class="doc-returns-details">
- <p>Dictionary with header information as string key-value pairs. <br>
+ <div class="doc-md-description">
+ <p>Dictionary with header information as string key-value pairs. <br>
Contains all pairs given as parameter plus the header pairs for authentication
determined by the credential provider.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2035,8 +2039,10 @@ If they are not passed, they are retrieved from environment variables:</p>
<tr>
<td><code>username</code></td>
<td class="doc-param-details">
- <p>The username to which the API token is granted, e.g., <code>demo-user@streampipes.apche.org</code>.<br>
+ <div class="doc-md-description">
+ <p>The username to which the API token is granted, e.g., <code>demo-user@streampipes.apche.org</code>.<br>
If not passed, the username is retrieved from environment variable <code>SP_USERNAME</code>.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2052,8 +2058,10 @@ If not passed, the username is retrieved from environment variable <code>SP_USER
<tr>
<td><code>api_key</code></td>
<td class="doc-param-details">
- <p>The StreamPipes API key as it is displayed in the UI.<br>
+ <div class="doc-md-description">
+ <p>The StreamPipes API key as it is displayed in the UI.<br>
If not passed, the api key is retrieved from environment variable <code>SP_API_KEY</code></p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2116,7 +2124,9 @@ If not passed, the api key is retrieved from environment variable <code>SP_API_K
<tr>
<td><code>username_env</code></td>
<td class="doc-param-details">
- <p>Name of the environment variable that contains the username</p>
+ <div class="doc-md-description">
+ <p>Name of the environment variable that contains the username</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2128,7 +2138,9 @@ If not passed, the api key is retrieved from environment variable <code>SP_API_K
<tr>
<td><code>api_key_env</code></td>
<td class="doc-param-details">
- <p>Name of the environment variable that contains the API key</p>
+ <div class="doc-md-description">
+ <p>Name of the environment variable that contains the API key</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2155,7 +2167,9 @@ If not passed, the api key is retrieved from environment variable <code>SP_API_K
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2176,7 +2190,9 @@ If not passed, the api key is retrieved from environment variable <code>SP_API_K
</span>
</td>
<td class="doc-raises-details">
- <p>If one of the environment variables is not defined</p>
+ <div class="doc-md-description">
+ <p>If one of the environment variables is not defined</p>
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html b/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html
index d916f574..2ab3fd73 100644
--- a/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html
+++ b/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html
@@ -2038,7 +2038,9 @@ This behaviour can be influenced by passing the parameter <code>limit</code> wit
<tr>
<td><code>identifier</code></td>
<td class="doc-param-details">
- <p>The identifier of the data lake measure to be queried.</p>
+ <div class="doc-md-description">
+ <p>The identifier of the data lake measure to be queried.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2050,9 +2052,11 @@ This behaviour can be influenced by passing the parameter <code>limit</code> wit
<tr>
<td><code>**kwargs</code></td>
<td class="doc-param-details">
- <p>keyword arguments can be used to provide additional query parameters.
+ <div class="doc-md-description">
+ <p>keyword arguments can be used to provide additional query parameters.
The available query parameters are defined by the
<a class="autorefs autorefs-internal" href="#streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig">MeasurementGetQueryConfig</a>.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2081,7 +2085,9 @@ The available query parameters are defined by the
<code>measurement</code>
</td>
<td class="doc-returns-details">
- <p>the specified data lake measure</p>
+ <div class="doc-md-description">
+ <p>the specified data lake measure</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2141,9 +2147,11 @@ for which <a href="https://docs.pydantic.dev/usage/model_config/#options">Pydant
<tr>
<td><code>columns</code></td>
<td class="doc-attribute-details">
- <p>A comma separated list of column names (e.g., <code>time,value</code>)<br>
+ <div class="doc-md-description">
+ <p>A comma separated list of column names (e.g., <code>time,value</code>)<br>
If provided, the returned data only consists of the given columns.<br>
Please be aware that the column <code>time</code> as an index is always included.</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2155,7 +2163,9 @@ Please be aware that the column <code>time</code> as an index is always included
<tr>
<td><code>end_date</code></td>
<td class="doc-attribute-details">
- <p>Restricts queried data to be younger than the specified time.</p>
+ <div class="doc-md-description">
+ <p>Restricts queried data to be younger than the specified time.</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2167,8 +2177,10 @@ Please be aware that the column <code>time</code> as an index is always included
<tr>
<td><code>limit</code></td>
<td class="doc-attribute-details">
- <p>Amount of records returned at maximum (default: <code>1000</code>) <br>
+ <div class="doc-md-description">
+ <p>Amount of records returned at maximum (default: <code>1000</code>) <br>
This needs to be at least <code>1</code></p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2180,8 +2192,10 @@ This needs to be at least <code>1</code></p>
<tr>
<td><code>offset</code></td>
<td class="doc-attribute-details">
- <p>Offset to be applied to returned data <br>
+ <div class="doc-md-description">
+ <p>Offset to be applied to returned data <br>
This needs to be at least <code>0</code></p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2193,8 +2207,10 @@ This needs to be at least <code>0</code></p>
<tr>
<td><code>order</code></td>
<td class="doc-attribute-details">
- <p>Ordering of query results <br>
+ <div class="doc-md-description">
+ <p>Ordering of query results <br>
Allowed values: <code>ASC</code> and <code>DESC</code> (default: <code>ASC</code>)</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2206,8 +2222,10 @@ Allowed values: <code>ASC</code> and <code>DESC</code> (default: <code>ASC</code
<tr>
<td><code>page_no</code></td>
<td class="doc-attribute-details">
- <p>Page number used for paging operation <br>
+ <div class="doc-md-description">
+ <p>Page number used for paging operation <br>
This needs to be at least <code>1</code></p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2219,7 +2237,9 @@ This needs to be at least <code>1</code></p>
<tr>
<td><code>start_date</code></td>
<td class="doc-attribute-details">
- <p>Restricts queried data to be older than the specified time</p>
+ <div class="doc-md-description">
+ <p>Restricts queried data to be older than the specified time</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2313,7 +2333,9 @@ This query string is not an entire URL, instead it needs to appended to an API p
<code>query_param_string</code>
</td>
<td class="doc-returns-details">
- <p>HTTP query params string (<code>?param1=value1&param2=value2...</code>)</p>
+ <div class="doc-md-description">
+ <p>HTTP query params string (<code>?param1=value1&param2=value2...</code>)</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/endpoint/api/version/index.html b/docs-python/dev/reference/endpoint/api/version/index.html
index d7f4dc1b..de6f2d3e 100644
--- a/docs-python/dev/reference/endpoint/api/version/index.html
+++ b/docs-python/dev/reference/endpoint/api/version/index.html
@@ -1905,7 +1905,9 @@ It only allows to apply the <code>get()</code> method with an empty string as id
<tr>
<td><code>parent_client</code></td>
<td class="doc-param-details">
- <p>The instance of <a class="autorefs autorefs-internal" href="../../../client/client/#streampipes.client.client.StreamPipesClient">StreamPipesClient</a> the endpoint is attached to.</p>
+ <div class="doc-md-description">
+ <p>The instance of <a class="autorefs autorefs-internal" href="../../../client/client/#streampipes.client.client.StreamPipesClient">StreamPipesClient</a> the endpoint is attached to.</p>
+ </div>
<p>
</p>
</td>
@@ -1975,7 +1977,9 @@ However, this endpoint does not support this kind of operation.</p>
</span>
</td>
<td class="doc-raises-details">
- <p>this endpoint does not return multiple entries, therefore this method is not available</p>
+ <div class="doc-md-description">
+ <p>this endpoint does not return multiple entries, therefore this method is not available</p>
+ </div>
</td>
</tr>
</tbody>
@@ -2011,7 +2015,9 @@ However, this endpoint does not support this kind of operation.</p>
<tr>
<td><code>identifier</code></td>
<td class="doc-param-details">
- <p>Not supported by this endpoint, is set to an empty string.</p>
+ <div class="doc-md-description">
+ <p>Not supported by this endpoint, is set to an empty string.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2036,7 +2042,9 @@ However, this endpoint does not support this kind of operation.</p>
<code>versions</code>
</td>
<td class="doc-returns-details">
- <p>The specified resource as an instance of the corresponding model class(<a class="autorefs autorefs-internal" href="../../../model/resource/version/#streampipes.model.resource.version.Version">Version</a>). # noqa: 501</p>
+ <div class="doc-md-description">
+ <p>The specified resource as an instance of the corresponding model class(<a class="autorefs autorefs-internal" href="../../../model/resource/version/#streampipes.model.resource.version.Version">Version</a>). # noqa: 501</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2082,7 +2090,9 @@ Since the data represented by this endpoint is immutable, it does not support th
</span>
</td>
<td class="doc-raises-details">
- <p>this endpoint does not allow for POST requests, therefore this method is not available</p>
+ <div class="doc-md-description">
+ <p>this endpoint does not allow for POST requests, therefore this method is not available</p>
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/endpoint/endpoint/index.html b/docs-python/dev/reference/endpoint/endpoint/index.html
index abadefb6..91182356 100644
--- a/docs-python/dev/reference/endpoint/endpoint/index.html
+++ b/docs-python/dev/reference/endpoint/endpoint/index.html
@@ -2019,7 +2019,9 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<code>container</code>
</td>
<td class="doc-returns-details">
- <p>container element that bundles the returned resources</p>
+ <div class="doc-md-description">
+ <p>container element that bundles the returned resources</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2062,7 +2064,9 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<code>url</code>
</td>
<td class="doc-returns-details">
- <p>The URL of the endpoint</p>
+ <div class="doc-md-description">
+ <p>The URL of the endpoint</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2103,7 +2107,9 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<tr>
<td><code>identifier</code></td>
<td class="doc-param-details">
- <p>The identifier of the resource to be queried.</p>
+ <div class="doc-md-description">
+ <p>The identifier of the resource to be queried.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2128,7 +2134,9 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<code>resource</code>
</td>
<td class="doc-returns-details">
- <p>The specified resource as an instance of the corresponding model class.</p>
+ <div class="doc-md-description">
+ <p>The specified resource as an instance of the corresponding model class.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2169,7 +2177,9 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<tr>
<td><code>resource</code></td>
<td class="doc-param-details">
- <p>The resource to be posted.</p>
+ <div class="doc-md-description">
+ <p>The resource to be posted.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2196,7 +2206,9 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2244,7 +2256,9 @@ By design, endpoints are only instantiated within the <code>__init__</code> meth
<tr>
<td><code>parent_client</code></td>
<td class="doc-param-details">
- <p>This parameter expects the instance of <code>StreamPipesClient</code> the endpoint is attached to.</p>
+ <div class="doc-md-description">
+ <p>This parameter expects the instance of <code>StreamPipesClient</code> the endpoint is attached to.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2318,8 +2332,8 @@ By design, endpoints are only instantiated within the <code>__init__</code> meth
<code class="highlight language-python"><span class="n">broker</span><span class="p">:</span> <span class="n">Broker</span></code>
<span class="doc doc-labels">
- <small class="doc doc-label doc-label-property"><code>property</code></small>
<small class="doc doc-label doc-label-writable"><code>writable</code></small>
+ <small class="doc doc-label doc-label-property"><code>property</code></small>
</span>
<a href="#streampipes.endpoint.endpoint.MessagingEndpoint.broker" class="headerlink" title="Permanent link">¶</a></h3>
@@ -2346,7 +2360,9 @@ to consume messages from and to write messages to the broker.</p>
</span>
</td>
<td class="doc-raises-details">
- <p>If the endpoint is used before the broker instance is set via <code>configure()</code></p>
+ <div class="doc-md-description">
+ <p>If the endpoint is used before the broker instance is set via <code>configure()</code></p>
+ </div>
</td>
</tr>
</tbody>
@@ -2365,7 +2381,9 @@ to consume messages from and to write messages to the broker.</p>
<code>broker</code>
</td>
<td class="doc-returns-details">
- <p>The broker instance to be used to communicate with StreamPipes' messaging layer.</p>
+ <div class="doc-md-description">
+ <p>The broker instance to be used to communicate with StreamPipes' messaging layer.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2409,7 +2427,9 @@ The based <code>broker</code> instance is passed to an internal property</p>
<tr>
<td><code>broker</code></td>
<td class="doc-param-details">
- <p>Broker instance that should be used for this endpoint</p>
+ <div class="doc-md-description">
+ <p>Broker instance that should be used for this endpoint</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2436,7 +2456,9 @@ The based <code>broker</code> instance is passed to an internal property</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/endpoint/exceptions/index.html b/docs-python/dev/reference/endpoint/exceptions/index.html
index 87f61ad2..55662c27 100644
--- a/docs-python/dev/reference/endpoint/exceptions/index.html
+++ b/docs-python/dev/reference/endpoint/exceptions/index.html
@@ -1848,7 +1848,9 @@ the broker instance to be used is configured by passing it to the <code>configur
<tr>
<td><code>endpoint_name</code></td>
<td class="doc-param-details">
- <p>The name of the endpoint that caused the error</p>
+ <div class="doc-md-description">
+ <p>The name of the endpoint that caused the error</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/function_zoo/river_function/index.html b/docs-python/dev/reference/function_zoo/river_function/index.html
index e552276c..56c2544e 100644
--- a/docs-python/dev/reference/function_zoo/river_function/index.html
+++ b/docs-python/dev/reference/function_zoo/river_function/index.html
@@ -1980,7 +1980,9 @@ creates an output data stream that publishes the prediction to StreamPipes.</p>
<tr>
<td><code>client</code></td>
<td class="doc-param-details">
- <p>The client for the StreamPipes API.</p>
+ <div class="doc-md-description">
+ <p>The client for the StreamPipes API.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1992,7 +1994,9 @@ creates an output data stream that publishes the prediction to StreamPipes.</p>
<tr>
<td><code>stream_ids</code></td>
<td class="doc-param-details">
- <p>The ids of the data stream to train the model.</p>
+ <div class="doc-md-description">
+ <p>The ids of the data stream to train the model.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2004,8 +2008,10 @@ creates an output data stream that publishes the prediction to StreamPipes.</p>
<tr>
<td><code>model</code></td>
<td class="doc-param-details">
- <p>The model to train. It meant to be a River model/pipeline,
+ <div class="doc-md-description">
+ <p>The model to train. It meant to be a River model/pipeline,
but can be every model with a 'learn_one' and 'predict_one' methode.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2017,8 +2023,10 @@ but can be every model with a 'learn_one' and 'predict_one' methode.</p>
<tr>
<td><code>prediction_type</code></td>
<td class="doc-param-details">
- <p>The data type of the prediction.
+ <div class="doc-md-description">
+ <p>The data type of the prediction.
Is only needed when you continue to work with the prediction in StreamPipes.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2034,7 +2042,9 @@ Is only needed when you continue to work with the prediction in StreamPipes.</p>
<tr>
<td><code>supervised</code></td>
<td class="doc-param-details">
- <p>Define if the model is supervised or unsupervised.</p>
+ <div class="doc-md-description">
+ <p>Define if the model is supervised or unsupervised.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2050,7 +2060,9 @@ Is only needed when you continue to work with the prediction in StreamPipes.</p>
<tr>
<td><code>target_label</code></td>
<td class="doc-param-details">
- <p>Define the name of the target attribute if the model is supervised.</p>
+ <div class="doc-md-description">
+ <p>Define the name of the target attribute if the model is supervised.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2066,7 +2078,9 @@ Is only needed when you continue to work with the prediction in StreamPipes.</p>
<tr>
<td><code>on_start</code></td>
<td class="doc-param-details">
- <p>A function to be called when this StreamPipesFunction gets started.</p>
+ <div class="doc-md-description">
+ <p>A function to be called when this StreamPipesFunction gets started.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2082,7 +2096,9 @@ Is only needed when you continue to work with the prediction in StreamPipes.</p>
<tr>
<td><code>on_event</code></td>
<td class="doc-param-details">
- <p>A function to be called when this StreamPipesFunction receives an event.</p>
+ <div class="doc-md-description">
+ <p>A function to be called when this StreamPipesFunction receives an event.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2098,7 +2114,9 @@ Is only needed when you continue to work with the prediction in StreamPipes.</p>
<tr>
<td><code>on_stop</code></td>
<td class="doc-param-details">
- <p>A function to be called when this StreamPipesFunction gets stopped.</p>
+ <div class="doc-md-description">
+ <p>A function to be called when this StreamPipesFunction gets stopped.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2153,7 +2171,9 @@ Is only needed when you continue to work with the prediction in StreamPipes.</p>
<tr>
<td><code>learning</code></td>
<td class="doc-param-details">
- <p>Defines if the training should be continued</p>
+ <div class="doc-md-description">
+ <p>Defines if the training should be continued</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2243,7 +2263,9 @@ for Online Machine Learning models of the <a href="https://riverml.xyz/">River l
<tr>
<td><code>function_definition</code></td>
<td class="doc-param-details">
- <p>The function definition which contains the output stream.</p>
+ <div class="doc-md-description">
+ <p>The function definition which contains the output stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2255,7 +2277,9 @@ for Online Machine Learning models of the <a href="https://riverml.xyz/">River l
<tr>
<td><code>stream_ids</code></td>
<td class="doc-param-details">
- <p>The ids of the data stream to train the model.</p>
+ <div class="doc-md-description">
+ <p>The ids of the data stream to train the model.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2267,8 +2291,10 @@ for Online Machine Learning models of the <a href="https://riverml.xyz/">River l
<tr>
<td><code>model</code></td>
<td class="doc-param-details">
- <p>The model to train. It meant to be a River model/pipeline,
+ <div class="doc-md-description">
+ <p>The model to train. It meant to be a River model/pipeline,
but can be every model with a 'learn_one' and 'predict_one' method.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2280,7 +2306,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<tr>
<td><code>supervised</code></td>
<td class="doc-param-details">
- <p>Define if the model is supervised or unsupervised.</p>
+ <div class="doc-md-description">
+ <p>Define if the model is supervised or unsupervised.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2292,7 +2320,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<tr>
<td><code>target_label</code></td>
<td class="doc-param-details">
- <p>Define the name of the target attribute if the model is supervised.</p>
+ <div class="doc-md-description">
+ <p>Define the name of the target attribute if the model is supervised.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2304,7 +2334,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<tr>
<td><code>on_start</code></td>
<td class="doc-param-details">
- <p>A function to be called when this StreamPipesFunction gets started.</p>
+ <div class="doc-md-description">
+ <p>A function to be called when this StreamPipesFunction gets started.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2316,7 +2348,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<tr>
<td><code>on_event</code></td>
<td class="doc-param-details">
- <p>A function to be called when this StreamPipesFunction receives an event.</p>
+ <div class="doc-md-description">
+ <p>A function to be called when this StreamPipesFunction receives an event.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2328,7 +2362,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<tr>
<td><code>on_stop</code></td>
<td class="doc-param-details">
- <p>A function to be called when this StreamPipesFunction gets stopped.</p>
+ <div class="doc-md-description">
+ <p>A function to be called when this StreamPipesFunction gets stopped.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2379,7 +2415,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<tr>
<td><code>event</code></td>
<td class="doc-param-details">
- <p>The incoming event that serves as input for the function</p>
+ <div class="doc-md-description">
+ <p>The incoming event that serves as input for the function</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2391,7 +2429,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<tr>
<td><code>streamId</code></td>
<td class="doc-param-details">
- <p>Identifier of the corresponding data stream</p>
+ <div class="doc-md-description">
+ <p>Identifier of the corresponding data stream</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2418,7 +2458,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2453,7 +2495,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<tr>
<td><code>context</code></td>
<td class="doc-param-details">
- <p>The functions' context</p>
+ <div class="doc-md-description">
+ <p>The functions' context</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2480,7 +2524,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2535,7 +2581,9 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<code>stream_ids</code>
</td>
<td class="doc-returns-details">
- <p>List of stream ids required by the function</p>
+ <div class="doc-md-description">
+ <p>List of stream ids required by the function</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/broker/broker/index.html b/docs-python/dev/reference/functions/broker/broker/index.html
index 81903508..df6007b9 100644
--- a/docs-python/dev/reference/functions/broker/broker/index.html
+++ b/docs-python/dev/reference/functions/broker/broker/index.html
@@ -1920,7 +1920,9 @@
<tr>
<td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>Contains the meta information (resources) for a data stream.</p>
+ <div class="doc-md-description">
+ <p>Contains the meta information (resources) for a data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1947,7 +1949,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -1991,7 +1995,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/broker/broker_handler/index.html b/docs-python/dev/reference/functions/broker/broker_handler/index.html
index ad2fd26a..92bc5f71 100644
--- a/docs-python/dev/reference/functions/broker/broker_handler/index.html
+++ b/docs-python/dev/reference/functions/broker/broker_handler/index.html
@@ -1965,7 +1965,9 @@
<tr>
<td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>Data stream instance from which the broker is inferred</p>
+ <div class="doc-md-description">
+ <p>Data stream instance from which the broker is inferred</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1990,7 +1992,9 @@
<code>broker</code>
</td>
<td class="doc-returns-details">
- <p>The corresponding broker instance derived from data stream.</p>
+ <div class="doc-md-description">
+ <p>The corresponding broker instance derived from data stream.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2017,7 +2021,9 @@
</span>
</td>
<td class="doc-raises-details">
- <p>Is raised when the given data stream belongs to a broker that is currently not supported by StreamPipes Python.</p>
+ <div class="doc-md-description">
+ <p>Is raised when the given data stream belongs to a broker that is currently not supported by StreamPipes Python.</p>
+ </div>
</td>
</tr>
</tbody>
@@ -2052,7 +2058,9 @@
<tr>
<td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>Data stream instance from which the broker is inferred</p>
+ <div class="doc-md-description">
+ <p>Data stream instance from which the broker is inferred</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2077,7 +2085,9 @@
<code>broker</code>
</td>
<td class="doc-returns-details">
- <p>The corresponding broker description derived from data stream.</p>
+ <div class="doc-md-description">
+ <p>The corresponding broker description derived from data stream.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2104,7 +2114,9 @@
</span>
</td>
<td class="doc-raises-details">
- <p>Is raised when the given data stream belongs to a broker that is currently not supported by StreamPipes Python.</p>
+ <div class="doc-md-description">
+ <p>Is raised when the given data stream belongs to a broker that is currently not supported by StreamPipes Python.</p>
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/broker/consumer/index.html b/docs-python/dev/reference/functions/broker/consumer/index.html
index 9ab940f4..c420b542 100644
--- a/docs-python/dev/reference/functions/broker/consumer/index.html
+++ b/docs-python/dev/reference/functions/broker/consumer/index.html
@@ -1920,7 +1920,9 @@
<tr>
<td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>Contains the meta information (resources) for a data stream.</p>
+ <div class="doc-md-description">
+ <p>Contains the meta information (resources) for a data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1947,7 +1949,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -1988,7 +1992,9 @@
<code>iterator</code>
</td>
<td class="doc-returns-details">
- <p>An async iterator for the messages.</p>
+ <div class="doc-md-description">
+ <p>An async iterator for the messages.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html b/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
index 44d1f4e7..209d5b1c 100644
--- a/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
+++ b/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
@@ -1925,7 +1925,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -1962,7 +1964,9 @@
<code>iterator</code>
</td>
<td class="doc-returns-details">
- <p>An async iterator for the messages.</p>
+ <div class="doc-md-description">
+ <p>An async iterator for the messages.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/broker/kafka/kafka_message_fetcher/index.html b/docs-python/dev/reference/functions/broker/kafka/kafka_message_fetcher/index.html
index 7710cc73..bc0e0b57 100644
--- a/docs-python/dev/reference/functions/broker/kafka/kafka_message_fetcher/index.html
+++ b/docs-python/dev/reference/functions/broker/kafka/kafka_message_fetcher/index.html
@@ -1860,7 +1860,9 @@
<tr>
<td><code>data</code></td>
<td class="doc-param-details">
- <p>The received Kafka message as byte array</p>
+ <div class="doc-md-description">
+ <p>The received Kafka message as byte array</p>
+ </div>
<p>
</p>
</td>
@@ -1916,7 +1918,9 @@
<tr>
<td><code>consumer</code></td>
<td class="doc-param-details">
- <p>The Kafka consumer</p>
+ <div class="doc-md-description">
+ <p>The Kafka consumer</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html b/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
index cd0e789e..494c6661 100644
--- a/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
+++ b/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
@@ -1925,7 +1925,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -1964,7 +1966,9 @@
<tr>
<td><code>event</code></td>
<td class="doc-param-details">
- <p>The event to be published.</p>
+ <div class="doc-md-description">
+ <p>The event to be published.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1991,7 +1995,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html b/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
index b74c3bb3..1a67d624 100644
--- a/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
+++ b/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
@@ -1925,7 +1925,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -1962,7 +1964,9 @@
<code>message_iterator</code>
</td>
<td class="doc-returns-details">
- <p>An async iterator for the messages.</p>
+ <div class="doc-md-description">
+ <p>An async iterator for the messages.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/broker/nats/nats_publisher/index.html b/docs-python/dev/reference/functions/broker/nats/nats_publisher/index.html
index 0d497c9c..62e61279 100644
--- a/docs-python/dev/reference/functions/broker/nats/nats_publisher/index.html
+++ b/docs-python/dev/reference/functions/broker/nats/nats_publisher/index.html
@@ -1925,7 +1925,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -1964,7 +1966,9 @@
<tr>
<td><code>event</code></td>
<td class="doc-param-details">
- <p>The event to be published.</p>
+ <div class="doc-md-description">
+ <p>The event to be published.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1991,7 +1995,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/broker/output_collector/index.html b/docs-python/dev/reference/functions/broker/output_collector/index.html
index 70a4c761..8465cff6 100644
--- a/docs-python/dev/reference/functions/broker/output_collector/index.html
+++ b/docs-python/dev/reference/functions/broker/output_collector/index.html
@@ -1885,7 +1885,9 @@ Therefore, the output collector establishes a connection to the broker.</p>
<tr>
<td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>The output data stream that will receive the events.</p>
+ <div class="doc-md-description">
+ <p>The output data stream that will receive the events.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1908,7 +1910,9 @@ Therefore, the output collector establishes a connection to the broker.</p>
<tr>
<td><code>publisher</code></td>
<td class="doc-attribute-details">
- <p>The publisher instance that sends the data to StreamPipes</p>
+ <div class="doc-md-description">
+ <p>The publisher instance that sends the data to StreamPipes</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -1959,7 +1963,9 @@ Therefore, the output collector establishes a connection to the broker.</p>
<tr>
<td><code>event</code></td>
<td class="doc-param-details">
- <p>The event to be published.</p>
+ <div class="doc-md-description">
+ <p>The event to be published.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1986,7 +1992,9 @@ Therefore, the output collector establishes a connection to the broker.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2025,7 +2033,9 @@ Therefore, the output collector establishes a connection to the broker.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/broker/publisher/index.html b/docs-python/dev/reference/functions/broker/publisher/index.html
index e16bec2f..867273df 100644
--- a/docs-python/dev/reference/functions/broker/publisher/index.html
+++ b/docs-python/dev/reference/functions/broker/publisher/index.html
@@ -1907,7 +1907,9 @@
<tr>
<td><code>event</code></td>
<td class="doc-param-details">
- <p>The event to be published.</p>
+ <div class="doc-md-description">
+ <p>The event to be published.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1934,7 +1936,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/function_handler/index.html b/docs-python/dev/reference/functions/function_handler/index.html
index e412f9b1..53dc1efe 100644
--- a/docs-python/dev/reference/functions/function_handler/index.html
+++ b/docs-python/dev/reference/functions/function_handler/index.html
@@ -1898,7 +1898,9 @@ and is able to stop the connection to the brokers and functions.</p>
<tr>
<td><code>registration</code></td>
<td class="doc-param-details">
- <p>The registration, that contains the StreamPipesFunctions.</p>
+ <div class="doc-md-description">
+ <p>The registration, that contains the StreamPipesFunctions.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1910,7 +1912,9 @@ and is able to stop the connection to the brokers and functions.</p>
<tr>
<td><code>client</code></td>
<td class="doc-param-details">
- <p>The client to interact with the API.</p>
+ <div class="doc-md-description">
+ <p>The client to interact with the API.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1933,7 +1937,9 @@ and is able to stop the connection to the brokers and functions.</p>
<tr>
<td><code>stream_contexts</code></td>
<td class="doc-attribute-details">
- <p>Map of all data stream contexts</p>
+ <div class="doc-md-description">
+ <p>Map of all data stream contexts</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -1945,7 +1951,9 @@ and is able to stop the connection to the brokers and functions.</p>
<tr>
<td><code>brokers</code></td>
<td class="doc-attribute-details">
- <p>List of all registered brokers</p>
+ <div class="doc-md-description">
+ <p>List of all registered brokers</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2000,7 +2008,9 @@ and is able to stop the connection to the brokers and functions.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2039,7 +2049,9 @@ and is able to stop the connection to the brokers and functions.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2060,7 +2072,9 @@ and is able to stop the connection to the brokers and functions.</p>
</span>
</td>
<td class="doc-warns-details">
- <p>If there is a running event loop and the functions should be stopped by disconnecting from the broker.</p>
+ <div class="doc-md-description">
+ <p>If there is a running event loop and the functions should be stopped by disconnecting from the broker.</p>
+ </div>
</td>
</tr>
</tbody>
@@ -2099,7 +2113,9 @@ and is able to stop the connection to the brokers and functions.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/registration/index.html b/docs-python/dev/reference/functions/registration/index.html
index 2d0c66e9..8029e0cb 100644
--- a/docs-python/dev/reference/functions/registration/index.html
+++ b/docs-python/dev/reference/functions/registration/index.html
@@ -1882,7 +1882,9 @@
<tr>
<td><code>functions</code></td>
<td class="doc-attribute-details">
- <p>List of all registered StreamPipesFunction</p>
+ <div class="doc-md-description">
+ <p>List of all registered StreamPipesFunction</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -1936,7 +1938,9 @@
<code>functions</code>
</td>
<td class="doc-returns-details">
- <p>List of all registered functions.</p>
+ <div class="doc-md-description">
+ <p>List of all registered functions.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -1977,7 +1981,9 @@
<tr>
<td><code>streampipes_function</code></td>
<td class="doc-param-details">
- <p>The function to register.</p>
+ <div class="doc-md-description">
+ <p>The function to register.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2002,7 +2008,9 @@
<code>self</code>
</td>
<td class="doc-returns-details">
- <p>The updated Registration instance</p>
+ <div class="doc-md-description">
+ <p>The updated Registration instance</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/streampipes_function/index.html b/docs-python/dev/reference/functions/streampipes_function/index.html
index 1ae668c8..116f4af5 100644
--- a/docs-python/dev/reference/functions/streampipes_function/index.html
+++ b/docs-python/dev/reference/functions/streampipes_function/index.html
@@ -1957,7 +1957,9 @@ data analytics libraries there.</p>
<tr>
<td><code>function_definition</code></td>
<td class="doc-param-details">
- <p>the definition of the function that contains metadata about the connected function</p>
+ <div class="doc-md-description">
+ <p>the definition of the function that contains metadata about the connected function</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1984,7 +1986,9 @@ data analytics libraries there.</p>
<tr>
<td><code>output_collectors</code></td>
<td class="doc-attribute-details">
- <p>List of all output collectors which are created based on the provided function definitions.</p>
+ <div class="doc-md-description">
+ <p>List of all output collectors which are created based on the provided function definitions.</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2035,7 +2039,9 @@ data analytics libraries there.</p>
<tr>
<td><code>stream_id</code></td>
<td class="doc-param-details">
- <p>The id of the output data stream</p>
+ <div class="doc-md-description">
+ <p>The id of the output data stream</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2047,7 +2053,9 @@ data analytics libraries there.</p>
<tr>
<td><code>event</code></td>
<td class="doc-param-details">
- <p>The event which should be sent</p>
+ <div class="doc-md-description">
+ <p>The event which should be sent</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2074,7 +2082,9 @@ data analytics libraries there.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2111,7 +2121,9 @@ data analytics libraries there.</p>
<code>function_id</code>
</td>
<td class="doc-returns-details">
- <p>Identification object of the StreamPipes function</p>
+ <div class="doc-md-description">
+ <p>Identification object of the StreamPipes function</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2156,7 +2168,9 @@ data analytics libraries there.</p>
<tr>
<td><code>event</code></td>
<td class="doc-param-details">
- <p>The received event from the data stream.</p>
+ <div class="doc-md-description">
+ <p>The received event from the data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2168,7 +2182,9 @@ data analytics libraries there.</p>
<tr>
<td><code>streamId</code></td>
<td class="doc-param-details">
- <p>The id of the data stream which the event belongs to.</p>
+ <div class="doc-md-description">
+ <p>The id of the data stream which the event belongs to.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2195,7 +2211,9 @@ data analytics libraries there.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2234,7 +2252,9 @@ data analytics libraries there.</p>
<tr>
<td><code>context</code></td>
<td class="doc-param-details">
- <p>The context in which the function gets started.</p>
+ <div class="doc-md-description">
+ <p>The context in which the function gets started.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2261,7 +2281,9 @@ data analytics libraries there.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2304,7 +2326,9 @@ data analytics libraries there.</p>
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
@@ -2345,7 +2369,9 @@ data analytics libraries there.</p>
<code>stream_ids</code>
</td>
<td class="doc-returns-details">
- <p>List of the stream ids</p>
+ <div class="doc-md-description">
+ <p>List of the stream ids</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/utils/async_iter_handler/index.html b/docs-python/dev/reference/functions/utils/async_iter_handler/index.html
index 0aa0db0f..2f2ddd1d 100644
--- a/docs-python/dev/reference/functions/utils/async_iter_handler/index.html
+++ b/docs-python/dev/reference/functions/utils/async_iter_handler/index.html
@@ -1918,7 +1918,9 @@
<tr>
<td><code>stream_id</code></td>
<td class="doc-param-details">
- <p>The id of the data stream which the message belongs to.</p>
+ <div class="doc-md-description">
+ <p>The id of the data stream which the message belongs to.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1930,7 +1932,9 @@
<tr>
<td><code>message</code></td>
<td class="doc-param-details">
- <p>An asynchronous iterator that contains the messages.</p>
+ <div class="doc-md-description">
+ <p>An asynchronous iterator that contains the messages.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1955,7 +1959,9 @@
<code>result</code>
</td>
<td class="doc-returns-details">
- <p>Tuple of the stream id und next message or <code>("stop", None)</code> if no message is left.</p>
+ <div class="doc-md-description">
+ <p>Tuple of the stream id und next message or <code>("stop", None)</code> if no message is left.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2001,7 +2007,9 @@
<tr>
<td><code>messages</code></td>
<td class="doc-param-details">
- <p>A dictionary with an asynchronous iterator for every stream id.</p>
+ <div class="doc-md-description">
+ <p>A dictionary with an asynchronous iterator for every stream id.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2026,7 +2034,9 @@
<code>message</code>
</td>
<td class="doc-yields-details">
- <p>Description of the anonymous integer return value.</p>
+ <div class="doc-md-description">
+ <p>Description of the anonymous integer return value.</p>
+ </div>
<p>
<span class="doc-yields-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/utils/data_stream_context/index.html b/docs-python/dev/reference/functions/utils/data_stream_context/index.html
index 60f66dd4..de5a35a8 100644
--- a/docs-python/dev/reference/functions/utils/data_stream_context/index.html
+++ b/docs-python/dev/reference/functions/utils/data_stream_context/index.html
@@ -1870,7 +1870,9 @@
<tr>
<td><code>functions</code></td>
<td class="doc-param-details">
- <p>StreamPipes Functions which require the data of this data stream.</p>
+ <div class="doc-md-description">
+ <p>StreamPipes Functions which require the data of this data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1882,7 +1884,9 @@
<tr>
<td><code>schema</code></td>
<td class="doc-param-details">
- <p>The schema of this data stream.</p>
+ <div class="doc-md-description">
+ <p>The schema of this data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1894,7 +1898,9 @@
<tr>
<td><code>broker</code></td>
<td class="doc-param-details">
- <p>The consumer to connect to this data stream.</p>
+ <div class="doc-md-description">
+ <p>The consumer to connect to this data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1945,7 +1951,9 @@
<tr>
<td><code>function</code></td>
<td class="doc-param-details">
- <p>StreamPipesFunction which requires this data stream.</p>
+ <div class="doc-md-description">
+ <p>StreamPipesFunction which requires this data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1972,7 +1980,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/utils/data_stream_generator/index.html b/docs-python/dev/reference/functions/utils/data_stream_generator/index.html
index bb041d90..1bff0d71 100644
--- a/docs-python/dev/reference/functions/utils/data_stream_generator/index.html
+++ b/docs-python/dev/reference/functions/utils/data_stream_generator/index.html
@@ -1861,7 +1861,9 @@
<tr>
<td><code>STRING</code></td>
<td class="doc-attribute-details">
-
+ <div class="doc-md-description">
+
+ </div>
<p>
</p>
</td>
@@ -1869,7 +1871,9 @@
<tr>
<td><code>BOOLEAN</code></td>
<td class="doc-attribute-details">
-
+ <div class="doc-md-description">
+
+ </div>
<p>
</p>
</td>
@@ -1877,7 +1881,9 @@
<tr>
<td><code>DOUBLE</code></td>
<td class="doc-attribute-details">
-
+ <div class="doc-md-description">
+
+ </div>
<p>
</p>
</td>
@@ -1885,7 +1891,9 @@
<tr>
<td><code>FLOAT</code></td>
<td class="doc-attribute-details">
-
+ <div class="doc-md-description">
+
+ </div>
<p>
</p>
</td>
@@ -1893,7 +1901,9 @@
<tr>
<td><code>INTEGER</code></td>
<td class="doc-attribute-details">
-
+ <div class="doc-md-description">
+
+ </div>
<p>
</p>
</td>
@@ -1901,7 +1911,9 @@
<tr>
<td><code>LONG</code></td>
<td class="doc-attribute-details">
-
+ <div class="doc-md-description">
+
+ </div>
<p>
</p>
</td>
@@ -1957,7 +1969,9 @@
<tr>
<td><code>name</code></td>
<td class="doc-param-details">
- <p>Name of the data stream to be shown at the UI.</p>
+ <div class="doc-md-description">
+ <p>Name of the data stream to be shown at the UI.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1969,7 +1983,9 @@
<tr>
<td><code>attributes</code></td>
<td class="doc-param-details">
- <p>Name and types of the attributes.</p>
+ <div class="doc-md-description">
+ <p>Name and types of the attributes.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1981,7 +1997,9 @@
<tr>
<td><code>stream_id</code></td>
<td class="doc-param-details">
- <p>The id of this data stream.</p>
+ <div class="doc-md-description">
+ <p>The id of this data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2010,7 +2028,9 @@
<code>data_stream</code>
</td>
<td class="doc-returns-details">
- <p>The created data stream</p>
+ <div class="doc-md-description">
+ <p>The created data stream</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/functions/utils/function_context/index.html b/docs-python/dev/reference/functions/utils/function_context/index.html
index 8f727201..89943bd6 100644
--- a/docs-python/dev/reference/functions/utils/function_context/index.html
+++ b/docs-python/dev/reference/functions/utils/function_context/index.html
@@ -1870,7 +1870,9 @@
<tr>
<td><code>function_id</code></td>
<td class="doc-param-details">
- <p>The id of this function.</p>
+ <div class="doc-md-description">
+ <p>The id of this function.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1882,7 +1884,9 @@
<tr>
<td><code>schema</code></td>
<td class="doc-param-details">
- <p>A dictionary which contains the schema of a data stream for each stream id.</p>
+ <div class="doc-md-description">
+ <p>A dictionary which contains the schema of a data stream for each stream id.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1894,7 +1898,9 @@
<tr>
<td><code>client</code></td>
<td class="doc-param-details">
- <p>The client to interact with the API.</p>
+ <div class="doc-md-description">
+ <p>The client to interact with the API.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1906,7 +1912,9 @@
<tr>
<td><code>streams</code></td>
<td class="doc-param-details">
- <p>The ids of the streams needed by this function.</p>
+ <div class="doc-md-description">
+ <p>The ids of the streams needed by this function.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1957,7 +1965,9 @@
<tr>
<td><code>stream_id</code></td>
<td class="doc-param-details">
- <p>The id of the data stream.</p>
+ <div class="doc-md-description">
+ <p>The id of the data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1969,7 +1979,9 @@
<tr>
<td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>The schema of the data stream.</p>
+ <div class="doc-md-description">
+ <p>The schema of the data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1996,7 +2008,9 @@
</span>
</td>
<td class="doc-returns-details">
-
+ <div class="doc-md-description">
+
+ </div>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/model/common/index.html b/docs-python/dev/reference/model/common/index.html
index 4a279b2b..54164a72 100644
--- a/docs-python/dev/reference/model/common/index.html
+++ b/docs-python/dev/reference/model/common/index.html
@@ -2557,7 +2557,9 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
<tr>
<td><code>n</code></td>
<td class="doc-param-details">
- <p>number of letters</p>
+ <div class="doc-md-description">
+ <p>number of letters</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2582,7 +2584,9 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
<code>rand_str</code>
</td>
<td class="doc-returns-details">
- <p>String consisting of <code>n</code> random letters</p>
+ <div class="doc-md-description">
+ <p>String consisting of <code>n</code> random letters</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/model/container/resource_container/index.html b/docs-python/dev/reference/model/container/resource_container/index.html
index b5bb8b72..fd62ab3b 100644
--- a/docs-python/dev/reference/model/container/resource_container/index.html
+++ b/docs-python/dev/reference/model/container/resource_container/index.html
@@ -1950,7 +1950,9 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
<tr>
<td><code>resources</code></td>
<td class="doc-param-details">
- <p>A list of resources to be contained in the <code>ResourceContainer</code>.</p>
+ <div class="doc-md-description">
+ <p>A list of resources to be contained in the <code>ResourceContainer</code>.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2005,7 +2007,9 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
<tr>
<td><code>json_string</code></td>
<td class="doc-param-details">
- <p>The JSON string returned from the StreamPipes API.</p>
+ <div class="doc-md-description">
+ <p>The JSON string returned from the StreamPipes API.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2030,7 +2034,9 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
<code>container</code>
</td>
<td class="doc-returns-details">
- <p>instance of the container derived from the JSON definition</p>
+ <div class="doc-md-description">
+ <p>instance of the container derived from the JSON definition</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2057,7 +2063,9 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
</span>
</td>
<td class="doc-raises-details">
- <p>If a resource cannot be mapped to the corresponding Python data model.</p>
+ <div class="doc-md-description">
+ <p>If a resource cannot be mapped to the corresponding Python data model.</p>
+ </div>
</td>
</tr>
<tr>
@@ -2067,7 +2075,9 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
</span>
</td>
<td class="doc-raises-details">
- <p>If JSON response cannot be parsed to a <code>ResourceContainer</code>.</p>
+ <div class="doc-md-description">
+ <p>If JSON response cannot be parsed to a <code>ResourceContainer</code>.</p>
+ </div>
</td>
</tr>
</tbody>
@@ -2102,8 +2112,10 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
<tr>
<td><code>use_source_names</code></td>
<td class="doc-param-details">
- <p>Determines whether the field names are named in Python style (=<code>False</code>) or
+ <div class="doc-md-description">
+ <p>Determines whether the field names are named in Python style (=<code>False</code>) or
as originally named by StreamPipes (=<code>True</code>).</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2132,8 +2144,10 @@ as originally named by StreamPipes (=<code>True</code>).</p>
<code>dictionary_list</code>
</td>
<td class="doc-returns-details">
- <p>List of resources in dictionary representation.
+ <div class="doc-md-description">
+ <p>List of resources in dictionary representation.
If <code>use_source_names</code> equals <code>True</code> the keys are named as in the StreamPipes backend.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2178,8 +2192,10 @@ If <code>use_source_names</code> equals <code>True</code> the keys are named as
</span>
</td>
<td class="doc-returns-details">
- <p>JSON representation of the resource container where key names are equal to
+ <div class="doc-md-description">
+ <p>JSON representation of the resource container where key names are equal to
keys used in the StreamPipes backend</p>
+ </div>
</td>
</tr>
</tbody>
@@ -2216,7 +2232,9 @@ keys used in the StreamPipes backend</p>
<code>resource_container_df</code>
</td>
<td class="doc-returns-details">
- <p>Representation of the resource container as pandas DataFrame</p>
+ <div class="doc-md-description">
+ <p>Representation of the resource container as pandas DataFrame</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2269,7 +2287,9 @@ during the parsing of StreamPipes API responses.</p>
<tr>
<td><code>validation_error</code></td>
<td class="doc-param-details">
- <p>The validation error thrown by Pydantic during parsing.</p>
+ <div class="doc-md-description">
+ <p>The validation error thrown by Pydantic during parsing.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2332,7 +2352,9 @@ does not suit to the structure of resource container.</p>
<tr>
<td><code>container_name</code></td>
<td class="doc-param-details">
- <p>The class name of the resource container where the invalid data structure was detected.</p>
+ <div class="doc-md-description">
+ <p>The class name of the resource container where the invalid data structure was detected.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2344,7 +2366,9 @@ does not suit to the structure of resource container.</p>
<tr>
<td><code>json_string</code></td>
<td class="doc-param-details">
- <p>The JSON string that has been tried to parse.</p>
+ <div class="doc-md-description">
+ <p>The JSON string that has been tried to parse.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/model/container/versions/index.html b/docs-python/dev/reference/model/container/versions/index.html
index 077dc531..d1c05029 100644
--- a/docs-python/dev/reference/model/container/versions/index.html
+++ b/docs-python/dev/reference/model/container/versions/index.html
@@ -1852,7 +1852,9 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
<tr>
<td><code>resources</code></td>
<td class="doc-param-details">
- <p>A list of resources (<a class="autorefs autorefs-internal" href="../../resource/version/#streampipes.model.resource.version.Version">Version</a>) to be contained in the <code>ResourceContainer</code>.</p>
+ <div class="doc-md-description">
+ <p>A list of resources (<a class="autorefs autorefs-internal" href="../../resource/version/#streampipes.model.resource.version.Version">Version</a>) to be contained in the <code>ResourceContainer</code>.</p>
+ </div>
<p>
</p>
</td>
diff --git a/docs-python/dev/reference/model/resource/data_lake_measure/index.html b/docs-python/dev/reference/model/resource/data_lake_measure/index.html
index 2baf65fd..82287aa7 100644
--- a/docs-python/dev/reference/model/resource/data_lake_measure/index.html
+++ b/docs-python/dev/reference/model/resource/data_lake_measure/index.html
@@ -1911,8 +1911,10 @@ is returned with the column name <code>num_event_properties</code>.</p>
<code>pandas_repr</code>
</td>
<td class="doc-returns-details">
- <p>Pandas representation of the resource as a dictionary, which is then used by the respource container
+ <div class="doc-md-description">
+ <p>Pandas representation of the resource as a dictionary, which is then used by the respource container
to create a data frame from a collection of resources.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/model/resource/data_series/index.html b/docs-python/dev/reference/model/resource/data_series/index.html
index cd7b3a14..dc9b22b3 100644
--- a/docs-python/dev/reference/model/resource/data_series/index.html
+++ b/docs-python/dev/reference/model/resource/data_series/index.html
@@ -1941,7 +1941,9 @@ to be used when creating a pandas Dataframe.</p>
<code>pandas_repr</code>
</td>
<td class="doc-returns-details">
- <p>Dictionary with the keys <code>headers</code> and <code>rows</code></p>
+ <div class="doc-md-description">
+ <p>Dictionary with the keys <code>headers</code> and <code>rows</code></p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -1989,7 +1991,9 @@ Currently, it only supports data lake series that consist of exactly one series
<tr>
<td><code>json_string</code></td>
<td class="doc-param-details">
- <p>The JSON string the data lake series should be created on.</p>
+ <div class="doc-md-description">
+ <p>The JSON string the data lake series should be created on.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2016,7 +2020,9 @@ Currently, it only supports data lake series that consist of exactly one series
</span>
</td>
<td class="doc-returns-details">
- <p>Instance of <code>DataSeries</code> that is created based on the given JSON string.</p>
+ <div class="doc-md-description">
+ <p>Instance of <code>DataSeries</code> that is created based on the given JSON string.</p>
+ </div>
</td>
</tr>
</tbody>
@@ -2037,8 +2043,10 @@ Currently, it only supports data lake series that consist of exactly one series
</span>
</td>
<td class="doc-raises-details">
- <p>If the data lake series returned by the StreamPipes API cannot be parsed
+ <div class="doc-md-description">
+ <p>If the data lake series returned by the StreamPipes API cannot be parsed
with the current version of the Python client.</p>
+ </div>
</td>
</tr>
</tbody>
@@ -2075,7 +2083,9 @@ with the current version of the Python client.</p>
<code>pd</code>
</td>
<td class="doc-returns-details">
- <p>The data lake series in form of a pandas dataframe</p>
+ <div class="doc-md-description">
+ <p>The data lake series in form of a pandas dataframe</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/model/resource/data_stream/index.html b/docs-python/dev/reference/model/resource/data_stream/index.html
index 236a3700..f42588dd 100644
--- a/docs-python/dev/reference/model/resource/data_stream/index.html
+++ b/docs-python/dev/reference/model/resource/data_stream/index.html
@@ -1920,8 +1920,10 @@ the Python representation (both serialized and deserialized) and Java representa
<code>pandas_repr</code>
</td>
<td class="doc-returns-details">
- <p>Pandas representation of the resource as a dictionary, which is then used by the respource container
+ <div class="doc-md-description">
+ <p>Pandas representation of the resource as a dictionary, which is then used by the respource container
to create a data frame from a collection of resources.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -1962,8 +1964,10 @@ to create a data frame from a collection of resources.</p>
<tr>
<td><code>use_source_names</code></td>
<td class="doc-param-details">
- <p>Indicates if the dictionary keys are in python representation or
+ <div class="doc-md-description">
+ <p>Indicates if the dictionary keys are in python representation or
equally named to the StreamPipes backend</p>
+ </div>
<p>
<span class="doc-param-default">
<b>DEFAULT:</b>
@@ -1988,7 +1992,9 @@ equally named to the StreamPipes backend</p>
<code>resource</code>
</td>
<td class="doc-returns-details">
- <p>The resource as dictionary representation</p>
+ <div class="doc-md-description">
+ <p>The resource as dictionary representation</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/model/resource/function_definition/index.html b/docs-python/dev/reference/model/resource/function_definition/index.html
index 265cda58..f9d7f060 100644
--- a/docs-python/dev/reference/model/resource/function_definition/index.html
+++ b/docs-python/dev/reference/model/resource/function_definition/index.html
@@ -1931,7 +1931,9 @@ It contains all metadata that are required to register a function at the StreamP
<tr>
<td><code>consumed_streams</code></td>
<td class="doc-param-details">
- <p>List of data streams the function is consuming from</p>
+ <div class="doc-md-description">
+ <p>List of data streams the function is consuming from</p>
+ </div>
<p>
</p>
</td>
@@ -1939,7 +1941,9 @@ It contains all metadata that are required to register a function at the StreamP
<tr>
<td><code>function_id</code></td>
<td class="doc-param-details">
- <p>identifier object of a StreamPipes function</p>
+ <div class="doc-md-description">
+ <p>identifier object of a StreamPipes function</p>
+ </div>
<p>
</p>
</td>
@@ -1958,7 +1962,9 @@ It contains all metadata that are required to register a function at the StreamP
<tr>
<td><code>output_data_streams</code></td>
<td class="doc-attribute-details">
- <p>Map off all output data streams added to the function definition</p>
+ <div class="doc-md-description">
+ <p>Map off all output data streams added to the function definition</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
@@ -2009,7 +2015,9 @@ It contains all metadata that are required to register a function at the StreamP
<tr>
<td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>The schema of the output data stream.</p>
+ <div class="doc-md-description">
+ <p>The schema of the output data stream.</p>
+ </div>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2034,7 +2042,9 @@ It contains all metadata that are required to register a function at the StreamP
<code>self</code>
</td>
<td class="doc-returns-details">
- <p>Instance of the function definition that is extended by the provided <code>DataStream</code></p>
+ <div class="doc-md-description">
+ <p>Instance of the function definition that is extended by the provided <code>DataStream</code></p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2078,8 +2088,10 @@ to be used when creating a pandas Dataframe.</p>
<code>pandas_repr</code>
</td>
<td class="doc-returns-details">
- <p>Pandas representation of the resource as a dictionary, which is then used by the respource container
+ <div class="doc-md-description">
+ <p>Pandas representation of the resource as a dictionary, which is then used by the respource container
to create a data frame from a collection of resources.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2122,7 +2134,9 @@ to create a data frame from a collection of resources.</p>
<code>output_streams</code>
</td>
<td class="doc-returns-details">
- <p>Dictionary with every known stream id and the related output stream.</p>
+ <div class="doc-md-description">
+ <p>Dictionary with every known stream id and the related output stream.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2165,7 +2179,9 @@ to create a data frame from a collection of resources.</p>
<code>output_stream_ids</code>
</td>
<td class="doc-returns-details">
- <p>List of all stream ids</p>
+ <div class="doc-md-description">
+ <p>List of all stream ids</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -2219,7 +2235,9 @@ to create a data frame from a collection of resources.</p>
<tr>
<td><code>id</code></td>
<td class="doc-param-details">
- <p>unique identifier of the function instance</p>
+ <div class="doc-md-description">
+ <p>unique identifier of the function instance</p>
+ </div>
<p>
</p>
</td>
@@ -2227,7 +2245,9 @@ to create a data frame from a collection of resources.</p>
<tr>
<td><code>version</code></td>
<td class="doc-param-details">
- <p>version of the corresponding function</p>
+ <div class="doc-md-description">
+ <p>version of the corresponding function</p>
+ </div>
<p>
</p>
</td>
diff --git a/docs-python/dev/reference/model/resource/query_result/index.html b/docs-python/dev/reference/model/resource/query_result/index.html
index a10c40e2..193cbfc2 100644
--- a/docs-python/dev/reference/model/resource/query_result/index.html
+++ b/docs-python/dev/reference/model/resource/query_result/index.html
@@ -1925,7 +1925,9 @@ to be used when creating a pandas Dataframe.</p>
</span>
</td>
<td class="doc-returns-details">
- <p>Dictionary with the keys <code>headers</code> and <code>rows</code></p>
+ <div class="doc-md-description">
+ <p>Dictionary with the keys <code>headers</code> and <code>rows</code></p>
+ </div>
</td>
</tr>
</tbody>
@@ -1946,7 +1948,9 @@ to be used when creating a pandas Dataframe.</p>
</span>
</td>
<td class="doc-raises-details">
- <p>If the query result returned by the StreamPipes API cannot be converted to the pandas representation</p>
+ <div class="doc-md-description">
+ <p>If the query result returned by the StreamPipes API cannot be converted to the pandas representation</p>
+ </div>
</td>
</tr>
</tbody>
@@ -1983,7 +1987,9 @@ to be used when creating a pandas Dataframe.</p>
<code>df</code>
</td>
<td class="doc-returns-details">
- <p>Pandas df containing the query result</p>
+ <div class="doc-md-description">
+ <p>Pandas df containing the query result</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/model/resource/resource/index.html b/docs-python/dev/reference/model/resource/resource/index.html
index b9bb9bbd..53a4d615 100644
--- a/docs-python/dev/reference/model/resource/resource/index.html
+++ b/docs-python/dev/reference/model/resource/resource/index.html
@@ -1928,8 +1928,10 @@ the Python representation (both serialized and deserialized) and Java representa
<code>pandas_repr</code>
</td>
<td class="doc-returns-details">
- <p>Pandas representation of the resource as a dictionary, which is then used by the respource container
+ <div class="doc-md-description">
+ <p>Pandas representation of the resource as a dictionary, which is then used by the respource container
to create a data frame from a collection of resources.</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
@@ -1970,8 +1972,10 @@ to create a data frame from a collection of resources.</p>
<tr>
<td><code>use_source_names</code></td>
<td class="doc-param-details">
- <p>Indicates if the dictionary keys are in python representation or
+ <div class="doc-md-description">
+ <p>Indicates if the dictionary keys are in python representation or
equally named to the StreamPipes backend</p>
+ </div>
<p>
<span class="doc-param-default">
<b>DEFAULT:</b>
@@ -1996,7 +2000,9 @@ equally named to the StreamPipes backend</p>
<code>resource</code>
</td>
<td class="doc-returns-details">
- <p>The resource as dictionary representation</p>
+ <div class="doc-md-description">
+ <p>The resource as dictionary representation</p>
+ </div>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/reference/model/resource/version/index.html b/docs-python/dev/reference/model/resource/version/index.html
index 458240d8..ffa23bf2 100644
--- a/docs-python/dev/reference/model/resource/version/index.html
+++ b/docs-python/dev/reference/model/resource/version/index.html
@@ -1871,7 +1871,9 @@
<tr>
<td><code>backend_version</code></td>
<td class="doc-attribute-details">
- <p>version of the StreamPipes backend the client is connected to</p>
+ <div class="doc-md-description">
+ <p>version of the StreamPipes backend the client is connected to</p>
+ </div>
<p>
<span class="doc-attribute-annotation">
<b>TYPE:</b>
diff --git a/docs-python/dev/scripts/gen_ref_pages/index.html b/docs-python/dev/scripts/gen_ref_pages/index.html
index c7b54d00..1c3e229f 100644
--- a/docs-python/dev/scripts/gen_ref_pages/index.html
+++ b/docs-python/dev/scripts/gen_ref_pages/index.html
@@ -2749,7 +2749,7 @@ Licensed under the Apache License, Version 2.0.
init_mathjax();
</script>
<!-- End of mathjax configuration --><div class="jupyter-wrapper">
-<div id="cell-id=88f58321" class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
+<div id="cell-id=d65971a8" class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2772,7 +2772,7 @@ limitations under the License.</p>
</div>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
-<div id="cell-id=8af5bf9c" class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
+<div id="cell-id=73c68d6e" class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2804,7 +2804,7 @@ limitations under the License.</p>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
-<div id="cell-id=738f35d7" class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
+<div id="cell-id=2a357f0e" class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2836,7 +2836,7 @@ limitations under the License.</p>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
-<div id="cell-id=3a9fee5b" class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
+<div id="cell-id=efabc935" class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2868,7 +2868,7 @@ limitations under the License.</p>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
-<div id="cell-id=e542ffd4" class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
+<div id="cell-id=d680dca5" class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2946,7 +2946,7 @@ limitations under the License.</p>
</div>
</div>
-<div id="cell-id=e1e7dfa9" class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
+<div id="cell-id=78ca277f" class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
diff --git a/docs-python/dev/search/search_index.json b/docs-python/dev/search/search_index.json
index 72342111..66b5cd0b 100644
--- a/docs-python/dev/search/search_index.json
+++ b/docs-python/dev/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"\ud83c\udfe1 Home","text":"StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect, analyze and explore IoT data streams. Apache StreamPipes for Python \ud83d\udc0d <p> Apache StreamPipes meets Python! We are working highly motivated on a Python library to interact with StreamPipes. In this way, we would like to unite the power of StreamP [...]
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"\ud83c\udfe1 Home","text":"StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect, analyze and explore IoT data streams. Apache StreamPipes for Python \ud83d\udc0d <p> Apache StreamPipes meets Python! We are working highly motivated on a Python library to interact with StreamPipes. In this way, we would like to unite the power of StreamP [...]
\ No newline at end of file
diff --git a/docs-python/dev/sitemap.xml b/docs-python/dev/sitemap.xml
index e6646af6..ee2a0346 100644
--- a/docs-python/dev/sitemap.xml
+++ b/docs-python/dev/sitemap.xml
@@ -2,242 +2,242 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/developing/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/first-steps/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/quickstart/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/client/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/config/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/credential_provider/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/endpoint/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/exceptions/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_lake_measure/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_stream/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/version/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/function_zoo/river_function/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/function_handler/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/registration/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/streampipes_function/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker_handler/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/consumer/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/publisher/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_consumer/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_message_fetcher/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_publisher/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_consumer/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_publisher/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/async_iter_handler/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/data_stream_context/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/data_stream_generator/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/function_context/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/common/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/data_lake_measures/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/data_streams/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/resource_container/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/versions/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_lake_measure/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_series/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_stream/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/exceptions/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/function_definition/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/query_result/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/resource/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/version/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/scripts/gen_ref_pages/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/1-introduction-to-streampipes-python-client/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/2-extracting-data-from-the-streampipes-data-lake/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/3-getting-live-data-from-the-streampipes-data-stream/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/</loc>
- <lastmod>2023-06-03</lastmod>
+ <lastmod>2023-06-10</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
\ No newline at end of file
diff --git a/docs-python/dev/sitemap.xml.gz b/docs-python/dev/sitemap.xml.gz
index c2fc3e69..64caaa2a 100644
Binary files a/docs-python/dev/sitemap.xml.gz and b/docs-python/dev/sitemap.xml.gz differ
[streampipes-website] 01/02: Bump fast-xml-parser and is-svg in /documentation/website (#87)
Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
commit 2afccbf5ff6bbfd0a94a658bc45a36bb741f892e
Author: dependabot[bot] <49...@users.noreply.github.com>
AuthorDate: Tue Jun 6 23:02:14 2023 +0200
Bump fast-xml-parser and is-svg in /documentation/website (#87)
---
documentation/website/package-lock.json | 64 ++++++++++++++++++++++-----------
1 file changed, 44 insertions(+), 20 deletions(-)
diff --git a/documentation/website/package-lock.json b/documentation/website/package-lock.json
index b1e046fe..e941e6a5 100644
--- a/documentation/website/package-lock.json
+++ b/documentation/website/package-lock.json
@@ -4976,16 +4976,25 @@
"dev": true
},
"node_modules/fast-xml-parser": {
- "version": "3.19.0",
- "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-3.19.0.tgz",
- "integrity": "sha512-4pXwmBplsCPv8FOY1WRakF970TjNGnGnfbOnLqjlYvMiF1SR3yOHyxMR/YCXpPTOspNF5gwudqktIP4VsWkvBg==",
+ "version": "4.2.4",
+ "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-4.2.4.tgz",
+ "integrity": "sha512-fbfMDvgBNIdDJLdLOwacjFAPYt67tr31H9ZhWSm45CDAxvd0I6WTlSOUo7K2P/K5sA5JgMKG64PI3DMcaFdWpQ==",
"dev": true,
- "bin": {
- "xml2js": "cli.js"
+ "funding": [
+ {
+ "type": "paypal",
+ "url": "https://paypal.me/naturalintelligence"
+ },
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/NaturalIntelligence"
+ }
+ ],
+ "dependencies": {
+ "strnum": "^1.0.5"
},
- "funding": {
- "type": "paypal",
- "url": "https://paypal.me/naturalintelligence"
+ "bin": {
+ "fxparser": "src/cli/cli.js"
}
},
"node_modules/fastq": {
@@ -6704,12 +6713,12 @@
"dev": true
},
"node_modules/is-svg": {
- "version": "4.3.1",
- "resolved": "https://registry.npmjs.org/is-svg/-/is-svg-4.3.1.tgz",
- "integrity": "sha512-h2CGs+yPUyvkgTJQS9cJzo9lYK06WgRiXUqBBHtglSzVKAuH4/oWsqk7LGfbSa1hGk9QcZ0SyQtVggvBA8LZXA==",
+ "version": "4.4.0",
+ "resolved": "https://registry.npmjs.org/is-svg/-/is-svg-4.4.0.tgz",
+ "integrity": "sha512-v+AgVwiK5DsGtT9ng+m4mClp6zDAmwrW8nZi6Gg15qzvBnRWWdfWA1TGaXyCDnWq5g5asofIgMVl3PjKxvk1ug==",
"dev": true,
"dependencies": {
- "fast-xml-parser": "^3.19.0"
+ "fast-xml-parser": "^4.1.3"
},
"engines": {
"node": ">=6"
@@ -10988,6 +10997,12 @@
"node": ">=0.8.0"
}
},
+ "node_modules/strnum": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/strnum/-/strnum-1.0.5.tgz",
+ "integrity": "sha512-J8bbNyKKXl5qYcR36TIO8W3mVGVHrmmxsd5PAItGkmyzwJvybiw2IVq5nqd0i4LSNSkB/sx9VHllbfFdr9k1JA==",
+ "dev": true
+ },
"node_modules/stylehacks": {
"version": "4.0.3",
"resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-4.0.3.tgz",
@@ -15951,10 +15966,13 @@
"dev": true
},
"fast-xml-parser": {
- "version": "3.19.0",
- "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-3.19.0.tgz",
- "integrity": "sha512-4pXwmBplsCPv8FOY1WRakF970TjNGnGnfbOnLqjlYvMiF1SR3yOHyxMR/YCXpPTOspNF5gwudqktIP4VsWkvBg==",
- "dev": true
+ "version": "4.2.4",
+ "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-4.2.4.tgz",
+ "integrity": "sha512-fbfMDvgBNIdDJLdLOwacjFAPYt67tr31H9ZhWSm45CDAxvd0I6WTlSOUo7K2P/K5sA5JgMKG64PI3DMcaFdWpQ==",
+ "dev": true,
+ "requires": {
+ "strnum": "^1.0.5"
+ }
},
"fastq": {
"version": "1.11.0",
@@ -17267,12 +17285,12 @@
"dev": true
},
"is-svg": {
- "version": "4.3.1",
- "resolved": "https://registry.npmjs.org/is-svg/-/is-svg-4.3.1.tgz",
- "integrity": "sha512-h2CGs+yPUyvkgTJQS9cJzo9lYK06WgRiXUqBBHtglSzVKAuH4/oWsqk7LGfbSa1hGk9QcZ0SyQtVggvBA8LZXA==",
+ "version": "4.4.0",
+ "resolved": "https://registry.npmjs.org/is-svg/-/is-svg-4.4.0.tgz",
+ "integrity": "sha512-v+AgVwiK5DsGtT9ng+m4mClp6zDAmwrW8nZi6Gg15qzvBnRWWdfWA1TGaXyCDnWq5g5asofIgMVl3PjKxvk1ug==",
"dev": true,
"requires": {
- "fast-xml-parser": "^3.19.0"
+ "fast-xml-parser": "^4.1.3"
}
},
"is-symbol": {
@@ -20735,6 +20753,12 @@
}
}
},
+ "strnum": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/strnum/-/strnum-1.0.5.tgz",
+ "integrity": "sha512-J8bbNyKKXl5qYcR36TIO8W3mVGVHrmmxsd5PAItGkmyzwJvybiw2IVq5nqd0i4LSNSkB/sx9VHllbfFdr9k1JA==",
+ "dev": true
+ },
"stylehacks": {
"version": "4.0.3",
"resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-4.0.3.tgz",