Skip to content

Commit 585d1dd

Browse files
reduce the number of tokens
1 parent 2dba594 commit 585d1dd

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

developer-guide/20-User interface/05-api-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ toc_max_heading_level: 2
77

88
## Conventions
99

10+
- Only the leader Pioreactor has the `/api` endpoints exposed.
1011
- Path parameters are shown inline in the endpoint URL.
1112
- Most write actions are async and return `{unit, task_id, result_url_path}`; poll `/unit_api/task_results/{task_id}`.
1213
- Request/response examples are the canonical shapes; omit optional fields you do not need.

developer-guide/20-User interface/06-unit-api-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ toc_max_heading_level: 2
66

77
## Conventions
88

9+
- All Pioreactors have the `/unit_api` endpoints exposed.
910
- Path parameters are shown inline in the endpoint URL.
1011
- Async endpoints return `{unit, task_id, result_url_path}`; poll `/unit_api/task_results/{task_id}`.
1112
- Request/response examples are the canonical shapes; omit optional fields you do not need.

0 commit comments

Comments
 (0)