peak-sdk 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

peak/_metadata.py

@@ -595,6 +595,26 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "revisionCount",
         },
     },
+    "execute_resources": {
+        "table_params": {
+            "output_keys": {
+                "blockSpecId": {
+                    "label": "Block Spec ID",
+                },
+                "version": {
+                    "label": "Version",
+                },
+                "executionId": {
+                    "label": "Execution ID",
+                },
+                "status": {
+                    "label": "Execution Status",
+                },
+            },
+            "title": "Trigger Resources",
+            "data_key": "executeResponse",
+        },
+    },
     "list_tenant_instance_options": {
         "table_params": {
             "output_keys": {
@@ -754,13 +774,13 @@ command_metadata: Dict[str, Any] = {
         "request_body_yaml_path": "sample_yaml/press/apps/deployments/update_app_deployment_metadata.yaml",
     },
     "create_block_spec": {
-        "request_body_yaml_path": "sample_yaml/press/blocks/specs/create_block_spec.yaml",
+        "request_body_yaml_path": "sample_yaml/press/blocks/specs/workflow/create_block_spec.yaml",
     },
     "update_block_spec_metadata": {
         "request_body_yaml_path": "sample_yaml/press/blocks/specs/update_block_spec_metadata.yaml",
     },
     "create_block_spec_release": {
-        "request_body_yaml_path": "sample_yaml/press/blocks/specs/create_block_spec_release.yaml",
+        "request_body_yaml_path": "sample_yaml/press/blocks/specs/workflow/create_block_spec_release.yaml",
     },
     "create_block_deployment": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/create_block_deployment.yaml",

peak/_version.py

@@ -18,4 +18,4 @@
 # # You should have received a copy of the APACHE LICENSE, VERSION 2.0
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
-__version__: str = "1.6.0"
+__version__: str = "1.7.0"

peak/cli/args.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """CLI arguments."""
+
 import typer
 from peak.callbacks import dry_run, generate_yaml, handle_output, paging
 from peak.cli.version import display_version

peak/cli/press/apps/specs.py

@@ -74,6 +74,7 @@ def create(
             - id (string): ID of the block spec.
               release (map):
                 version (string): A valid semantic release version of the block spec.
+              autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
     ```
 
     \b
@@ -318,6 +319,7 @@ def create_release(
             - id (string): ID of the block spec.
               release (map):
                 version (string): A valid semantic release version of the block spec.
+              autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
     ```
 
     \b

peak/cli/press/blocks/specs.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak blocks specs commands."""
+
 from typing import Dict, List, Optional
 
 import typer
@@ -109,6 +110,7 @@ def create(
     featured (bool | required: false): Boolean specifying whether to feature this spec.
     scope (str | required: false): Specify what tenants can discover and deploy this spec.
     tenants (list(str) | required: false): Given a shared scope, specify what other tenants can discover and deploy this spec.
+    autoRunOnDeploy (bool | required: false): Whether to execute the resource after the block is deployed. By default it is False.
     body (map):
         version (int): Version of the spec.
         kind (string): Specifies the type of spec.
@@ -124,8 +126,8 @@ def create(
         release (map):
             version (string): A valid semantic release version of the spec.
             notes (string | required: false): Notes for the release version.
-        config (map):
-            images(map | required: false):  # To be used only in case of workflow block.
+        config (map):   # For Workflow Block
+            images(map | required: false):
                 image-name (map): Dictionary containing the image configuration. Here the key is name of the image.
                     version (string | required: false): A valid semantic image version.
                     dockerfile (string | required: false): Path to the Dockerfile inside artifact.
@@ -133,7 +135,7 @@ def create(
                     useCache (boolean | required: false): Whether to enable image caching to reduce build time, is enabled by default.
                     buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                     secrets (list(str)) | required: false): List of secret names to be passed.
-            steps (map | required: false):   # To be used only in case of workflow block.
+            steps (map | required: false):
                 <stepName> (map): Dictionary containing the step configuration. Here the key is name of the step.
                     image: (map | required: false):
                         version (string | required: false): A valid semantic image version.
@@ -170,24 +172,44 @@ def create(
                     success (boolean | required: false): Whether to call event on success.
                     fail (boolean | required: false): Whether to call event on failure.
                     runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
-                  user (string | required: false): User to be notified. To be added in case of user watcher.
-                  webhook (map | required: false): To be added in case of webhook watcher.
+                  user (string): User to be notified.
+                - events (map):
+                    success (boolean | required: false): Whether to call event on success.
+                    fail (boolean | required: false): Whether to call event on failure.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  webhook (map):
                     name (string): Name of the webhook.
                     url (string): URL of the webhook.
                     payload (string): Webhook payload.
-            image (map | required: false):  # To be used only in case of webapp block.
+                - events (map):
+                    success (boolean | required: false): Whether to call event on success.
+                    fail (boolean | required: false): Whether to call event on failure.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  email (map):
+                    name (string): Name of the email watcher.
+                    recipients (map):
+                        to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
+        config (map):   # For Service Block. One of "image" or "imageDetails" is required.
+            serviceType (string): Type of the service. Should be one of "web-app" or "api". It is "web-app" by default.
+            image (map | required: false):
                 version (string | required: false): A valid semantic image version.
                 dockerfile (string | required: false): Path to the Dockerfile inside artifact.
                 context (string | required: false): The path within the artifact where the code to be executed by the Dockerfile is located.
                 useCache (boolean | required: false): Whether to enable image caching to reduce build time, is enabled by default.
                 buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                 secrets (list(str)) | required: false): List of secret names to be passed.
-            imageDetails (map | required: false):  # To be used only in case of webapp block.
+            imageDetails (map | required: false):
                 id (int): ID of the existing image.
-                versionId: (int): ID of the existing image version.
-            resources (map | required: false): To be used only in case of webapp block.
-                instanceTypeId (int): ID of the instance type to be used in the webapp.
-            sessionStickiness (boolean | required: false): Whether to enable session stickiness for the webapp. It is false by default. To be used only in case of webapp block.
+                versionId: (int | required: false): ID of the existing image version. If not provided, the latest version will be used.
+            resources (map | required: false): To be used only in case of service block.
+                instanceTypeId (int): ID of the instance type to be used in the service block.
+            parameters (map | required: false):
+                env (map | required: false): Key-Value pair where key is the name of the env.
+                secrets (list(str) | required: false): List of secret names to be passed.
+            sessionStickiness (boolean | required: false): Whether to enable session stickiness for the service. It is false by default. To be used only in case of service block of type web-app.
+            entrypoint (string | required: false): Entry point for the service.
+            healthCheckURL (string | required: false): URL to check the health of the service.
+            minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
     parameters (map | required: false):
         <parameterType> (list(map)): List containing the parameter objects. Here the key is the type of the parameter. Accepted values are "build" or "run".
             name (string): Name of the parameter.
@@ -388,8 +410,8 @@ def create_release(
         release (map):
             version (string): A valid semantic release version of the spec. Must be greater than previous release version.
             notes (string | required: false): Notes for the release version.
-        config (map):
-            images(map | required: false):  # To be used only in case of workflow block.
+        config (map):   # For Workflow Block
+            images(map | required: false):
                 image-name(map): Dictionary containing the image configuration. Here the key is name of the image.
                     version (string | required: false): A valid semantic image version.
                     dockerfile (string | required: false): Path to the Dockerfile inside artifact.
@@ -397,7 +419,7 @@ def create_release(
                     useCache (boolean | required: false): Whether to enable image caching to reduce build time, is enabled by default.
                     buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                     secrets (list(str)) | required: false): List of secret names to be passed.
-            steps(map | required: false):   # To be used only in case of workflow block.
+            steps(map | required: false):
                 <stepName> (map): Dictionary containing the step configuration. Here the key is name of the step.
                     image: (map | required: false):
                         version (string | required: false): A valid semantic image version.
@@ -434,24 +456,44 @@ def create_release(
                     success (boolean | required: false): Whether to call event on success.
                     fail (boolean | required: false): Whether to call event on failure.
                     runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
-                  user (string | required: false): User to be notified. To be added in case of user watcher.
-                  webhook (map | required: false): To be added in case of webhook watcher.
+                  user (string): User to be notified.
+                - events (map):
+                    success (boolean | required: false): Whether to call event on success.
+                    fail (boolean | required: false): Whether to call event on failure.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  webhook (map):
                     name (string): Name of the webhook.
                     url (string): URL of the webhook.
                     payload (string): Webhook payload.
-            image (map | required: false):  # To be used only in case of webapp block.
+                - events (map):
+                    success (boolean | required: false): Whether to call event on success.
+                    fail (boolean | required: false): Whether to call event on failure.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  email (map):
+                    name (string): Name of the email watcher.
+                    recipients (map):
+                        to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
+        config (map):   # For Service Block. One of "image" or "imageDetails" is required.
+            serviceType (string): Type of the service. Should be one of "web-app" or "api". It is "web-app" by default.
+            image (map | required: false):
                 version (string | required: false): A valid semantic image version.
                 dockerfile (string | required: false): Path to the Dockerfile inside artifact.
                 context (string | required: false): The path within the artifact where the code to be executed by the Dockerfile is located.
                 useCache (boolean | required: false): Whether to enable image caching to reduce build time, is enabled by default.
                 buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                 secrets (list(str)) | required: false): List of secret names to be passed.
-            imageDetails (map | required: false):  # To be used only in case of webapp block.
+            imageDetails (map | required: false):
                 id (int): ID of the existing image.
-                versionId: (int): ID of the existing image version.
-            resources (map | required: false): To be used only in case of webapp block.
-                instanceTypeId (int): ID of the instance type to be used in the webapp.
-            sessionStickiness (boolean | required: false): Whether to enable session stickiness for the webapp. It is false by default. To be used only in case of webapp block.
+                versionId: (int | required: false): ID of the existing image version. If not provided, the latest version will be used.
+            resources (map | required: false):
+                instanceTypeId (int): ID of the instance type to be used in the service block.
+            parameters (map | required: false):
+                env (map | required: false): Key-Value pair where key is the name of the env.
+                secrets (list(str) | required: false): List of secret names to be passed.
+            sessionStickiness (boolean | required: false): Whether to enable session stickiness for the service. It is false by default. To be used only in case of service block of type web-app.
+            entrypoint (string | required: false): Entry point for the service.
+            healthCheckURL (string | required: false): URL to check the health of the service.
+            minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
     parameters (map | required: false):
         <parameterType> (list(map)): List containing the parameter objects. Here the key is the type of the parameter. Accepted values are "build" or "run".
             name (string): Name of the parameter.
@@ -464,6 +506,7 @@ def create_release(
     artifact (map | required: false):
         path (str): Path to the artifact.
         ignore_files (list(str) | required: false) : Ignore files to use when creating artifact.
+    autoRunOnDeploy (bool | required: false): Whether to execute the resource after the block is deployed. By default it is False.
     ```
 
     \b
@@ -534,6 +577,7 @@ def describe_release(
         "createdBy": "someoneh@peak.ai",
         "id": "df113d64-ff44-4aa0-9278-edb03dae7a3f",
         "notes": "This is the original release",
+        "autoRunOnDeploy": false,
         "parameters": {...},
     }
     ```

peak/cli/press/deployments.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak deployments commands."""
+
 from typing import List, Optional
 
 import typer
@@ -84,3 +85,43 @@ def list_deployments(
             return_iterator=False,
         )
         writer.write(response)
+
+
+@app.command(short_help="Execute the resources of an app or block deployment", options_metavar="execute_resources")
+def execute_resources(
+    ctx: typer.Context,
+    deployment_id: str = typer.Argument(..., help="ID of the app or block deployment to execute resources for."),
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypes] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Execute*** the resources of an app or block deployment. This will execute the resources of the latest revision of the deployment for which `autoRunOnDeploy` property is enabled.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak deployments execute-resources <deployment_id>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "executeResponse": [
+            {
+                "blockSpecId": "0bddb4c6-40c5-45c3-b477-fceb2c051609",
+                "version": "1.0.0",
+                "executionId": "a3e77006-86f3-4829-8c43-f21ad462dbbd",
+                "status": "executed"
+            }
+        ]
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Deployments/post_v1_deployments__deploymentId__trigger)
+    """
+    deployment_client: Deployment = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = deployment_client.execute_resources(deployment_id)
+        writer.write(response)

peak/cli/resources/images.py

@@ -41,7 +41,10 @@ _BUILD_ID = typer.Option(..., help="ID of the image build to be used in this ope
 
 _COUNT = typer.Option(None, help="Number of builds required.")
 
-_BUILD_STATUS = typer.Option(None, help="List of build status to filter image builds.")
+_BUILD_STATUS = typer.Option(
+    None,
+    help="List of build status to filter image builds. Valid values are `building`, `failed`, `success`, `stopped`, `stopping`.",
+)
 
 _VERSIONS = typer.Option(None, help="List of version ids to filter image builds.")
 
@@ -52,7 +55,10 @@ _IMAGE_LIST_STATUS = typer.Option(
     help="List of status of the latest version to filter the images by. Valid values are `not-ready`, `ready`, `in-use`, `deleting`, `delete-failed`.",
 )
 
-_IMAGE_LIST_SCOPE = typer.Option(None, help="List of type of image to filter the images by.")
+_IMAGE_LIST_SCOPE = typer.Option(
+    None,
+    help="List of type of image to filter the images by. Valid values are `custom` and `global`.",
+)
 
 _IMAGE_LIST_BUILD_STATUS = typer.Option(
     None,
@@ -79,7 +85,10 @@ _NAME = typer.Option(None, help="Name of the image.")
 
 _VERSION = typer.Option(None, help="A valid semantic image version.")
 
-_TYPE = typer.Option(None, help="Type of the image.")
+_TYPE = typer.Option(
+    None,
+    help="Type of the image. Allowed values are 'workflow', 'workspace-r', 'workspace-python, 'api', 'webapp'.",
+)
 
 _DESCRIPTION = typer.Option(None, help="Description of the image.")
 
@@ -89,7 +98,10 @@ _ARTIFACT_IGNORE_FILES = typer.Option(None, help="Ignore files to use when creat
 
 _BUILD_DETAILS = typer.Option(None, help="Build details of the image. To be passed in stringified json format.")
 
-_SOURCE = typer.Option(None, help="The source via which the image is to be created.")
+_SOURCE = typer.Option(
+    None,
+    help="The source via which the image is to be created. Allowed values are 'github', 'dockerfile' and 'upload'.",
+)
 
 _DOCKERFILE = typer.Option(None, help="The dockerfile to be used to create the image.")
 
@@ -167,7 +179,7 @@ def create(
       body (map):
         name (str): Name of the image.
         version (str | required: false): A valid semantic image version. If not provided, the version will be set to 0.0.1.
-        type (str): Type of the image.
+        type (str): Type of the image. Allowed values are 'workflow', 'workspace-r', 'workspace-python, 'api' and 'webapp'.
         description (str | required: false): Description of the image.
         buildDetails (map | required: false):
           source (str | required: false): The source via which the image is to be created. Allowed values are 'github', 'dockerfile' and 'upload'. It is 'upload' by default.
@@ -429,7 +441,7 @@ def create_or_update(
       body (map):
         name (str): Name of the image.
         version (str | required: false): A valid semantic image version. If not provided, the next patch version of the latest version will be used.
-        type (str): Type of the image.
+        type (str): Type of the image. Allowed values are 'workflow', 'workspace-r', 'workspace-python, 'api' and 'webapp'.
         description (str | required: false): Description of the image.
         buildDetails (map | required: false): If not provided and if the image version already exists, the build details of the existing version will be used.
           source (str | required: false): The source via which the image is to be created. Allowed values are 'github', 'dockerfile' and 'upload'. It is 'upload' by default if new version is being created otherwise the existing version's source will be used.

peak/cli/resources/tenants.py

@@ -32,7 +32,10 @@ app = typer.Typer(
     short_help="Create and manage Tenant Settings.",
 )
 
-_ENTITY_TYPE = typer.Option(..., help="Entity type to be used in this operation (e.g. - feed, workflow).")
+_ENTITY_TYPE = typer.Option(
+    ...,
+    help="Entity type to be used in this operation (e.g. - `workflow`, `webapp`, `api-deployment`).",
+)
 
 
 @app.command(

peak/cli/resources/workflows.py

@@ -119,12 +119,12 @@ def create(
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               user (string): User to be notified.
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               webhook (map):
                 name (string): Name of the webhook.
@@ -132,7 +132,7 @@ def create(
                 payload (string): Webhook payload.
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               email (map):
                 name (string): Name of the email watcher.
@@ -243,12 +243,12 @@ def update(
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               user (string): User to be notified.
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               webhook (map):
                 name (string): Name of the webhook.
@@ -256,7 +256,7 @@ def update(
                 payload (string): Webhook payload.
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               email (map):
                 name (string): Name of the email watcher.
@@ -367,12 +367,12 @@ def create_or_update(
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               user (string): User to be notified.
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               webhook (map):
                 name (string): Name of the webhook.
@@ -380,7 +380,7 @@ def create_or_update(
                 payload (string): Webhook payload.
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               email (map):
                 name (string): Name of the email watcher.
@@ -521,12 +521,12 @@ def patch(
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               user (string): User to be notified.
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               webhook (map):
                 name (string): Name of the webhook.
@@ -534,7 +534,7 @@ def patch(
                 payload (string): Webhook payload.
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
                 runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
               email (map):
                 name (string): Name of the email watcher.

peak/press/apps.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Apps client module."""
+
 from __future__ import annotations
 
 import json
@@ -151,7 +152,8 @@ class App(BaseClient):
 
         All App Specs must have unique names within a tenant.
         An App Spec must now be made up of already existing block specs.
-        Spec details (specId and release) needs to be added in the spec body inside `config` key.
+        Spec details (Block spec ID and Release version) needs to be added to the `config` key.
+        `config` also contains a `autoRunOnDeploy` key which is a boolean value to specify if the resource should be executed on successful deployment of the app. By default, it is False.
 
         REFERENCE:
             🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/App%20Specs/post_v1_apps_specs_>`__
@@ -196,7 +198,8 @@ class App(BaseClient):
                             "id": "string(required)",
                             "release": {
                                 "version": "string(required)",
-                            }
+                            },
+                            "autoRunOnDeploy": "boolean (By default it is False)",
                         }
                     ]
                 }
@@ -319,6 +322,9 @@ class App(BaseClient):
     def create_spec_release(self, spec_id: str, body: Dict[str, Any]) -> Dict[str, str]:
         """Publish a new release to an existing App spec.
 
+        Spec details (Block spec ID and Release version) needs to be added to the `config` key.
+        `config` also contains a `autoRunOnDeploy` key which is a boolean value to specify if the resource should be executed on successful deployment of the app. By default, it is False.
+
         REFERENCE:
             🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/App%20Specs/post_v1_apps_specs__specId__releases>`__
 
@@ -338,7 +344,8 @@ class App(BaseClient):
                             "id": "string(required)",
                             "release": {
                                 "version": "string(required)",
-                            }
+                            },
+                            "autoRunOnDeploy": "boolean (By default it is False)",
                         }
                     ],
                     "release": {