Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion activitysmith_openapi/docs/ContentStateStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Start payload requires title and type. For segmented_progress include number_of_

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**title** | **str** | Title shown on the Live Activity. Send an empty string to show no title. |
**subtitle** | **str** | | [optional]
**number_of_steps** | **int** | Total number of steps. Use for type=segmented_progress. This value can be increased or decreased later when updating or ending the same activity. | [optional]
**current_step** | **int** | Current completed step count. Use for type=segmented_progress. Set 0 when the activity has started but no segment is complete yet. Must be less than or equal to number_of_steps. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/docs/ContentStateUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Update payload requires title. For segmented_progress include current_step and o

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**title** | **str** | Title shown on the Live Activity. Send an empty string to show no title. |
**subtitle** | **str** | | [optional]
**number_of_steps** | **int** | Total number of steps. Use for type=segmented_progress. Optional on update, and safe to change if the workflow gains or loses steps. | [optional]
**current_step** | **int** | Current completed step count. Use for type=segmented_progress. Set 0 when no segment is complete yet. Must be less than or equal to number_of_steps when number_of_steps is provided. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/docs/StreamContentState.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Current state for a managed Live Activity stream. Include type on the first PUT,

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**title** | **str** | Title shown on the Live Activity. Send an empty string to show no title. |
**subtitle** | **str** | | [optional]
**number_of_steps** | **int** | Use for segmented_progress. | [optional]
**current_step** | **int** | Use for segmented_progress. Set 0 when no segment is complete yet. Must be less than or equal to number_of_steps when number_of_steps is provided. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/models/content_state_start.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class ContentStateStart(BaseModel):
"""
Start payload requires title and type. For segmented_progress include number_of_steps and current_step. For progress include percentage or value with upper_limit. For metrics and stats include a non-empty metrics array. For value include a string or number in value; strings preserve currency, units, and other formatting. For alert include message. For timer include duration_seconds for countdowns, or set counts_down false without duration_seconds for an open-ended elapsed timer. Optional icon is supported by all Live Activity types. Optional badge is supported by alert, progress, segmented_progress, and value. For segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
""" # noqa: E501
title: StrictStr
title: StrictStr = Field(description="Title shown on the Live Activity. Send an empty string to show no title.")
subtitle: Optional[StrictStr] = None
number_of_steps: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Total number of steps. Use for type=segmented_progress. This value can be increased or decreased later when updating or ending the same activity.")
current_step: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Current completed step count. Use for type=segmented_progress. Set 0 when the activity has started but no segment is complete yet. Must be less than or equal to number_of_steps.")
Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/models/content_state_update.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class ContentStateUpdate(BaseModel):
"""
Update payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics and stats include a non-empty metrics array. For value include a string or number in value; strings preserve currency, units, and other formatting. For alert include message. For timer, omit duration_seconds to preserve the current timer window or send duration_seconds to reset the timer from the update request time. Optional icon is supported by all Live Activity types. Optional badge is supported by alert, progress, segmented_progress, and value. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
""" # noqa: E501
title: StrictStr
title: StrictStr = Field(description="Title shown on the Live Activity. Send an empty string to show no title.")
subtitle: Optional[StrictStr] = None
number_of_steps: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Total number of steps. Use for type=segmented_progress. Optional on update, and safe to change if the workflow gains or loses steps.")
current_step: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Current completed step count. Use for type=segmented_progress. Set 0 when no segment is complete yet. Must be less than or equal to number_of_steps when number_of_steps is provided.")
Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/models/stream_content_state.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class StreamContentState(BaseModel):
"""
Current state for a managed Live Activity stream. Include type on the first PUT, and whenever the stream may need to start a fresh activity. Supports segmented_progress, progress, metrics, stats, alert, timer, and value types. For timer, send duration_seconds to start or reset a bounded timer; omit duration_seconds on later updates to preserve the existing timer window.
""" # noqa: E501
title: StrictStr
title: StrictStr = Field(description="Title shown on the Live Activity. Send an empty string to show no title.")
subtitle: Optional[StrictStr] = None
number_of_steps: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Use for segmented_progress.")
current_step: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Use for segmented_progress. Set 0 when no segment is complete yet. Must be less than or equal to number_of_steps when number_of_steps is provided.")
Expand Down
4 changes: 2 additions & 2 deletions activitysmith_openapi/openapi-source.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"repository": "ActivitySmithHQ/activitysmith-backend",
"commit": "15ba559268fc8a9faa46ac73ed6c5fdc96f7e4f7",
"commit": "95c03a26e9a152c5370fbcfa0be781bc943023a6",
"path": "openapi.json",
"sha256": "1964b1e64ee810e2dd4cadb41916e59b836720b8607ef60c298e3f990aeb9cb8"
"sha256": "6d91e66c8f7fc1f438c00934e68949e6815b135deed4e6dc96fcec75373b37f9"
}
Loading