Verify an interface before documenting it
One teaching guide tied to a runnable lab. A documentation exercise is not a product API guarantee.
A practical guide for distinguishing a real exported symbol, tested behavior, and merely proposed API. The example is deliberately fictional: it does not document any production Gnosix interface.
1. Start from source
Lab B provides the exercise. Its api_lab.py fixture contains a symbol inventory and an observable assertion. Queue.morph_to is absent; Queue.enqueue is present in the fixture.
Consult the pinned sources in the registry before reaching conclusions about freshness. A pinned revision establishes inspectable content, not SDK stability.
2. Run both cases locally
From the engineering-corpus repository root, with Python 3:
python3 examples/api_lab.py --symbol Queue.morph_to
# Expected exit: 1 (unknown symbol)
python3 examples/api_lab.py
# Expected exit: 0
python3 scripts/test_labs.py
The first failure is intentional and must be distinguished from a missing dependency or broken environment. Do not turn a passing teaching fixture into a guarantee about an external API.
3. Connect contract to evidence
Record: source SHA, requested symbol, result and exit status, test environment, and explicit limits. Classify public-stable, public-experimental, and internal separately; writing documentation does not grant a maturity status.
For a comparison with a public Rust interface, consult EngineProvider v0. That reference remains experimental, is not distributed as an SDK, and describes no HTTP endpoint. This guide's Python fixture does not qualify the Rust interface.
4. Review and publish
Write the same scoped conclusion in English and French, with reciprocal links and the correct maturity status. Do not publish private code, model weights, credentials, or private files. Proposed changes require separate source review.
Evidence limit: this guide demonstrates an educational method with a fictional program; it is not a certification or an installation guide for the Gnosix product.
Teaching example pinned to commit 9edf055d14716ef9f42c2bed80b01848d7318673 · DRAFT
- docs/fr/labs/02-api.md ↗
sha256:7d51ecbd688614595838055ac83fa6bab18ca9dde828d8e55cf50da5fe795369- docs/en/labs/02-api.md ↗
sha256:5567bc7be94cc503de96c6f4a4dad57b221046fced5b276e95d6f4a2e9851176- examples/api_lab.py ↗
sha256:ec71ab2068cf7c405621a035bed47dba1f9809393c478334256ccd06244591f8- scripts/test_labs.py ↗
sha256:d627986a702a4337297c8c0c4f21c2061119a70da4e88a7e43044d32bd32711c