structurizr.StructurizrClientSettings
Define the Structurizr client settings.
Attributes:
| Name | Type | Description |
|---|---|---|
url |
str |
The Structurizr API URL. |
workspace_id |
int |
The Structurizr workspace identifier. |
api_key |
str |
The Structurizr workspace API key. |
api_secret |
str |
The Structurizr workspace API secret. |
user |
str |
A string identifying the user (e.g. an e-mail address or username). |
agent |
str |
A string identifying the agent (e.g. 'structurizr-java/1.2.0'). |
workspace_archive_location |
pathlib.Path |
A directory for archiving downloaded workspaces. |
agent: str
pydantic-field
A string identifying the agent (e.g. 'structurizr-java/1.2.0').
api_key: UUID4
pydantic-field
required
The Structurizr workspace API key.
api_secret: UUID4
pydantic-field
required
The Structurizr workspace API secret.
url: HttpUrl
pydantic-field
The Structurizr API URL.
user: str
pydantic-field
A string identifying the user (e.g. an e-mail address or username).
workspace_archive_location: DirectoryPath
pydantic-field
A directory for archiving downloaded workspaces, or None to suppress archiving.
workspace_id: int
pydantic-field
required
The Structurizr workspace identifier.