Skip to content

Commit dad57d4

Browse files
Update documentation (#534)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent 5965f46 commit dad57d4

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/api-reference/quixstreams.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,8 @@ workspace data dict if topic search success, else None
293293
```python
294294
def create_topics(topics: List[Topic],
295295
timeout: Optional[float] = None,
296-
finalize_timeout: Optional[float] = None)
296+
finalize_timeout: Optional[float] = None,
297+
prepend: bool = True)
297298
```
298299

299300
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L369)
@@ -306,6 +307,7 @@ Create topics in a Quix cluster.
306307
- `timeout`: response timeout (seconds); Default 30
307308
- `finalize_timeout`: topic finalization timeout (seconds); Default 60
308309
marked as "Ready" (and thus ready to produce to/consume from).
310+
- `prepend`: whether to prepend workspace_id during creation attempt.
309311

310312
<a id="quixstreams.platforms.quix.config.QuixKafkaConfigsBuilder.get_topic"></a>
311313

@@ -316,7 +318,7 @@ def get_topic(topic_name: str,
316318
timeout: Optional[float] = None) -> Optional[dict]
317319
```
318320

319-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L419)
321+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L421)
320322

321323
return the topic ID (the actual cluster topic name) if it exists, else None
322324

@@ -342,7 +344,7 @@ def confirm_topics_exist(topics: Union[List[Topic], List[str]],
342344
timeout: Optional[float] = None)
343345
```
344346

345-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L451)
347+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L453)
346348

347349
Confirm whether the desired set of topics exists in the Quix workspace.
348350

@@ -359,7 +361,7 @@ Confirm whether the desired set of topics exists in the Quix workspace.
359361
def get_application_config(consumer_group_id: str) -> QuixApplicationConfig
360362
```
361363

362-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L483)
364+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L485)
363365

364366
Get all the necessary attributes for an Application to run on Quix Cloud.
365367

0 commit comments

Comments
 (0)