@azure-rest/purview-datamap 1.0.0-beta.1 → 1.0.0-beta.3

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+## Release History
+
+### 1.0.0-beta.3 (2025-04-08)
+
+#### Bugs Fixed
+
+- Updated type of endorsements from str to list[str] in SuggestResultValue and SuggestResultValue models.
+
+### 1.0.0-beta.2 (2025-02-10)
+
+#### Features Added
+- refresh @azure-rest/purview-datamap sdk
+
+### 1.0.0-beta.1 (2024-03-04)
+  - Initial Release

package/README.md

@@ -8,7 +8,7 @@ Key links:
 
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-datamap-rest)
 - [Package (NPM)](https://www.npmjs.com/package/@azure-rest/purview-datamap)
-- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/purview-datamap?view=azure-node-preview)
+- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/purview-datamap?view=azure-node-preview)
 - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-datamap-rest/samples)
 
 ## Getting started
@@ -35,7 +35,7 @@ To use an [Azure Active Directory (AAD) token credential](https://github.com/Azu
 provide an instance of the desired credential type obtained from the
 [@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
 
-To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) 
+To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
 
 After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
 As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
@@ -44,6 +44,18 @@ can be used to authenticate the client.
 Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
 AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
 
+Use the returned token credential to authenticate the client:
+
+```ts snippet:ReadmeSampleCreateClient_Node
+import PurviewDataMap from "@azure-rest/purview-datamap";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = PurviewDataMap(
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
+);
+```
+
 ## Examples
 
 The following sections provide several code snippets covering some of the most common Purview DataMap scenarios, including:
@@ -52,28 +64,48 @@ The following sections provide several code snippets covering some of the most c
 
 ### Get All Type Definitions
 
-```typescript
-import PurviewDataMap from "@azure-rest/purview-datamap";
+```ts snippet:ReadmeSampleGetAllTypeDefinitions
+import PurviewDataMap, { isUnexpected } from "@azure-rest/purview-datamap";
 import { DefaultAzureCredential } from "@azure/identity";
-import dotenv from "dotenv";
-import { isUnexpected } from "@azure-rest/purview-datamap";
 
-dotenv.config();
+const client = PurviewDataMap(
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
+);
+
+const result = await client.path("/atlas/v2/types/typedefs").get();
+
+if (isUnexpected(result)) {
+  throw result.body;
+}
 
-const endpoint = process.env["ENDPOINT"] || "";
+for (const entityDef of result.body?.businessMetadataDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
 
-async function main() {
-  console.log("== List entity typedefs sample ==");
-  const client = PurviewDataMap(endpoint, new DefaultAzureCredential());
+for (const entityDef of result.body?.classificationDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
 
-  const result = await client.path("/atlas/v2/types/typedefs").get();
+for (const entityDef of result.body?.entityDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
 
-  if (isUnexpected(result)) {
-    throw result;
-  }
+for (const entityDef of result.body?.enumDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
 }
 
-main().catch(console.error);
+for (const entityDef of result.body?.relationshipDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
+
+for (const entityDef of result.body?.structDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
+
+for (const entityDef of result.body?.termTemplateDefs) {
+  console.log(`Entity Definition Name: ${entityDef.name}`);
+}
 ```
 
 ## Troubleshooting
@@ -82,8 +114,8 @@ main().catch(console.error);
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```