cortexapps-cli 1.41.0__tar.gz → 1.42.0__tar.gz

{cortexapps_cli-1.41.0 → cortexapps_cli-1.42.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cortexapps-cli
-Version: 1.41.0
+Version: 1.42.0
 Summary: Command Line Interface for cortexapps
 License: MIT
 License-File: LICENSE

{cortexapps_cli-1.41.0 → cortexapps_cli-1.42.0}/cortexapps_cli/cli.py

@@ -46,6 +46,7 @@ import cortexapps_cli.commands.secrets as secrets
 import cortexapps_cli.commands.solutions as solutions
 import cortexapps_cli.commands.teams as teams
 import cortexapps_cli.commands.users as users
+import cortexapps_cli.commands.verifications as verifications
 import cortexapps_cli.commands.workflows as workflows
 
 class _SortedTyper(typer.Typer):
@@ -285,6 +286,7 @@ app.add_typer(secrets.app, name="secrets")
 app.add_typer(solutions.app, name="solutions")
 app.add_typer(teams.app, name="teams")
 app.add_typer(users.app, name="users")
+app.add_typer(verifications.app, name="verifications")
 app.command()(version)
 app.add_typer(workflows.app, name="workflows")
 

cortexapps_cli-1.42.0/cortexapps_cli/commands/verifications.py

@@ -0,0 +1,99 @@
+import typer
+from typing import Optional
+from typing_extensions import Annotated
+
+from cortexapps_cli.command_options import ListCommandOptions
+from cortexapps_cli.utils import print_output_with_context
+
+import cortexapps_cli.commands.verifications_commands.periods as periods
+import cortexapps_cli.commands.verifications_commands.entity as entity
+
+app = typer.Typer(help="Verifications commands", no_args_is_help=True)
+app.add_typer(periods.app, name="periods")
+app.add_typer(entity.app, name="entity")
+
+
+class VerificationsCommandOptions:
+    period_cid = Annotated[
+        Optional[str],
+        typer.Option("--period-cid", "-p", help="Filter by verification period CID", show_default=False),
+    ]
+    status = Annotated[
+        Optional[str],
+        typer.Option(
+            "--status",
+            "-s",
+            help="Filter by status: PENDING, VERIFIED_CORRECT, or VERIFIED_INCORRECT",
+            show_default=False,
+        ),
+    ]
+    is_active = Annotated[
+        Optional[bool],
+        typer.Option("--is-active", "-a", help="Filter to only active or inactive periods", show_default=False),
+    ]
+
+
+@app.command(name="list")
+def verifications_list(
+    ctx: typer.Context,
+    period_cid: VerificationsCommandOptions.period_cid = None,
+    status: VerificationsCommandOptions.status = None,
+    is_active: VerificationsCommandOptions.is_active = None,
+    page: ListCommandOptions.page = None,
+    page_size: ListCommandOptions.page_size = 250,
+    table_output: ListCommandOptions.table_output = False,
+    csv_output: ListCommandOptions.csv_output = False,
+    columns: ListCommandOptions.columns = [],
+    no_headers: ListCommandOptions.no_headers = False,
+    filters: ListCommandOptions.filters = [],
+    sort: ListCommandOptions.sort = [],
+):
+    """
+    List verification records
+    """
+    client = ctx.obj["client"]
+
+    if (table_output or csv_output) and not ctx.params.get("columns"):
+        ctx.params["columns"] = [
+            "Entity=entity.tag",
+            "Period=period.cid",
+            "Status=status",
+            "Verified At=verifiedAt",
+        ]
+
+    params = {
+        "periodCid": period_cid,
+        "status": status,
+        "isActive": is_active,
+        "page": page,
+        "pageSize": page_size,
+    }
+    params = {k: v for k, v in params.items() if v is not None}
+
+    if page is None:
+        r = client.fetch("api/v1/verifications", params=params)
+    else:
+        r = client.get("api/v1/verifications", params=params)
+
+    print_output_with_context(ctx, r)
+
+
+@app.command()
+def verify(
+    ctx: typer.Context,
+    file_input: Annotated[
+        typer.FileText,
+        typer.Option(
+            "--file",
+            "-f",
+            help="File containing JSON array of verification entries; can be passed as stdin with -, example: -f-",
+        ),
+    ] = None,
+):
+    """
+    Bulk verify entities. Accepts a JSON array of verification entries.
+    HTTP 200 does not guarantee all entries succeeded — check the errors array in the response.
+    """
+    client = ctx.obj["client"]
+    r = client.put("api/v1/verifications", data=file_input.read(), content_type="application/json")
+    print_output_with_context(ctx, r)

cortexapps_cli-1.42.0/cortexapps_cli/commands/verifications_commands/entity.py

@@ -0,0 +1,87 @@
+import typer
+from typing import Optional
+from typing_extensions import Annotated
+
+from cortexapps_cli.command_options import ListCommandOptions
+from cortexapps_cli.utils import print_output_with_context
+
+app = typer.Typer(help="Entity-level verification commands", no_args_is_help=True)
+
+
+class EntityVerificationOptions:
+    tag = Annotated[
+        str,
+        typer.Option("--tag", "-t", help="The tag (x-cortex-tag) or unique, auto-generated identifier for the entity"),
+    ]
+    period_cid = Annotated[
+        str,
+        typer.Option("--period-cid", "-p", help="The CID of the verification period"),
+    ]
+    is_active = Annotated[
+        Optional[bool],
+        typer.Option("--is-active", "-a", help="Filter to only active or inactive periods", show_default=False),
+    ]
+
+
+@app.command(name="list")
+def entity_list(
+    ctx: typer.Context,
+    tag: EntityVerificationOptions.tag = ...,
+    is_active: EntityVerificationOptions.is_active = None,
+    table_output: ListCommandOptions.table_output = False,
+    csv_output: ListCommandOptions.csv_output = False,
+    columns: ListCommandOptions.columns = [],
+    no_headers: ListCommandOptions.no_headers = False,
+    filters: ListCommandOptions.filters = [],
+    sort: ListCommandOptions.sort = [],
+):
+    """
+    List verification periods for a specific entity
+    """
+    client = ctx.obj["client"]
+
+    if (table_output or csv_output) and not ctx.params.get("columns"):
+        ctx.params["columns"] = [
+            "Period CID=period.cid",
+            "Period Name=period.name",
+            "Status=status",
+            "Verified At=verifiedAt",
+        ]
+
+    params = {"isActive": is_active}
+    params = {k: v for k, v in params.items() if v is not None}
+
+    r = client.get(f"api/v1/catalog/{tag}/verifications", params=params)
+    print_output_with_context(ctx, r)
+
+
+@app.command()
+def verify(
+    ctx: typer.Context,
+    tag: EntityVerificationOptions.tag = ...,
+    period_cid: EntityVerificationOptions.period_cid = ...,
+    status: str = typer.Option(
+        ...,
+        "--status",
+        "-s",
+        help="Verification answer: VERIFIED_CORRECT or VERIFIED_INCORRECT",
+    ),
+    reason: Optional[str] = typer.Option(
+        None,
+        "--reason",
+        "-r",
+        help="Optional reason (required when period has reasonRequired=true)",
+        show_default=False,
+    ),
+):
+    """
+    Verify a single entity in a verification period
+    """
+    client = ctx.obj["client"]
+
+    data = {"status": status}
+    if reason is not None:
+        data["reason"] = reason
+
+    r = client.put(f"api/v1/catalog/{tag}/verifications/{period_cid}", data=data)
+    print_output_with_context(ctx, r)

cortexapps_cli-1.42.0/cortexapps_cli/commands/verifications_commands/periods.py

@@ -0,0 +1,149 @@
+import typer
+from typing import Optional
+from typing_extensions import Annotated
+
+from cortexapps_cli.command_options import ListCommandOptions
+from cortexapps_cli.utils import print_output_with_context
+
+app = typer.Typer(help="Verification periods commands", no_args_is_help=True)
+
+
+class PeriodsCommandOptions:
+    period_cid = Annotated[
+        str,
+        typer.Option("--period-cid", "-p", help="The CID of the verification period"),
+    ]
+    is_active = Annotated[
+        Optional[bool],
+        typer.Option("--is-active", "-a", help="Filter to only active or inactive periods", show_default=False),
+    ]
+
+
+@app.command(name="list")
+def periods_list(
+    ctx: typer.Context,
+    is_active: PeriodsCommandOptions.is_active = None,
+    page: ListCommandOptions.page = None,
+    page_size: ListCommandOptions.page_size = 250,
+    table_output: ListCommandOptions.table_output = False,
+    csv_output: ListCommandOptions.csv_output = False,
+    columns: ListCommandOptions.columns = [],
+    no_headers: ListCommandOptions.no_headers = False,
+    filters: ListCommandOptions.filters = [],
+    sort: ListCommandOptions.sort = [],
+):
+    """
+    List verification periods
+    """
+    client = ctx.obj["client"]
+
+    if (table_output or csv_output) and not ctx.params.get("columns"):
+        ctx.params["columns"] = [
+            "CID=cid",
+            "Name=name",
+            "Start=startDate",
+            "End=endDate",
+            "Pending=counts.pending",
+            "Correct=counts.verifiedCorrect",
+            "Incorrect=counts.verifiedIncorrect",
+        ]
+
+    params = {
+        "isActive": is_active,
+        "page": page,
+        "pageSize": page_size,
+    }
+    params = {k: v for k, v in params.items() if v is not None}
+
+    if page is None:
+        r = client.fetch("api/v1/verification-periods", params=params)
+    else:
+        r = client.get("api/v1/verification-periods", params=params)
+
+    print_output_with_context(ctx, r)
+
+
+@app.command()
+def get(
+    ctx: typer.Context,
+    period_cid: PeriodsCommandOptions.period_cid = ...,
+):
+    """
+    Get a verification period by CID
+    """
+    client = ctx.obj["client"]
+    r = client.get(f"api/v1/verification-periods/{period_cid}")
+    print_output_with_context(ctx, r)
+
+
+@app.command()
+def create(
+    ctx: typer.Context,
+    file_input: Annotated[
+        typer.FileText,
+        typer.Option("--file", "-f", help="File containing JSON body of the verification period; can be passed as stdin with -, example: -f-"),
+    ] = None,
+):
+    """
+    Create a verification period
+
+    Example file input (period.json):
+
+    \b
+    {
+      "name": "Q4 2026 Verification",
+      "startDate": "2026-10-01T00:00:00",
+      "endDate": "2026-12-31T00:00:00",
+      "scope": {
+        "entityGroups": [],
+        "excludedEntityGroups": [],
+        "types": ["service"]
+      },
+      "requiredRoles": [],
+      "requiredCustomRoleTags": [],
+      "requiredTeamRoleTags": [],
+      "reasonRequired": false
+    }
+
+    Usage: cortex verifications periods create -f period.json
+    """
+    client = ctx.obj["client"]
+    r = client.post("api/v1/verification-periods", data=file_input.read(), content_type="application/json")
+    print_output_with_context(ctx, r)
+
+
+@app.command()
+def update(
+    ctx: typer.Context,
+    period_cid: PeriodsCommandOptions.period_cid = ...,
+    file_input: Annotated[
+        typer.FileText,
+        typer.Option("--file", "-f", help="File containing JSON body of the verification period; can be passed as stdin with -, example: -f-"),
+    ] = None,
+):
+    """
+    Update a verification period (full replacement)
+    """
+    client = ctx.obj["client"]
+    r = client.put(f"api/v1/verification-periods/{period_cid}", data=file_input.read(), content_type="application/json")
+    print_output_with_context(ctx, r)
+
+
+@app.command()
+def delete(
+    ctx: typer.Context,
+    period_cid: PeriodsCommandOptions.period_cid = ...,
+    force: bool = typer.Option(False, "--force", "-f", help="Skip confirmation prompt"),
+):
+    """
+    Delete a verification period (permanent)
+    """
+    client = ctx.obj["client"]
+
+    if not force:
+        typer.confirm(
+            f"Permanently delete verification period '{period_cid}'? This cannot be undone.",
+            abort=True,
+        )
+
+    client.delete(f"api/v1/verification-periods/{period_cid}")

{cortexapps_cli-1.41.0 → cortexapps_cli-1.42.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "cortexapps-cli"
 # version will be incremented via command line as part of github actions build
-version = "1.41.0"
+version = "1.42.0"
 description = "Command Line Interface for cortexapps"
 license = "MIT"
 authors = [