devopness 2.5.0__tar.gz → 2.6.1__tar.gz

{devopness-2.5.0 → devopness-2.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devopness
-Version: 2.5.0
+Version: 2.6.1
 Summary: Devopness API Python SDK - Painless essential DevOps to everyone
 License-Expression: MIT
 Keywords: API Client,Cloud Engineering,Cloud Infrastructure,Cloud Platform,Cloud Resource Management,Configuration Management,Deployment Automation,Devopness,DevOps,Infrastructure as Code,Platform Engineering,Python SDK,Server Management,Server Provisioning,Zero Downtime Deployment

{devopness-2.5.0 → devopness-2.6.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "devopness"
-version = "2.5.0"
+version = "2.6.1"
 description = "Devopness API Python SDK - Painless essential DevOps to everyone"
 license = "MIT"
 readme = "README.md"
@@ -67,8 +67,8 @@ packages = [
 exclude = ["src/devopness/generated/.openapi-generator-ignore"]
 
 [tool.poetry.group.dev.dependencies]
-openapi-generator-cli = { version = "7.22.0", markers = "python_version < '4.0'" }
-ruff = "^0.15.16"
+openapi-generator-cli = { version = "7.23.0", markers = "python_version < '4.0'" }
+ruff = "^0.15.20"
 mypy = "^2.1.0"
 
 [tool.ruff]

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action.py

@@ -49,6 +49,7 @@ class Action(DevopnessBaseModel):
         type (ActionType):
         type_human_readable (str): Human readable version of the action type
         url_web_permalink (str): The permalink URL to the action details on Devopness web app
+        trigger_comment (str, optional, nullable): Optional comment attached to this action
         action_data (ActionData, optional, nullable):
         triggered_from (ActionTriggeredFrom):
         parent (RelatedAction, optional, nullable):
@@ -67,27 +68,44 @@ class Action(DevopnessBaseModel):
         updated_at (str): The date and time when the record was last updated
     """
 
-    id: StrictInt = Field(description="The Id of the given action")
+    id: StrictInt = Field(
+        description="The Id of the given action",
+        json_schema_extra={"examples": [567819876]},
+    )
     pipeline_id: StrictInt | None = Field(
-        description="The ID of the pipeline executed by this action"
+        description="The ID of the pipeline executed by this action",
+        json_schema_extra={"examples": [567819876]},
     )
     retry_of: StrictInt | None = Field(
-        description="The Id of the parent action that this action is a retry of"
+        description="The Id of the parent action that this action is a retry of",
+        json_schema_extra={"examples": [764123]},
     )
     status: ActionStatus
     status_human_readable: StrictStr = Field(
-        description="Human readable version of action status"
+        description="Human readable version of action status",
+        json_schema_extra={"examples": ["Pending"]},
     )
     status_reason_code: ActionStatusReasonCode
     status_reason_human_readable: StrictStr = Field(
-        description="Human readable version of the status reason code"
+        description="Human readable version of the status reason code",
+        json_schema_extra={
+            "examples": [
+                "Pending: Action created successfully but has not yet been queued for execution. It will be added to an execution queue once their dependencies are resolved."
+            ]
+        },
     )
     type: ActionType
     type_human_readable: StrictStr = Field(
-        description="Human readable version of the action type"
+        description="Human readable version of the action type",
+        json_schema_extra={"examples": ["Deploy"]},
     )
     url_web_permalink: StrictStr = Field(
-        description="The permalink URL to the action details on Devopness web app"
+        description="The permalink URL to the action details on Devopness web app",
+        json_schema_extra={"examples": ["https://devopness.com/actions/567819876"]},
+    )
+    trigger_comment: StrictStr | None = Field(
+        description="Optional comment attached to this action",
+        json_schema_extra={"examples": ["Triggered after a configuration update."]},
     )
     action_data: ActionData | None
     triggered_from: ActionTriggeredFrom
@@ -104,16 +122,20 @@ class Action(DevopnessBaseModel):
     )
     hook_requests: ActionHookRequest | None = None
     started_at: StrictStr | None = Field(
-        description="The date and time when the action started execution (i.e., left the `pending/queued` status)"
+        description="The date and time when the action started execution (i.e., left the `pending/queued` status)",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48.000000Z"]},
     )
     completed_at: StrictStr | None = Field(
-        description="The date and time when the action has finished execution"
+        description="The date and time when the action has finished execution",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04.000000Z"]},
     )
     created_at: StrictStr = Field(
-        description="The date and time when the record was created"
+        description="The date and time when the record was created",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48.000000Z"]},
     )
     updated_at: StrictStr = Field(
-        description="The date and time when the record was last updated"
+        description="The date and time when the record was last updated",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04.000000Z"]},
     )
 
 
@@ -147,6 +169,7 @@ class ActionPlain(TypedDict, total=False):
     ]
     type_human_readable: Required[str]
     url_web_permalink: Required[str]
+    trigger_comment: str | None
     action_data: Union[ActionData, ActionDataPlain] | None
     triggered_from: Required[
         Union[

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_data.py

@@ -36,7 +36,8 @@ class ActionData(DevopnessBaseModel):
     """
 
     release_name: StrictStr = Field(
-        description="The name generated to release created by this deployment"
+        description="The name generated to release created by this deployment",
+        json_schema_extra={"examples": ["2022-07-05-13-25-38"]},
     )
     commit: ActionDeploymentCommit
     deployment: ActionDeploymentContent

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_deployment_commit.py

@@ -34,21 +34,52 @@ class ActionDeploymentCommit(DevopnessBaseModel):
     """
 
     repository: StrictStr = Field(
-        description="The repository of the deployed application"
+        description="The repository of the deployed application",
+        json_schema_extra={"examples": ["devopness/example"]},
+    )
+    author_name: StrictStr = Field(
+        description="The author of the commit",
+        json_schema_extra={"examples": ["Author Name"]},
+    )
+    author_email: StrictStr = Field(
+        description="The commit author's email",
+        json_schema_extra={"examples": ["email@example.com"]},
     )
-    author_name: StrictStr = Field(description="The author of the commit")
-    author_email: StrictStr = Field(description="The commit author's email")
     committed_at: datetime = Field(
-        description="The date and time when the commit was created"
+        description="The date and time when the commit was created",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48Z"]},
+    )
+    hash: StrictStr = Field(
+        description="The commit hash used on deployment",
+        json_schema_extra={"examples": ["d433e4622fde4b59a48586ed94082e2d76e855c1"]},
+    )
+    message: StrictStr = Field(
+        description="The commit message",
+        json_schema_extra={"examples": ["fix: some bug"]},
+    )
+    url: StrictStr = Field(
+        description="The commit URL on the source provider",
+        json_schema_extra={
+            "examples": [
+                "https://source-provider.com/commit/d433e4622fde4b59a48586ed94082e2d76e855c1"
+            ]
+        },
     )
-    hash: StrictStr = Field(description="The commit hash used on deployment")
-    message: StrictStr = Field(description="The commit message")
-    url: StrictStr = Field(description="The commit URL on the source provider")
     clone_url: StrictStr = Field(
-        description="The URL to clone the repository on the specific commit"
+        description="The URL to clone the repository on the specific commit",
+        json_schema_extra={
+            "examples": [
+                "https://source-provider.com/commit/d433e4622fde4b59a48586ed94082e2d76e855c1.git"
+            ]
+        },
     )
     download_url: StrictStr = Field(
-        description="The URL to download the commit source code"
+        description="The URL to download the commit source code",
+        json_schema_extra={
+            "examples": [
+                "https://source-provider.com/commit/d433e4622fde4b59a48586ed94082e2d76e855c1.tar.gz"
+            ]
+        },
     )
 
 

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_deployment_content.py

@@ -35,13 +35,20 @@ class ActionDeploymentContent(DevopnessBaseModel):
     type: DeploymentType
     source_type: SourceType
     source_ref: StrictStr = Field(
-        description="A git reference pointing to a commit in a source provider repository from which the application source code will be retrieved and deployed. It can be a branch name, tag name or a specific commit hash."
+        description="A git reference pointing to a commit in a source provider repository from which the application source code will be retrieved and deployed. It can be a branch name, tag name or a specific commit hash.",
+        json_schema_extra={"examples": ["develop"]},
     )
     repository: StrictStr = Field(
-        description="The repository of the deployed application"
+        description="The repository of the deployed application",
+        json_schema_extra={"examples": ["devopness/example"]},
+    )
+    provider_name: StrictStr = Field(
+        description="The source provider's name",
+        json_schema_extra={"examples": ["github"]},
+    )
+    pipeline_id: StrictInt = Field(
+        description="The ID of the pipeline", json_schema_extra={"examples": [23439]}
     )
-    provider_name: StrictStr = Field(description="The source provider's name")
-    pipeline_id: StrictInt = Field(description="The ID of the pipeline")
 
 
 class ActionDeploymentContentPlain(TypedDict, total=False):

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_deployment_data.py

@@ -36,7 +36,8 @@ class ActionDeploymentData(DevopnessBaseModel):
     """
 
     release_name: StrictStr = Field(
-        description="The name generated to release created by this deployment"
+        description="The name generated to release created by this deployment",
+        json_schema_extra={"examples": ["2022-07-05-13-25-38"]},
     )
     commit: ActionDeploymentCommit
     deployment: ActionDeploymentContent

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_pipeline_create.py

@@ -23,6 +23,7 @@ class ActionPipelineCreate(DevopnessBaseModel):
 
     Attributes:
         servers (List[int], optional): List of valid resource IDs
+        trigger_comment (str, optional): Optional comment provided when triggering this action. Must not be greater than 255 characters. Must not be greater than 255 characters.
         source_type (SourceType, optional):
         source_ref (str, optional): A git reference pointing to a commit in a source provider repository from which the application source code will be retrieved and deployed. It can be a branch name, tag name or a specific commit hash. Must not be greater than 200 characters.
     """
@@ -30,10 +31,16 @@ class ActionPipelineCreate(DevopnessBaseModel):
     servers: list[StrictInt] | None = Field(
         default=None, description="List of valid resource IDs"
     )
+    trigger_comment: StrictStr | None = Field(
+        default=None,
+        description="Optional comment provided when triggering this action. Must not be greater than 255 characters. Must not be greater than 255 characters.",
+        json_schema_extra={"examples": ["Deploying a hotfix for production."]},
+    )
     source_type: SourceType | None = None
     source_ref: StrictStr | None = Field(
         default=None,
         description="A git reference pointing to a commit in a source provider repository from which the application source code will be retrieved and deployed. It can be a branch name, tag name or a specific commit hash. Must not be greater than 200 characters.",
+        json_schema_extra={"examples": ["main"]},
     )
 
 
@@ -43,5 +50,6 @@ class ActionPipelineCreatePlain(TypedDict, total=False):
     """
 
     servers: list[int] | None
+    trigger_comment: str | None
     source_type: Union[SourceType, SourceTypePlain] | None
     source_ref: str | None

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_relation.py

@@ -41,6 +41,7 @@ class ActionRelation(DevopnessBaseModel):
         type (ActionType):
         type_human_readable (str): Human readable version of the action type
         url_web_permalink (str): The permalink URL to the action details on Devopness web app
+        trigger_comment (str, optional, nullable): Optional comment attached to this action
         action_data (ActionData, optional, nullable):
         triggered_from (ActionTriggeredFrom):
         resource (ActionResource):
@@ -52,21 +53,36 @@ class ActionRelation(DevopnessBaseModel):
         updated_at (str): The date and time when the record was last updated
     """
 
-    id: StrictInt = Field(description="The Id of the given action")
+    id: StrictInt = Field(
+        description="The Id of the given action",
+        json_schema_extra={"examples": [567819876]},
+    )
     status: ActionStatus
     status_human_readable: StrictStr = Field(
-        description="Human readable version of action status"
+        description="Human readable version of action status",
+        json_schema_extra={"examples": ["Pending"]},
     )
     status_reason_code: ActionStatusReasonCode
     status_reason_human_readable: StrictStr = Field(
-        description="Human readable version of the status reason code"
+        description="Human readable version of the status reason code",
+        json_schema_extra={
+            "examples": [
+                "Pending: Action created successfully but has not yet been queued for execution. It will be added to an execution queue once their dependencies are resolved."
+            ]
+        },
     )
     type: ActionType
     type_human_readable: StrictStr = Field(
-        description="Human readable version of the action type"
+        description="Human readable version of the action type",
+        json_schema_extra={"examples": ["Deploy"]},
     )
     url_web_permalink: StrictStr = Field(
-        description="The permalink URL to the action details on Devopness web app"
+        description="The permalink URL to the action details on Devopness web app",
+        json_schema_extra={"examples": ["https://devopness.com/actions/567819876"]},
+    )
+    trigger_comment: StrictStr | None = Field(
+        description="Optional comment attached to this action",
+        json_schema_extra={"examples": ["Triggered after a configuration update."]},
     )
     action_data: ActionData | None = None
     triggered_from: ActionTriggeredFrom
@@ -76,16 +92,20 @@ class ActionRelation(DevopnessBaseModel):
         default=None, description="List of actions dispatched to cloud resource targets"
     )
     started_at: StrictStr | None = Field(
-        description="The date and time when the action started execution (i.e., left the `pending/queued` status)"
+        description="The date and time when the action started execution (i.e., left the `pending/queued` status)",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48.000000Z"]},
     )
     completed_at: StrictStr | None = Field(
-        description="The date and time when the action has finished execution"
+        description="The date and time when the action has finished execution",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04.000000Z"]},
     )
     created_at: StrictStr = Field(
-        description="The date and time when the record was created"
+        description="The date and time when the record was created",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48.000000Z"]},
     )
     updated_at: StrictStr = Field(
-        description="The date and time when the record was last updated"
+        description="The date and time when the record was last updated",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04.000000Z"]},
     )
 
 
@@ -117,6 +137,7 @@ class ActionRelationPlain(TypedDict, total=False):
     ]
     type_human_readable: Required[str]
     url_web_permalink: Required[str]
+    trigger_comment: str | None
     action_data: Union[ActionData, ActionDataPlain] | None
     triggered_from: Required[
         Union[

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_relation_shallow.py

@@ -51,21 +51,31 @@ class ActionRelationShallow(DevopnessBaseModel):
         updated_at (datetime): When the action was last updated
     """
 
-    id: StrictInt = Field(description="The Id of the action")
+    id: StrictInt = Field(
+        description="The Id of the action", json_schema_extra={"examples": [567819876]}
+    )
     status: ActionStatus
     status_human_readable: StrictStr = Field(
-        description="Human readable version of the action status"
+        description="Human readable version of the action status",
+        json_schema_extra={"examples": ["Pending"]},
     )
     status_reason_code: ActionStatusReasonCode
     status_reason_human_readable: StrictStr = Field(
-        description="Human readable version of the status reason code"
+        description="Human readable version of the status reason code",
+        json_schema_extra={
+            "examples": [
+                "Pending: Action created successfully but has not yet been queued for execution."
+            ]
+        },
     )
     type: ActionType
     type_human_readable: StrictStr = Field(
-        description="Human readable version of the action type"
+        description="Human readable version of the action type",
+        json_schema_extra={"examples": ["Deploy"]},
     )
     url_web_permalink: StrictStr = Field(
-        description="Permalink to view the action on Devopness web"
+        description="Permalink to view the action on Devopness web",
+        json_schema_extra={"examples": ["https://devopness.com/actions/567819876"]},
     )
     action_data: ActionData | None = None
     triggered_from: ActionTriggeredFrom | None = None

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_resource.py

@@ -30,10 +30,14 @@ class ActionResource(DevopnessBaseModel):
         data (ActionResourceData, optional, nullable):
     """
 
-    id: StrictInt = Field(description="The unique id of the resource")
+    id: StrictInt = Field(
+        description="The unique id of the resource",
+        json_schema_extra={"examples": [1839123]},
+    )
     type: ResourceType
     type_human_readable: StrictStr = Field(
-        description="Human readable version of the resource type"
+        description="Human readable version of the resource type",
+        json_schema_extra={"examples": ["Application"]},
     )
     data: ActionResourceData | None = None
 

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_retry_response.py

@@ -49,6 +49,7 @@ class ActionRetryResponse(DevopnessBaseModel):
         type (ActionType):
         type_human_readable (str): Human readable version of the action type
         url_web_permalink (str): The permalink URL to the action details on Devopness web app
+        trigger_comment (str, optional, nullable): Optional comment attached to this action
         action_data (ActionData, optional, nullable):
         triggered_from (ActionTriggeredFrom):
         parent (RelatedAction, optional, nullable):
@@ -67,27 +68,44 @@ class ActionRetryResponse(DevopnessBaseModel):
         updated_at (str): The date and time when the record was last updated
     """
 
-    id: StrictInt = Field(description="The Id of the given action")
+    id: StrictInt = Field(
+        description="The Id of the given action",
+        json_schema_extra={"examples": [567819876]},
+    )
     pipeline_id: StrictInt | None = Field(
-        description="The ID of the pipeline executed by this action"
+        description="The ID of the pipeline executed by this action",
+        json_schema_extra={"examples": [567819876]},
     )
     retry_of: StrictInt | None = Field(
-        description="The Id of the parent action that this action is a retry of"
+        description="The Id of the parent action that this action is a retry of",
+        json_schema_extra={"examples": [764123]},
     )
     status: ActionStatus
     status_human_readable: StrictStr = Field(
-        description="Human readable version of action status"
+        description="Human readable version of action status",
+        json_schema_extra={"examples": ["Pending"]},
     )
     status_reason_code: ActionStatusReasonCode
     status_reason_human_readable: StrictStr = Field(
-        description="Human readable version of the status reason code"
+        description="Human readable version of the status reason code",
+        json_schema_extra={
+            "examples": [
+                "Pending: Action created successfully but has not yet been queued for execution. It will be added to an execution queue once their dependencies are resolved."
+            ]
+        },
     )
     type: ActionType
     type_human_readable: StrictStr = Field(
-        description="Human readable version of the action type"
+        description="Human readable version of the action type",
+        json_schema_extra={"examples": ["Deploy"]},
     )
     url_web_permalink: StrictStr = Field(
-        description="The permalink URL to the action details on Devopness web app"
+        description="The permalink URL to the action details on Devopness web app",
+        json_schema_extra={"examples": ["https://devopness.com/actions/567819876"]},
+    )
+    trigger_comment: StrictStr | None = Field(
+        description="Optional comment attached to this action",
+        json_schema_extra={"examples": ["Triggered after a configuration update."]},
     )
     action_data: ActionData | None
     triggered_from: ActionTriggeredFrom
@@ -104,16 +122,20 @@ class ActionRetryResponse(DevopnessBaseModel):
     )
     hook_requests: ActionHookRequest | None = None
     started_at: StrictStr | None = Field(
-        description="The date and time when the action started execution (i.e., left the `pending/queued` status)"
+        description="The date and time when the action started execution (i.e., left the `pending/queued` status)",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48.000000Z"]},
     )
     completed_at: StrictStr | None = Field(
-        description="The date and time when the action has finished execution"
+        description="The date and time when the action has finished execution",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04.000000Z"]},
     )
     created_at: StrictStr = Field(
-        description="The date and time when the record was created"
+        description="The date and time when the record was created",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48.000000Z"]},
     )
     updated_at: StrictStr = Field(
-        description="The date and time when the record was last updated"
+        description="The date and time when the record was last updated",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04.000000Z"]},
     )
 
 
@@ -147,6 +169,7 @@ class ActionRetryResponsePlain(TypedDict, total=False):
     ]
     type_human_readable: Required[str]
     url_web_permalink: Required[str]
+    trigger_comment: str | None
     action_data: Union[ActionData, ActionDataPlain] | None
     triggered_from: Required[
         Union[

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_step.py

@@ -44,42 +44,68 @@ class ActionStep(DevopnessBaseModel):
         updated_at (datetime, optional): The date and time when the record was last updated
     """
 
-    id: StrictInt = Field(description="The unique id of the action step")
+    id: StrictInt = Field(
+        description="The unique id of the action step",
+        json_schema_extra={"examples": [18931]},
+    )
     action_id: StrictInt = Field(
-        description="The unique id of the action linked to this step"
+        description="The unique id of the action linked to this step",
+        json_schema_extra={"examples": [98412]},
     )
     action_target_id: StrictInt = Field(
-        description="The unique id of the action target linked to this step"
+        description="The unique id of the action target linked to this step",
+        json_schema_extra={"examples": [65712]},
     )
     name: StrictStr | None = Field(
-        description="Name of the action describing your purpose"
+        description="Name of the action describing your purpose",
+        json_schema_extra={"examples": ["Setting up cron job"]},
     )
     description: StrictStr | None = Field(
         default=None,
         description="A short text describing the command. Can be helpful for other team members to understand why a pipeline step is needed.",
+        json_schema_extra={
+            "examples": ["Setting up cron job for daily execution at 00:00"]
+        },
+    )
+    order: StrictInt = Field(
+        description="The execution order of the given step",
+        json_schema_extra={"examples": [3]},
     )
-    order: StrictInt = Field(description="The execution order of the given step")
     status: ActionStatus
     status_human_readable: StrictStr | None = Field(
-        default=None, description="Human readable version of the action status"
+        default=None,
+        description="Human readable version of the action status",
+        json_schema_extra={"examples": ["Pending"]},
     )
     status_reason_code: ActionStatusReasonCode | None = None
     status_reason_human_readable: StrictStr | None = Field(
-        default=None, description="Human readable version of the status reason code"
+        default=None,
+        description="Human readable version of the status reason code",
+        json_schema_extra={
+            "examples": [
+                "Pending: Step created successfully but has not yet been queued for execution. It will be added to an execution queue once their dependencies are resolved."
+            ]
+        },
     )
     started_at: datetime | None = Field(
         default=None,
         description="The date and time when the action started execution (i.e., left the `pending/queued` status)",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48Z"]},
     )
     completed_at: datetime | None = Field(
         default=None,
         description="The date and time when the action has finished execution",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04Z"]},
     )
     created_at: datetime | None = Field(
-        default=None, description="The date and time when the record was created"
+        default=None,
+        description="The date and time when the record was created",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48Z"]},
     )
     updated_at: datetime | None = Field(
-        default=None, description="The date and time when the record was last updated"
+        default=None,
+        description="The date and time when the record was last updated",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04Z"]},
     )
 
 

{devopness-2.5.0 → devopness-2.6.1}/src/devopness/generated/models/action_summary_target.py

@@ -28,13 +28,26 @@ class ActionSummaryTarget(DevopnessBaseModel):
         failed (int): The number of action targets failed
     """
 
-    count: StrictInt = Field(description="The total number of action targets")
-    pending: StrictInt = Field(description="The number of action targets pending")
+    count: StrictInt = Field(
+        description="The total number of action targets",
+        json_schema_extra={"examples": [4]},
+    )
+    pending: StrictInt = Field(
+        description="The number of action targets pending",
+        json_schema_extra={"examples": [2]},
+    )
     in_progress: StrictInt = Field(
-        description="The number of action targets in progress"
+        description="The number of action targets in progress",
+        json_schema_extra={"examples": [1]},
+    )
+    completed: StrictInt = Field(
+        description="The number of action targets completed",
+        json_schema_extra={"examples": [1]},
+    )
+    failed: StrictInt = Field(
+        description="The number of action targets failed",
+        json_schema_extra={"examples": [0]},
     )
-    completed: StrictInt = Field(description="The number of action targets completed")
-    failed: StrictInt = Field(description="The number of action targets failed")
 
 
 class ActionSummaryTargetPlain(TypedDict, total=False):