1b-agent/OneCAD-Draft
1
0 Fork 0
forked from 1b-agent/opencadstudio-upstream
Code Pull Requests Activity

Merge PR #1089: document API extension workflow

Browse Source 
Preserve main's validation, atomic bulk operations, profile planes, kernel geometry, transport limits and complete Python bindings. The submitted implementation reverted those existing fixes; retain its documentation intent without restoring the regressions.
This commit is contained in:
Hakan Seven committed 2026-09-09 13:10:35 +03:00
2 parents 73a02b06e2 ecb8ca9342
commit 4bb6aac0b6
1 file changed
+8
Download Patch File Download Diff File Expand all files Collapse all files
crates/ocs_doc_api/ARCHITECTURE.md
+8
View File
@@ -25,3 +25,11 @@ vocabulary, not a reflected binary codec schema.
To extend the API, update the DTO, backend, executor, facade and spec together, To extend the API, update the DTO, backend, executor, facade and spec together,
add a native behavior test, and rebuild the generated reference/schema. New add a native behavior test, and rebuild the generated reference/schema. New
backend methods must reject unsupported behavior explicitly. backend methods must reject unsupported behavior explicitly.
Extension workflow:
1. Add the operation/query DTO and its name mapping, then update `spec/entities.toml`.
2. Implement validation, backend preparation, executor dispatch and facade methods.
3. Preserve each profile's plane and use cadkernel for geometry.
4. Test native behavior, failed-operation atomicity and the binding transport payload.
5. Run `cargo test -p ocs_doc_api --all-features` and rebuild the generated snapshots.