Compatibility and migration¶
The central API/MCP service defines what can be requested. This documentation replaces the earlier proposed gradientdynamics object model with the implemented REST contracts, MCP tools and gradient_dynamics.GradientClient convenience client.
Earlier documentation |
Current interface |
|---|---|
Proposed object-oriented client and resource collections |
|
|
Validate/plan, then |
Typed preview simulation objects |
|
Generic completed/wait/result sequence |
Durable job states, mesh review and separate preparation operations |
Unstructured / prism–octree product labels |
GD Hex-core Meshing; existing wire identifiers remain compatible |
Use exact canonical wire keys returned by the service. Branding changes do not rename stored payload fields. Leave compatibility identity selectors unset unless an existing integration specifically requires them; do not invent replacement JSON values.
New mesh requests default to Standard CGNS delivery, while the simulation/viewer mesh remains its distinct native artifact. Historical jobs can retain their earlier export contract. Available formats must be qualified by the connected service; a docs update does not upgrade an older service.
Source capability and deployed availability are separate. Discover current controls and validate complete requests after upgrades. Preserve request bodies, artifact checksums, model/template revisions and idempotency identities for reproducibility. Do not retroactively label historical validation studies as tests of a newer solver or mesh revision.