Skip to content

Commit b213926

Browse files
Update documentation (#904)
Co-authored-by: daniil-quix <[email protected]>
1 parent 70cd62c commit b213926

File tree

3 files changed

+110
-45
lines changed

3 files changed

+110
-45
lines changed

docs/api-reference/application.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
class Application()
1111
```
1212

13-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L94)
13+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L86)
1414

1515
The main Application class.
1616

@@ -61,6 +61,7 @@ app.run()
6161
def __init__(broker_address: Optional[Union[str, ConnectionConfig]] = None,
6262
*,
6363
quix_sdk_token: Optional[str] = None,
64+
quix_portal_api: Optional[str] = None,
6465
consumer_group: Optional[str] = None,
6566
auto_offset_reset: AutoOffsetReset = "latest",
6667
commit_interval: float = 5.0,
@@ -86,7 +87,7 @@ def __init__(broker_address: Optional[Union[str, ConnectionConfig]] = None,
8687
max_partition_buffer_size: int = 10000)
8788
```
8889

89-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L132)
90+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L124)
9091

9192

9293
<br>
@@ -105,6 +106,11 @@ Either this OR `broker_address` must be set to use Application (not both).
105106
Linked Environment Variable: `Quix__Sdk__Token`.
106107
Default: None (if not run on Quix Cloud)
107108
>***NOTE:*** the environment variable is set for you in the Quix Cloud
109+
- `quix_portal_api`: If using the Quix Cloud, the cluster API URL to use.
110+
Use it to connect to the dedicated Quix Cloud environment.
111+
Linked Environment Variable: `Quix__Portal__Api`.
112+
Default: `https://portal-api.platform.quix.io/`.
113+
>***NOTE:*** the environment variable is set for you in the Quix Cloud
108114
- `consumer_group`: Kafka consumer group.
109115
Passed as `group.id` to `confluent_kafka.Consumer`.
110116
Linked Environment Variable: `Quix__Consumer_Group`.

0 commit comments

Comments
 (0)