Skip to content

Commit

Permalink
docs: update parameter supported types (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
cheikhgwane authored Nov 22, 2023
1 parent eae6e18 commit b3b6740
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions openhexa/sdk/pipelines/parameter.py
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,17 @@ def parameter_spec(self):
def parameter(
code: str,
*,
type: typing.Union[typing.Type[str], typing.Type[int], typing.Type[bool], typing.Type[float]],
type: typing.Union[
typing.Type[str],
typing.Type[int],
typing.Type[bool],
typing.Type[float],
typing.Type[DHIS2Connection],
typing.Type[IASOConnection],
typing.Type[PostgreSQLConnection],
typing.Type[GCSConnection],
typing.Type[S3Connection],
],
name: typing.Optional[str] = None,
choices: typing.Optional[typing.Sequence] = None,
help: typing.Optional[str] = None,
Expand All @@ -417,7 +427,7 @@ def parameter(
----------
code : str
The parameter identifier (must be unique for a given pipeline)
type : {str, int, bool, float}
type : {str, int, bool, float, DHIS2Connection, IASOConnection, PostgreSQLConnection, GCSConnection, S3Connection}
The parameter Python type
name : str, optional
A name for the parameter (will be used instead of the code in the web interface)
Expand Down

0 comments on commit b3b6740

Please sign in to comment.