Method schema

unity_cli/api/dynamic_api.py:42–88

List available Unity static API methods. Args: namespace: Filter by namespace prefixes. type_name: Filter by type name. method_name: Filter by method name. limit: Maximum results per page. offset: Pagination offset. off

(
        self,
        namespace: list[str] | None = None,
        type_name: str | None = None,
        method_name: str | None = None,
        limit: int = 100,
        offset: int = 0,
        offline: bool = False,
        no_cache: bool = False,
        version: str | None = None,
    )

        )

    def schema(
        self,
        namespace: list[str] | None = None,
        type_name: str | None = None,
        method_name: str | None = None,
        limit: int = 100,
        offset: int = 0,
        offline: bool = False,
        no_cache: bool = False,
        version: str | None = None,
    ) -> dict[str, Any]:
        """List available Unity static API methods.

        Args:
            namespace: Filter by namespace prefixes.
            type_name: Filter by type name.
            method_name: Filter by method name.
            limit: Maximum results per page.
            offset: Pagination offset.
            offline: Use cached schema only (no Relay).
            no_cache: Skip cache, fetch from Relay.
            version: Unity version override (for offline use).

        Returns:
            Dictionary with methods, total, and hasMore.
        """
        resolved_version = version or self._get_unity_version_safe()

        # Try cache first (unless no_cache)
        if not no_cache and resolved_version:
            cached = self._cache.get(resolved_version)
            if cached:
                return self._filter_schema(cached, namespace, type_name, method_name, limit, offset)

        if offline:
            raise UnityCLIError(
                "No cached schema available. Run 'u api schema' with Relay connected first, or specify --version.",
                "CACHE_MISS",
            )

        # Fetch full schema from Relay and cache it
        full = self._conn.send_request("api-schema", {"cache_all": True})
        if resolved_version:
            full["version"] = resolved_version
            self._cache.put(resolved_version, full)

        return self._filter_schema(full, namespace, type_name, method_name, limit, offset)

    def _get_unity_version_safe(self) -> str | None:
        """Get Unity version from connected instance, or None."""