Skip to content

Commit

Permalink
Update documentation (#690)
Browse files Browse the repository at this point in the history 
Co-authored-by: daniil-quix <[email protected]>
  • Loading branch information
@github-actions @daniil-quix
github-actions[bot] and daniil-quix authored Dec 19, 2024
1 parent 51dfe04 commit c549aca
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions docs/api-reference/quixstreams.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,9 @@ def __init__(quix_sdk_token: Optional[str] = None,

```python
@classmethod
def convert_topic_response(cls, api_response: dict) -> Topic
def convert_topic_response(cls,
api_response: dict,
extra_config: Optional[dict] = None) -> Topic
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L178)
Expand All @@ -176,7 +178,7 @@ a corresponding Topic object
def strip_workspace_id_prefix(s: str) -> str
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L206)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L210)

Remove the workspace ID from a given string if it starts with it.

Expand All @@ -198,7 +200,7 @@ the string with workspace_id prefix removed
def prepend_workspace_id(s: str) -> str
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L217)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L221)

Add the workspace ID as a prefix to a given string if it does not have it.

Expand All @@ -221,7 +223,7 @@ def search_for_workspace(workspace_name_or_id: Optional[str] = None,
timeout: Optional[float] = None) -> Optional[dict]
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L228)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L232)

Search for a workspace given an expected workspace name or id.

Expand All @@ -243,7 +245,7 @@ def get_workspace_info(known_workspace_topic: Optional[str] = None,
timeout: Optional[float] = None) -> dict
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L270)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L275)

Queries for workspace data from the Quix API, regardless of instance cache,

Expand All @@ -265,7 +267,7 @@ def search_workspace_for_topic(
timeout: Optional[float] = None) -> Optional[str]
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L298)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L305)

Search through all the topics in the given workspace id to see if there is a

Expand All @@ -291,7 +293,7 @@ def search_for_topic_workspace(topic: str,
) -> Optional[dict]
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L319)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L328)

Find what workspace a topic belongs to.

Expand All @@ -315,7 +317,7 @@ workspace data dict if topic search success, else None
def create_topic(topic: Topic, timeout: Optional[float] = None)
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L348)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L359)

The actual API call to create the topic.

Expand All @@ -332,7 +334,7 @@ The actual API call to create the topic.
def get_or_create_topic(topic: Topic, timeout: Optional[float] = None) -> dict
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L378)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L391)

Get or create topics in a Quix cluster as part of initializing the Topic

Expand All @@ -354,7 +356,7 @@ def wait_for_topic_ready_statuses(topics: List[Topic],
finalize_timeout: Optional[float] = None)
```

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

After the broker acknowledges topics for creation, they will be in a

Expand All @@ -377,7 +379,7 @@ marked as "Ready" (and thus ready to produce to/consume from).
def get_topic(topic_name: str, timeout: Optional[float] = None) -> dict
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L448)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L462)

return the topic ID (the actual cluster topic name) if it exists, else raise

Expand All @@ -402,7 +404,7 @@ response dict of the topic info if topic found, else None
def get_application_config(consumer_group_id: str) -> QuixApplicationConfig
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L480)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/config.py#L494)

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

Expand Down Expand Up @@ -598,7 +600,7 @@ def get_workspace_certificate(workspace_id: Optional[str] = None,
timeout: float = 30) -> Optional[bytes]
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/api.py#L119)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/platforms/quix/api.py#L120)

Get a workspace TLS certificate if available.

Expand Down

0 comments on commit c549aca

Please sign in to comment.