Skip to content

Commit 5be7b22

Browse files
committed
simplify doc changes
1 parent 1dedee7 commit 5be7b22

2 files changed

Lines changed: 9 additions & 13 deletions

File tree

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Notes:
129129
- Single-record `create` still returns the full entity representation.
130130
- `@odata.type` handling: If any payload in the list omits `@odata.type`, the SDK performs a one-time metadata query (`EntityDefinitions?$filter=EntitySetName eq '<entity_set>'`) to resolve the logical name, caches it, and stamps each missing item with `Microsoft.Dynamics.CRM.<logical>`. If **all** payloads already include `@odata.type`, no metadata call is made.
131131
- The metadata lookup is per entity set and reused across subsequent multi-create calls in the same client instance (in-memory cache only).
132-
- You can explicitly set `@odata.type` yourself (e.g., for polymorphic scenarios); the SDK will not override it.
132+
133133

134134
## Retrieve multiple with paging
135135

@@ -162,6 +162,9 @@ Parameters (all optional except `entity_set`)
162162
- `page_size`: int | None — Per-page hint using Prefer: `odata.maxpagesize=<N>` (not guaranteed; last page may be smaller).
163163

164164
Return value & semantics
165+
- `$select`, `$filter`, `$orderby`, `$expand`, `$top` map directly to corresponding OData query options on the first request.
166+
- `$top` caps total rows; the service may partition those rows across multiple pages.
167+
- `page_size` (Prefer: `odata.maxpagesize`) is a hint; the server decides actual page boundaries.
165168
- Returns a generator yielding non-empty pages (`list[dict]`). Empty pages are skipped.
166169
- Each yielded list corresponds to a `value` page from the Web API.
167170
- Iteration stops when no `@odata.nextLink` remains (or when `$top` satisfied server-side).
@@ -199,13 +202,6 @@ for page in pages: # page is list[dict]
199202
print({"page_size": len(page)})
200203
```
201204

202-
Semantics:
203-
- `$select`, `$filter`, `$orderby`, `$expand`, `$top` map directly to corresponding OData query options on the first request.
204-
- `$top` caps total rows; the service may partition those rows across multiple pages.
205-
- `page_size` (Prefer: `odata.maxpagesize`) is a hint; the server decides actual page boundaries.
206-
- The generator follows `@odata.nextLink` until exhausted (service already accounts for `$top`).
207-
- Only non-empty pages are yielded; if the first response has no `value`, iteration ends immediately.
208-
```
209205

210206
### Custom table (metadata) example
211207

@@ -257,7 +253,7 @@ VS Code Tasks
257253
- No general-purpose OData batching, upsert, or association operations yet.
258254
- `DeleteMultiple`/`UpdateMultiple` are not exposed; quickstart may demonstrate faster deletes using client-side concurrency only.
259255
- Minimal retry policy in library (network-error only); examples include additional backoff for transient Dataverse consistency.
260-
- Entity naming conventions in Dataverse (schema/logical/entity set plural & publisher prefix) are only partially abstracted; for multi-create the SDK resolves logical names from entity set metadata.
256+
- Entity naming conventions in Dataverse: for multi-create the SDK resolves logical names from entity set metadata.
261257

262258
## Contributing
263259

src/dataverse_sdk/odata.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -243,20 +243,20 @@ def get_multiple(
243243
select : list[str] | None
244244
Columns to select; joined with commas into $select.
245245
filter : str | None
246-
``$filter`` expression.
246+
OData $filter expression as a string.
247247
orderby : list[str] | None
248248
Order expressions; joined with commas into $orderby.
249249
top : int | None
250-
Global cap via ``$top`` (applied on first request; server enforces across pages).
250+
Max number of records across all pages. Passed as $top on the first request; the server will paginate via nextLink as needed.
251251
expand : list[str] | None
252-
Navigation expansions -> ``$expand``; raw clauses accepted.
252+
Navigation properties to expand; joined with commas into $expand.
253253
page_size : int | None
254254
Hint for per-page size using Prefer: ``odata.maxpagesize``.
255255
256256
Yields
257257
------
258258
list[dict]
259-
A non-empty page of entities (service ``value`` array). Empty pages are skipped.
259+
A page of records from the Web API (the "value" array for each page).
260260
"""
261261

262262
headers = self._headers().copy()

0 commit comments

Comments
 (0)