This is an automated email from the ASF dual-hosted git repository. bossenti pushed a commit to branch rel/0.95.0 in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit 56f5728a03aae9e9df1a151e889fdd8509a2c79a Author: airwish <[email protected]> AuthorDate: Mon May 13 14:43:03 2024 +0800 fix: Fix client python docs site build warning (#2851) * fix client python docstrings warnings * fix client python docs site unrecognized relative link --- .../streampipes/client/credential_provider.py | 2 +- .../streampipes/model/resource/function_definition.py | 7 ++----- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/streampipes-client-python/streampipes/client/credential_provider.py b/streampipes-client-python/streampipes/client/credential_provider.py index 461088e8fc..d7493b40c2 100644 --- a/streampipes-client-python/streampipes/client/credential_provider.py +++ b/streampipes-client-python/streampipes/client/credential_provider.py @@ -81,7 +81,7 @@ class CredentialProvider(ABC): class StreamPipesApiKeyCredentials(CredentialProvider): """A credential provider that allows authentication via a StreamPipes API Token. - The required token can be generated via the StreamPipes UI (see the description on our [start-page](../../../). + The required token can be generated via the StreamPipes UI (see the description on our [start-page](../../index.md). Both parameters can either be passed as arguments or remain unset. If they are not passed, they are retrieved from environment variables: diff --git a/streampipes-client-python/streampipes/model/resource/function_definition.py b/streampipes-client-python/streampipes/model/resource/function_definition.py index 7917180797..b055f4fc3e 100644 --- a/streampipes-client-python/streampipes/model/resource/function_definition.py +++ b/streampipes-client-python/streampipes/model/resource/function_definition.py @@ -34,7 +34,7 @@ class FunctionId(BasicModel): Maps to the `FunctionId` class defined in the StreamPipes model. - Parameters + Attributes ---------- id: str unique identifier of the function instance @@ -56,15 +56,12 @@ class FunctionDefinition(Resource): This class maps to the `FunctionDefinition` class in the StreamPipes model. It contains all metadata that are required to register a function at the StreamPipes backend. - Parameters + Attributes ---------- consumed_streams: List[str] List of data streams the function is consuming from function_id: FunctionId identifier object of a StreamPipes function - - Attributes - ---------- output_data_streams: Dict[str, DataStream] Map off all output data streams added to the function definition
