Skip to content

Commit 7cfc4e1

Browse files
minor changes in readme
1 parent 7fca260 commit 7cfc4e1

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

.github/README.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Browser-compiled script and type definitions can be found in a v2 [dist](https:/
3131
- **Abort Signal and Abort Controller** (Browser and Node.js 15+). Abort requests when they are no longer need to be completed.
3232
- **Node.js and a Browser** support.
3333
- **Proxy Configuration** support.
34+
- **Background Operations** support. `v2.3.0+`
3435
- Works with **Microsoft Power Pages** (aka Microsoft Portal). `v2.1.0+`
3536

3637
***
@@ -2198,6 +2199,9 @@ _Examples below follow Microsoft's official documenation._
21982199
> [!NOTE]
21992200
> All request properties are `camelCase`, even though in Dataverse Search API v2.0 they are lowercase.
22002201
2202+
> [!TIP]
2203+
> All objects in requests and responses are automatically converted and encoded as necessary (per official documentation), simplifying developer's work to construct the request and process the response.
2204+
22012205
### Query
22022206
22032207
The following table describes all parameters for a `query` request:
@@ -2299,9 +2303,6 @@ if (!error && value.length) {
22992303
}
23002304
```
23012305
2302-
As you can see all objects are automatically converted and encoded as per official documentation, simplifying developer's
2303-
work to construct the request and to process the response.
2304-
23052306
### Suggest
23062307
23072308
The following table describes all parameters for a `suggest` request:
@@ -2397,12 +2398,12 @@ fuzzy | `boolean` | Use fuzzy search to aid with misspellings. The default is fa
23972398
```ts
23982399
let result = await dynamicsWebApi.autocomplete({
23992400
query: {
2400-
search: "mar"
2401+
search: "Con"
24012402
}
24022403
});
24032404
24042405
//it's similar to:
2405-
result = await dynamicsWebApi.autocomplete("mar");
2406+
result = await dynamicsWebApi.autocomplete("Con");
24062407
24072408
//all data for v2 is returned inside the "response" property
24082409
const { Value: value, Error: error } = result.response;
@@ -2413,7 +2414,7 @@ const { Value: value, Error: error } = result.response;
24132414
24142415
const result = await dynamicsWebApi.autocomplete({
24152416
query: {
2416-
search: "tes",
2417+
search: "Con",
24172418
entities: [{
24182419
name: "account",
24192420
selectColumns: ["name", "createdon"],
@@ -2815,33 +2816,33 @@ This will work __only__ if you import the library like this: `import { DynamicsW
28152816
### In Progress / Feature List
28162817

28172818
- [X] Overloaded functions with rich request options for all Web API operations.
2818-
- [X] Get all pages requests, such as: countAll, retrieveMultipleAll, fetchXmlAll and etc. `Implemented in v.1.2.5`
2819+
- [X] Get all pages requests, such as: countAll, retrieveMultipleAll, fetchXmlAll and etc. `Implemented in v1.2.5`
28192820
- [X] Web API requests that have long URL (more than 2000 characters) should be automatically converted to batch requests.
2820-
Feature is very convenient for big Fetch XMLs. `Implemented in v.1.2.8`
2821+
Feature is very convenient for big Fetch XMLs. `Implemented in v1.2.8`
28212822
- [X] "Formatted" values in responses. For instance: Web API splits information about lookup fields into separate properties,
28222823
the config option "formatted" will enable developers to retrieve all information about such fields in a single requests and access it through DynamicsWebApi custom response objects.
2823-
- [X] Simplified names for "Formatted" properties. `Implemented in v.1.3.0`
2824-
- [X] RUD operations using Alternate Keys. `Implemented in v.1.3.4`
2825-
- [X] Duplicate Detection for Web API v.9.0. `Implemented in v.1.3.4`
2826-
- [X] Ability to use entity names instead of collection names. `Implemented in v.1.4.0`
2827-
- [X] Entity and Attribute Metadata helpers. `Implemented in v.1.4.3`
2828-
- [X] Entity Relationships and Global Option Sets helpers. `Implemented in v.1.4.6`
2829-
- [X] Batch requests. `Implemented in v.1.5.0`
2830-
- [X] TypeScript declaration files `d.ts` `Added in v.1.5.3`
2831-
- [X] Implement `Content-ID` header to reference a request in a Change Set in a batch operation `Added in v.1.5.6`
2832-
- [X] Change Tracking `Added in v.1.5.11`
2824+
- [X] Simplified names for "Formatted" properties. `Implemented in v1.3.0`
2825+
- [X] RUD operations using Alternate Keys. `Implemented in v1.3.4`
2826+
- [X] Duplicate Detection for Web API v.9.0. `Implemented in v1.3.4`
2827+
- [X] Ability to use entity names instead of collection names. `Implemented in v1.4.0`
2828+
- [X] Entity and Attribute Metadata helpers. `Implemented in v1.4.3`
2829+
- [X] Entity Relationships and Global Option Sets helpers. `Implemented in v1.4.6`
2830+
- [X] Batch requests. `Implemented in v1.5.0`
2831+
- [X] TypeScript declaration files `d.ts` `Added in v1.5.3`
2832+
- [X] Implement `Content-ID` header to reference a request in a Change Set in a batch operation `Added in v1.5.6`
2833+
- [X] Change Tracking `Added in v1.5.11`
28332834
- [X] Support for Aggregate and Grouping results `Added in v1.6.4`
28342835
- [X] Support for Timeout option in the configuration `Added in v1.6.10`
2835-
- [X] Impersonate a user based on their Azure Active Directory (AAD) object id. `Added in v.1.6.12`
2836-
- [X] File upload/download/delete for a File Field. `Added in v.1.7.0`
2837-
- [X] Full proxy support. `Added in v.1.7.2`
2838-
- [X] Refactoring and conversion to TypeScript. `Added in v.2.0.0`
2839-
- [X] Implement [Dataverse Search API 1.0](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/search/legacy). `Added in v.2.0.0`
2840-
- [X] Allow custom headers to be passed to the request [#151](https://github.com/AleksandrRogov/DynamicsWebApi/issues/151). `Added in v.2.1.0`
2841-
- [X] Support Microsoft Power Pages. `Added in v.2.1.0`
2842-
- [X] Background Operations for custom actions. `Added in v.2.3.0`
2843-
- [X] Support Search API 2.0 [#174](https://github.com/AleksandrRogov/DynamicsWebApi/issues/174). `Added in v.2.3.0`
2844-
- [ ] Support for the [session token](https://learn.microsoft.com/en-ca/power-apps/developer/data-platform/use-elastic-tables?tabs=webapi#work-with-the-session-token). `Coming in v.2.3.1`
2836+
- [X] Impersonate a user based on their Azure Active Directory (AAD) object id. `Added in v1.6.12`
2837+
- [X] File upload/download/delete for a File Field. `Added in v1.7.0`
2838+
- [X] Full proxy support. `Added in v1.7.2`
2839+
- [X] Refactoring and conversion to TypeScript. `Added in v2.0.0`
2840+
- [X] Implement [Dataverse Search API 1.0](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/search/legacy). `Added in v2.0.0`
2841+
- [X] Allow custom headers to be passed to the request [#151](https://github.com/AleksandrRogov/DynamicsWebApi/issues/151). `Added in v2.1.0`
2842+
- [X] Support Microsoft Power Pages. `Added in v2.1.0`
2843+
- [X] Background Operations for custom actions. `Added in v2.3.0`
2844+
- [X] Support Search API 2.0 [#174](https://github.com/AleksandrRogov/DynamicsWebApi/issues/174). `Added in v2.3.0`
2845+
- [ ] [Session token](https://learn.microsoft.com/en-ca/power-apps/developer/data-platform/use-elastic-tables?tabs=webapi#work-with-the-session-token) support. `Coming in v2.3.1`
28452846
- [ ] Custom requests.
28462847

28472848
Many more features to come!

0 commit comments

Comments
 (0)