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

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
@@ -35,7 +36,7 @@ console = Console()
 _SPEC_ID = typer.Argument(..., help="ID of the Block spec to be used in this operation.")
 
 
-@app.command("list", short_help="List Block specs.", options_metavar="list_block_specs")
+@app.command("list", short_help="List Block specs.")
 def list_block_specs(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -89,11 +90,12 @@ def list_block_specs(
         writer.write(response)
 
 
-@app.command(short_help="Create a Block spec.", options_metavar="create_block_spec")
+@app.command(short_help="Create a Block spec.")
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
     description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
+    release_notes_file: Optional[str] = args.RELEASE_NOTES_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -109,6 +111,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 +127,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 +136,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,28 +173,48 @@ 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.
-            type (string): Type of the parameter. Should be one of "string", "number", "boolean" and "string_array".
+            type (string): Type of the parameter. Should be one of "boolean", "string", "string_array", "number", "number_array", "object" and "object_array".
             required (boolean): Whether the parameter is required.
             description (string | required: false): Description of the parameter.
             defaultValue (string | required: false): Default value of the parameter.
@@ -222,7 +245,13 @@ def create(
     block_client: Block = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params, description_file)
+    markdown_files = {}
+    if description_file:
+        markdown_files["body:metadata:description"] = description_file
+    if release_notes_file:
+        markdown_files["body:release:notes"] = release_notes_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, block_client.create_spec)
 
     with writer.pager():
@@ -230,7 +259,7 @@ def create(
         writer.write(response)
 
 
-@app.command(short_help="Describe a Block spec.", options_metavar="describe_block_spec")
+@app.command(short_help="Describe a Block spec.")
 def describe(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
@@ -269,7 +298,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Update the Block spec metadata.", options_metavar="update_block_spec_metadata")
+@app.command(short_help="Update the Block spec metadata.")
 def update_metadata(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
@@ -324,7 +353,11 @@ def update_metadata(
 
     🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Block%20Specs/patch_v1_blocks_specs__specId_)
     """
-    body = helpers.template_handler(file, params_file, params, description_file)
+    markdown_files = {}
+    if description_file:
+        markdown_files["body:metadata:description"] = description_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     writer: Writer = ctx.obj["writer"]
 
     block_client: Block = ctx.obj["client"]
@@ -335,7 +368,7 @@ def update_metadata(
         writer.write(response)
 
 
-@app.command(short_help="Delete a Block spec.", options_metavar="delete_block_spec")
+@app.command(short_help="Delete a Block spec.")
 def delete(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
@@ -367,11 +400,12 @@ def delete(
         writer.write(response)
 
 
-@app.command(short_help="Create a new release for a Block spec.", options_metavar="create_block_spec_release")
+@app.command(short_help="Create a new release for a Block spec.")
 def create_release(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
     file: str = args.TEMPLATE_PATH,
+    release_notes_file: Optional[str] = args.RELEASE_NOTES_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -388,8 +422,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 +431,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,28 +468,48 @@ 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.
-            type (string): Type of the parameter. Should be one of "string", "number", "boolean" and "string_array".
+            type (string): Type of the parameter. Should be one of "boolean", "string", "string_array", "number", "number_array", "object" and "object_array".
             required (boolean): Whether the parameter is required.
             description (string | required: false): Description of the parameter.
             defaultValue (string | required: false): Default value of the parameter.
@@ -464,6 +518,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
@@ -485,7 +540,11 @@ def create_release(
 
     🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Block%20Specs/post_v1_blocks_specs__specId__releases)
     """
-    body = helpers.template_handler(file, params_file, params)
+    markdown_files = {}
+    if release_notes_file:
+        markdown_files["body:release:notes"] = release_notes_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     writer: Writer = ctx.obj["writer"]
 
     block_client: Block = ctx.obj["client"]
@@ -496,7 +555,7 @@ def create_release(
         writer.write(response)
 
 
-@app.command(short_help="Describe a Block spec release.", options_metavar="describe_block_spec_release")
+@app.command(short_help="Describe a Block spec release.")
 def describe_release(
     ctx: typer.Context,
     spec_id: str = args.SPEC_ID,
@@ -534,6 +593,7 @@ def describe_release(
         "createdBy": "someoneh@peak.ai",
         "id": "df113d64-ff44-4aa0-9278-edb03dae7a3f",
         "notes": "This is the original release",
+        "autoRunOnDeploy": false,
         "parameters": {...},
     }
     ```
@@ -548,7 +608,7 @@ def describe_release(
         writer.write(response)
 
 
-@app.command(short_help="List releases of a Block spec.", options_metavar="list_block_spec_releases")
+@app.command(short_help="List releases of a Block spec.")
 def list_releases(
     ctx: typer.Context,
     spec_id: str = args.SPEC_ID,

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
@@ -36,7 +37,7 @@ app = typer.Typer(
 console = Console()
 
 
-@app.command("list", short_help="List App and Block deployments.", options_metavar="list_deployments")
+@app.command("list", short_help="List App and Block deployments.")
 def list_deployments(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -84,3 +85,41 @@ def list_deployments(
             return_iterator=False,
         )
         writer.write(response)
+
+
+@app.command(short_help="Execute the resources of an app or block deployment")
+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"
+            }
+        ]
+    }
+    ```
+    """
+    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/press/specs.py

@@ -38,7 +38,7 @@ console = Console()
 RELEASE_VERSION = typer.Option(None, help="The release version of the spec in valid semantic versioning format.")
 
 
-@app.command("list", short_help="List App and Block specs.", options_metavar="list_specs")
+@app.command("list", short_help="List App and Block specs.")
 def list_specs(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -92,7 +92,7 @@ def list_specs(
         writer.write(response)
 
 
-@app.command(short_help="List deployments for a spec release.", options_metavar="list_release_deployments")
+@app.command(short_help="List deployments for a spec release.")
 def list_release_deployments(
     ctx: typer.Context,
     spec_id: str = args.SPEC_ID,

peak/cli/resources/alerts/emails.py

@@ -57,7 +57,7 @@ _LIST_TEMPLATE_SCOPE = typer.Option(None, help="List of type of template to filt
 _DESCRIBE_TEMPLATE_NAME = typer.Argument(None, help="The name of the email template.")
 
 
-@app.command("list", short_help="List all emails.", options_metavar="list_emails")
+@app.command("list", short_help="List all emails.")
 def list_emails(
     ctx: typer.Context,
     page_size: Optional[int] = _PAGE_SIZE,
@@ -114,7 +114,7 @@ def list_emails(
         writer.write(response)
 
 
-@app.command("send", short_help="Send an email.", options_metavar="send_email")
+@app.command("send", short_help="Send an email.")
 def send_email(
     ctx: typer.Context,
     file: Annotated[
@@ -213,7 +213,7 @@ def send_email(
         writer.write(response)
 
 
-@app.command(short_help="Describe details of a specific email.", options_metavar="describe_email")
+@app.command(short_help="Describe details of a specific email.")
 def describe(
     ctx: typer.Context,
     email_id: int = _EMAIL_ID,
@@ -264,7 +264,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="List all the templates.", options_metavar="list_templates")
+@app.command(short_help="List all the templates.")
 def list_templates(
     ctx: typer.Context,
     page_size: Optional[int] = _PAGE_SIZE,
@@ -320,7 +320,6 @@ def list_templates(
 
 @app.command(
     short_help="Describe details of a specific template.",
-    options_metavar="describe_template",
 )
 def describe_template(
     ctx: typer.Context,

peak/cli/resources/artifacts.py

@@ -45,7 +45,7 @@ _DOWNLOAD_VERSION = typer.Option(
 _DELETE_VERSION = typer.Argument(..., help="Artifact version number to delete.")
 
 
-@app.command("list", short_help="List artifacts.", options_metavar="list_artifacts")
+@app.command("list", short_help="List artifacts.")
 def list_artifacts(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -83,7 +83,7 @@ def list_artifacts(
         writer.write(response)
 
 
-@app.command(short_help="Describe an artifact.", options_metavar="describe_artifact")
+@app.command(short_help="Describe an artifact.")
 def describe(
     ctx: typer.Context,
     artifact_id: str = _ARTIFACT_ID,
@@ -129,7 +129,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Delete an artifact.", options_metavar="delete_artifact")
+@app.command(short_help="Delete an artifact.")
 def delete(
     ctx: typer.Context,
     artifact_id: str = _ARTIFACT_ID,
@@ -158,10 +158,10 @@ def delete(
 
     with writer.pager():
         response = artifact_client.delete_artifact(artifact_id=artifact_id)
-        writer.write(response)
+        writer.write(response, output_type=OutputTypes.json)
 
 
-@app.command(short_help="Create a new artifact.", options_metavar="create_artifact")
+@app.command(short_help="Create a new artifact.")
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
@@ -211,7 +211,7 @@ def create(
         writer.write(response)
 
 
-@app.command(short_help="Update an artifact's metadata.", options_metavar="update_artifact_metadata")
+@app.command(short_help="Update an artifact's metadata.")
 def update_metadata(
     ctx: typer.Context,
     artifact_id: str = _ARTIFACT_ID,
@@ -256,7 +256,7 @@ def update_metadata(
         writer.write(response)
 
 
-@app.command(short_help="Download an artifact.", options_metavar="download_artifact")
+@app.command(short_help="Download an artifact.")
 def download(
     ctx: typer.Context,
     artifact_id: str = _ARTIFACT_ID,
@@ -288,7 +288,7 @@ def download(
         artifact_client.download_artifact(artifact_id=artifact_id, download_path=download_path, version=version)
 
 
-@app.command(short_help="Create a new version of the artifact.", options_metavar="create_artifact_version")
+@app.command(short_help="Create a new version of the artifact.")
 def create_version(
     ctx: typer.Context,
     artifact_id: str = _ARTIFACT_ID,
@@ -337,7 +337,7 @@ def create_version(
         writer.write(response)
 
 
-@app.command(short_help="Delete a version of an artifact.", options_metavar="delete_artifact_version")
+@app.command(short_help="Delete a version of an artifact.")
 def delete_version(
     ctx: typer.Context,
     artifact_id: str = _ARTIFACT_ID,

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.")
 
@@ -125,7 +137,7 @@ MAPPING = {
 }
 
 
-@app.command(short_help="Create a new image.", options_metavar="create_image")
+@app.command(short_help="Create a new image.")
 def create(
     ctx: typer.Context,
     file: Annotated[
@@ -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.
@@ -255,7 +267,7 @@ def create(
         writer.write(response)
 
 
-@app.command(short_help="Create a new image version.", options_metavar="create_image_version")
+@app.command(short_help="Create a new image version.")
 def create_version(
     ctx: typer.Context,
     image_id: int = _IMAGE_ID,
@@ -388,7 +400,6 @@ def create_version(
 
 @app.command(
     short_help="Create a new image/version or Update and existing version.",
-    options_metavar="create_or_update_image",
 )
 def create_or_update(
     ctx: typer.Context,
@@ -429,7 +440,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.
@@ -518,7 +529,7 @@ def create_or_update(
         writer.write(response)
 
 
-@app.command("list", short_help="List images.", options_metavar="list_images")
+@app.command("list", short_help="List images.")
 def list_images(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -571,7 +582,7 @@ def list_images(
         writer.write(response)
 
 
-@app.command("list-versions", short_help="List image versions.", options_metavar="list_image_versions")
+@app.command("list-versions", short_help="List image versions.")
 def list_image_versions(
     ctx: typer.Context,
     image_id: int = _IMAGE_ID,
@@ -624,7 +635,7 @@ def list_image_versions(
         writer.write(response)
 
 
-@app.command(short_help="Describe details of a specific image.", options_metavar="describe_image")
+@app.command(short_help="Describe details of a specific image.")
 def describe(
     ctx: typer.Context,
     image_id: int = _IMAGE_ID,
@@ -663,7 +674,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Describe details of a specific version.", options_metavar="describe_version")
+@app.command(short_help="Describe details of a specific version.")
 def describe_version(
     ctx: typer.Context,
     image_id: int = args.IMAGE_ID,
@@ -711,7 +722,7 @@ def describe_version(
         writer.write(response)
 
 
-@app.command(short_help="Update an image version.", options_metavar="update_version")
+@app.command(short_help="Update an image version.")
 def update_version(
     ctx: typer.Context,
     image_id: int = args.IMAGE_ID,
@@ -845,7 +856,7 @@ def update_version(
         writer.write(response)
 
 
-@app.command(short_help="Delete an image.", options_metavar="delete_image")
+@app.command(short_help="Delete an image.")
 def delete(
     ctx: typer.Context,
     image_id: int = _IMAGE_ID,
@@ -877,7 +888,7 @@ def delete(
         writer.write(response)
 
 
-@app.command(short_help="Delete an image version.", options_metavar="delete_version")
+@app.command(short_help="Delete an image version.")
 def delete_version(
     ctx: typer.Context,
     image_id: int = args.IMAGE_ID,
@@ -910,7 +921,7 @@ def delete_version(
         writer.write(response)
 
 
-@app.command(short_help="Delete all the specified versions.", options_metavar="delete_versions")
+@app.command(short_help="Delete all the specified versions.")
 def delete_versions(
     ctx: typer.Context,
     image_id: int = args.IMAGE_ID,
@@ -947,7 +958,7 @@ def delete_versions(
         writer.write(response)
 
 
-@app.command(short_help="List image builds.", options_metavar="list_image_builds")
+@app.command(short_help="List image builds.")
 def list_builds(
     ctx: typer.Context,
     image_id: int = _IMAGE_ID,