Skip to content

Commit 28b0857

Browse files
cezara98tclaude
andcommitted
docs(platform): describe IXP projects service without referencing the CLI
Reword the projects service and facade docstrings to describe the design-time resources on their own terms (resource-named properties, the design-time project lifecycle) instead of "the CLI's uip ixp groups". The Python IXP SDK is independent of the CLI. No behavior change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 3a75f7a commit 28b0857

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
33
:class:`DocumentProjectsService` is the entry point reached via
44
``sdk.document_projects``. It groups the design-time resource services under
5-
properties that mirror the CLI's command groups (``uip ixp projects``,
6-
``uip ixp fields``, ...), so callers write ``sdk.document_projects.projects.list()``.
5+
properties named for each resource (``projects``, ``fields``, ...), so callers
6+
write ``sdk.document_projects.projects.list()``.
77
88
Only the ``projects`` resource is wired today; sibling resources (fields,
99
data-types, groups, documents, labellings, deployments) are added as their

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
"""Design-time projects resource service.
22
3-
:class:`ProjectsService` covers the project lifecycle exposed by the CLI's
4-
``uip ixp projects`` group core verbs — list, retrieve, create, update (title),
5-
delete — over ``du_/api/designtimeapi``. Sub-resources of a project (fields,
6-
data-types, taxonomy, documents, models, ...) are handled by sibling services.
3+
:class:`ProjectsService` covers the design-time project lifecycle — list,
4+
retrieve, create, update (title), delete — over ``du_/api/designtimeapi``.
5+
Sub-resources of a project (fields, data-types, taxonomy, documents, models,
6+
...) are handled by sibling services.
77
88
It builds on :class:`IxpDesigntimeService`, so writes (create/update/delete) are
99
**not** retried while list/retrieve keep the platform retry policy.
1010
"""
1111

1212
from uipath.core.tracing import traced
1313

14-
from ._models import DeleteProjectResponse, Project, ProjectsPage
1514
from ._base_service import IxpDesigntimeService
15+
from ._models import DeleteProjectResponse, Project, ProjectsPage
1616

1717
#: Default project-list page size — matches the design-time API's server-side default.
1818
DEFAULT_LIST_LIMIT = 50

0 commit comments

Comments
 (0)