Skip to content

Commit 098dfb8

Browse files
cezara98tclaude
andcommitted
docs(platform): justify IXP transport on its own terms, not the CLI
The IXP design-time SDK is an independent client of du_/api/designtimeapi; its implementation should not reference the CLI. Reword the no-retry-on-writes rationale to stand on its own (a transient 5xx must not double-create/confirm a design-time mutation) and drop the "matching the CLI SDK" asides from the transport docstrings and the test docstring. No behavior change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 26ccf11 commit 098dfb8

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

packages/uipath-platform/src/uipath/platform/document_projects/_transport.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ class every IXP service (projects, taxonomy, labellings, documents, models)
1515
``quote(safe="")`` (``/`` -> ``%2F``, space -> ``%20``).
1616
* **No retry on writes** — unlike the platform default, non-idempotent verbs
1717
(POST/PUT/PATCH, including multipart upload) and DELETE are **not** retried,
18-
matching the CLI SDK's zero-retry contract so a transient 5xx cannot
19-
double-create or double-confirm. Only idempotent GETs keep the platform
20-
retry policy.
18+
so a transient 5xx cannot double-create or double-confirm a design-time
19+
mutation. Only idempotent GETs keep the platform retry policy.
2120
* **Multipart upload / binary download** — helpers for the ``file`` multipart
2221
field and for reading raw bytes + content-type back.
2322
@@ -203,7 +202,7 @@ def _post(
203202
body: Optional[Any] = None,
204203
params: Optional[dict[str, Any]] = None,
205204
) -> Response:
206-
"""POST (not retried). A ``None`` body is sent as ``{}`` (matching the CLI SDK)."""
205+
"""POST (not retried). A ``None`` body is sent as ``{}`` (an empty JSON object)."""
207206
return self._send(
208207
"POST", endpoint, params=params, json=body if body is not None else {}
209208
)

packages/uipath-platform/tests/services/test_document_projects_transport.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Tests for the IXP design-time transport foundation (``platform/document_projects/_transport``).
22
3-
Cover the conventions the CLI SDK established and this layer must preserve:
3+
Cover the design-time transport conventions this layer enforces:
44
the ``du_/api/designtimeapi`` base path, the mandatory ``api-version=1.0`` query
55
param, strict path-segment percent-encoding, ``{}`` as the empty write body,
66
multipart ``file`` upload, binary download, and — the load-bearing one — that

0 commit comments

Comments
 (0)