rlmesh.describe_json

functionfrom rlmesh import describe_json[source]

Like describe(), but return the canonical JSON string verbatim.

describe_json(
    obj: object,
    *,
    kind: str | None = None,
    generated_at: str | None = None,
    served_env: object | None = None,
    workflow_edition: str | None = None,
) -> str

This is the byte-stable artifact (Rust-serialized); persist it as-is (no json.loads round-trip) when baking into OCI metadata. served_env is an env already built from obj (the one a server hosts): its spaces are read directly instead of constructing a second representative env. workflow_edition is the declaration a server already resolved for the peer it hosts (--workflow-edition and the surfaces around it), which the envelope’s runtime.preferred_workflow_edition must match: pass the resolved value, or "" when the server resolved none, so the envelope reports exactly what the handshake sends. None (the default, for a class described on its own) resolves the class’s declaration here.