Function api_schema

unity_cli/cli/commands/api.py:77–154

List static API methods discoverable by 'api call'. Returned entries include fully-qualified type, method name, return type, and parameter signature. Combine filters to narrow the search. Examples: u api schema -t AssetDatabase # All methods on one type u

(
    ctx: typer.Context,
    namespace: Annotated[
        list[str] | None,
        typer.Option("--namespace", "-n", help="Filter by namespace prefix"),
    ] = None,
    type_name: Annotated[
        str | None,
        typer.Option("--type", "-t", help="Filter by type name"),
    ] = None,
    method_name: Annotated[
        str | None,
        typer.Option("--method", "-m", help="Filter by method name"),
    ] = None,
    limit: Annotated[
        int,
        typer.Option("--limit", "-l", help="Max results per page"),
    ] = 100,
    offset: Annotated[
        int,
        typer.Option("--offset", help="Pagination offset"),
    ] = 0,
    offline: Annotated[
        bool,
        typer.Option("--offline", help="Use cached schema only (no Relay)"),
    ] = False,
    no_cache: Annotated[
        bool,
        typer.Option("--no-cache", help="Skip cache, fetch from Relay"),
    ] = False,
    unity_version: Annotated[
        str | None,
        typer.Option("--version", help="Unity version (for offline cache lookup)"),
    ] = None,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
)

@api_app.command("schema")
@handle_cli_errors
def api_schema(
    ctx: typer.Context,
    namespace: Annotated[
        list[str] | None,
        typer.Option("--namespace", "-n", help="Filter by namespace prefix"),
    ] = None,
    type_name: Annotated[
        str | None,
        typer.Option("--type", "-t", help="Filter by type name"),
    ] = None,
    method_name: Annotated[
        str | None,
        typer.Option("--method", "-m", help="Filter by method name"),
    ] = None,
    limit: Annotated[
        int,
        typer.Option("--limit", "-l", help="Max results per page"),
    ] = 100,
    offset: Annotated[
        int,
        typer.Option("--offset", help="Pagination offset"),
    ] = 0,
    offline: Annotated[
        bool,
        typer.Option("--offline", help="Use cached schema only (no Relay)"),
    ] = False,
    no_cache: Annotated[
        bool,
        typer.Option("--no-cache", help="Skip cache, fetch from Relay"),
    ] = False,
    unity_version: Annotated[
        str | None,
        typer.Option("--version", help="Unity version (for offline cache lookup)"),
    ] = None,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
) -> None:
    """List static API methods discoverable by 'api call'.

    Returned entries include fully-qualified type, method name, return type,
    and parameter signature. Combine filters to narrow the search.

    Examples:
        u api schema -t AssetDatabase               # All methods on one type
        u api schema -n UnityEditor                  # Everything under a namespace
        u api schema -m Refresh                      # Any method named Refresh
        u api schema --offline --version 2022.3      # Browse cached schema offline
    """
    context: CLIContext = ctx.obj
    result = context.client.dynamic_api.schema(
        namespace=namespace,
        type_name=type_name,
        method_name=method_name,
        limit=limit,
        offset=offset,
        offline=offline,