Merge branch 'dev'

apache · Aug 6, 2024 · 0ca2a56 · 0ca2a56
2 parents 0f85495 + 6e87bd7
commit 0ca2a56
Show file tree

Hide file tree

Showing 51 changed files with 226 additions and 105 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -18,7 +18,7 @@
 
 ## Contributing to StreamPipes
 
-*Before opening a pull request*, review the [Get Involved](https://streampipes.apache.org/getinvolved.html) page.
+*Before opening a pull request*, review the [Get Involved](https://streampipes.apache.org/community/get-involved/) page.
 It lists information that is required for contributing to StreamPipes.
 
 When you contribute code, you affirm that the contribution is your original work and that you

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-[![Github Actions](https://img.shields.io/github/workflow/status/apache/streampipes-website/Build%20and%20Deploy)](https://github.com/apache/streampipes-website/actions/)
+[![Github Actions](https://img.shields.io/github/actions/workflow/status/apache/streampipes-website/deploy-website.yml?label=Build%20and%20Deploy)](https://github.com/apache/streampipes-website/actions/)
 # Apache StreamPipes Website + Docs
 
 ## Intro
@@ -23,5 +23,5 @@ Node.js(at most v18) and npm are required to build the documentation.
 * First, build the website and documentation as explained above.
 * Copy the content from the `docs-python` to the ``website-v2/build`` folder into a subdirectory named ``python``.
 
-The deployment step is done automatically using the asf.yaml process. 
+The deployment step is done automatically using the asf.yaml process.
 Code must be merged into the `master` branch in order to trigger an update of the website.
diff --git a/docs-python/dev/reference/client/client/index.html b/docs-python/dev/reference/client/client/index.html
@@ -2810,7 +2810,7 @@ <h3 id="streampipes.client.client.StreamPipesClient.describe" class="doc doc-hea
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/client/config/index.html b/docs-python/dev/reference/client/config/index.html
@@ -2290,7 +2290,7 @@ <h1>Config</h1>
 
 
 <h2 id="streampipes.client.config.StreamPipesClientConfig" class="doc doc-heading">
-            <code class="highlight language-python"><span class="n">StreamPipesClientConfig</span><span class="p">(</span><span class="n">credential_provider</span><span class="p">,</span> <span class="n">host_address</span><span class="p">,</span> <span class="n">https_disabled</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">80</span><span class="p">)</span></code>
+            <code class="highlight language-python"><span class="n">StreamPipesClientConfig</span><span class="p">(</span><span class="n">credential_provider</span><span class="p">,</span> <span class="n">host_address</span><span class="p">,</span> <span class="n">https_disabled</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">80</span><span class="p">,</span> <span class="n">additional_headers</span><span class="o">=</span><span class="nb">dict</span><span class="p">())</span></code>
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
@@ -2381,6 +2381,24 @@ <h2 id="streampipes.client.config.StreamPipesClientConfig" class="doc doc-headin
             </p>
           </td>
         </tr>
+        <tr>
+          <td><code>additional_headers</code></td>
+          <td class="doc-param-details">
+            <div class="doc-md-description">
+              <p>Specifies additional HTTP headers that should be sent with each request, e.g., proxy headers</p>
+            </div>
+            <p>
+                <span class="doc-param-annotation">
+                  <b>TYPE:</b>
+                    <code><span title="typing.Optional">Optional</span>[<span title="typing.Dict">Dict</span>[str, str]]</code>
+                </span>
+                <span class="doc-param-default">
+                  <b>DEFAULT:</b> 
+                    <code>dict()</code>
+                </span>
+            </p>
+          </td>
+        </tr>
     </tbody>
   </table>
 
@@ -2425,7 +2443,7 @@ <h2 id="streampipes.client.config.StreamPipesClientConfig" class="doc doc-headin
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/client/credential_provider/index.html b/docs-python/dev/reference/client/credential_provider/index.html
@@ -2803,7 +2803,7 @@ <h3 id="streampipes.client.credential_provider.StreamPipesApiKeyCredentials.make
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -3089,7 +3089,7 @@ <h2 id="streampipes.endpoint.api.data_lake_measure.StreamPipesQueryValidationErr
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/endpoint/api/data_stream/index.html b/docs-python/dev/reference/endpoint/api/data_stream/index.html
@@ -2676,7 +2676,7 @@ <h3 id="streampipes.endpoint.api.data_stream.DataStreamEndpoint.post" class="doc
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/endpoint/api/version/index.html b/docs-python/dev/reference/endpoint/api/version/index.html
@@ -2696,7 +2696,7 @@ <h3 id="streampipes.endpoint.api.version.VersionEndpoint.post" class="doc doc-he
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/endpoint/endpoint/index.html b/docs-python/dev/reference/endpoint/endpoint/index.html
@@ -2983,7 +2983,7 @@ <h3 id="streampipes.endpoint.endpoint.MessagingEndpoint.configure" class="doc do
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/endpoint/exceptions/index.html b/docs-python/dev/reference/endpoint/exceptions/index.html
@@ -2367,7 +2367,7 @@ <h2 id="streampipes.endpoint.exceptions.MessagingEndpointNotConfiguredError" cla
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/function_zoo/river_function/index.html b/docs-python/dev/reference/function_zoo/river_function/index.html
@@ -3291,7 +3291,7 @@ <h3 id="streampipes.function_zoo.river_function.RiverFunction.stop" class="doc d
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/broker/broker/index.html b/docs-python/dev/reference/functions/broker/broker/index.html
@@ -2504,7 +2504,7 @@ <h3 id="streampipes.functions.broker.broker.Broker.disconnect" class="doc doc-he
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/broker/broker_handler/index.html b/docs-python/dev/reference/functions/broker/broker_handler/index.html
@@ -2620,7 +2620,7 @@ <h2 id="streampipes.functions.broker.broker_handler.get_broker_description" clas
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/broker/consumer/index.html b/docs-python/dev/reference/functions/broker/consumer/index.html
@@ -2570,7 +2570,7 @@ <h3 id="streampipes.functions.broker.consumer.Consumer.get_message" class="doc d
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2566,7 +2566,7 @@ <h3 id="streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.get_mess
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2439,7 +2439,7 @@ <h2 id="streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessageFet
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2593,7 +2593,7 @@ <h3 id="streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.publis
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2566,7 +2566,7 @@ <h3 id="streampipes.functions.broker.nats.nats_consumer.NatsConsumer.get_message
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2593,7 +2593,7 @@ <h3 id="streampipes.functions.broker.nats.nats_publisher.NatsPublisher.publish_e
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/broker/output_collector/index.html b/docs-python/dev/reference/functions/broker/output_collector/index.html
@@ -2546,7 +2546,7 @@ <h3 id="streampipes.functions.broker.output_collector.OutputCollector.disconnect
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/broker/publisher/index.html b/docs-python/dev/reference/functions/broker/publisher/index.html
@@ -2594,7 +2594,7 @@ <h3 id="streampipes.functions.broker.publisher.Publisher.publish_event" class="d
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/function_handler/index.html b/docs-python/dev/reference/functions/function_handler/index.html
@@ -2629,7 +2629,7 @@ <h3 id="streampipes.functions.function_handler.FunctionHandler.initializeFunctio
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/registration/index.html b/docs-python/dev/reference/functions/registration/index.html
@@ -2525,7 +2525,7 @@ <h3 id="streampipes.functions.registration.Registration.register" class="doc doc
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/streampipes_function/index.html b/docs-python/dev/reference/functions/streampipes_function/index.html
@@ -2919,7 +2919,7 @@ <h3 id="streampipes.functions.streampipes_function.StreamPipesFunction.stop" cla
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2551,7 +2551,7 @@ <h3 id="streampipes.functions.utils.async_iter_handler.AsyncIterHandler.combine_
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2488,7 +2488,7 @@ <h3 id="streampipes.functions.utils.data_stream_context.DataStreamContext.add_fu
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2475,7 +2475,7 @@ <h2 id="streampipes.functions.utils.data_stream_generator.create_data_stream" cl
             <p>
                 <span class="doc-param-annotation">
                   <b>TYPE:</b>
-                    <code><span title="typing.Optional">Optional</span>[str]</code>
+                    <code>str</code>
                 </span>
                 <span class="doc-param-default">
                   <b>DEFAULT:</b> 
@@ -2533,7 +2533,7 @@ <h2 id="streampipes.functions.utils.data_stream_generator.create_data_stream" cl
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/functions/utils/function_context/index.html b/docs-python/dev/reference/functions/utils/function_context/index.html
@@ -2516,7 +2516,7 @@ <h3 id="streampipes.functions.utils.function_context.FunctionContext.add_data_st
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/common/index.html b/docs-python/dev/reference/model/common/index.html
@@ -3802,7 +3802,7 @@ <h2 id="streampipes.model.common.random_letters" class="doc doc-heading">
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/container/data_lake_measures/index.html b/docs-python/dev/reference/model/container/data_lake_measures/index.html
@@ -2701,7 +2701,7 @@ <h3 id="streampipes.model.container.data_lake_measures.DataLakeMeasures.to_panda
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/container/data_streams/index.html b/docs-python/dev/reference/model/container/data_streams/index.html
@@ -2701,7 +2701,7 @@ <h3 id="streampipes.model.container.data_streams.DataStreams.to_pandas" class="d
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/container/resource_container/index.html b/docs-python/dev/reference/model/container/resource_container/index.html
@@ -2907,7 +2907,7 @@ <h2 id="streampipes.model.container.resource_container.StreamPipesResourceContai
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/container/versions/index.html b/docs-python/dev/reference/model/container/versions/index.html
@@ -2728,7 +2728,7 @@ <h3 id="streampipes.model.container.versions.Versions.to_pandas" class="doc doc-
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

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
@@ -2565,7 +2565,7 @@ <h3 id="streampipes.model.resource.data_lake_measure.DataLakeMeasure.to_dict" cl
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/resource/data_series/index.html b/docs-python/dev/reference/model/resource/data_series/index.html
@@ -2748,7 +2748,7 @@ <h3 id="streampipes.model.resource.data_series.DataSeries.to_pandas" class="doc
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/resource/data_stream/index.html b/docs-python/dev/reference/model/resource/data_stream/index.html
@@ -2560,7 +2560,7 @@ <h3 id="streampipes.model.resource.data_stream.DataStream.to_dict" class="doc do
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/resource/exceptions/index.html b/docs-python/dev/reference/model/resource/exceptions/index.html
@@ -2339,7 +2339,7 @@ <h2 id="streampipes.model.resource.exceptions.StreamPipesUnsupportedDataSeries"
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/resource/function_definition/index.html b/docs-python/dev/reference/model/resource/function_definition/index.html
@@ -2989,7 +2989,7 @@ <h3 id="streampipes.model.resource.function_definition.FunctionId.Config" class=
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>

diff --git a/docs-python/dev/reference/model/resource/query_result/index.html b/docs-python/dev/reference/model/resource/query_result/index.html
@@ -2645,7 +2645,7 @@ <h3 id="streampipes.model.resource.query_result.QueryResult.to_pandas" class="do
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 6, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 27, 2024</span>
 
 
   </small>