@azure-rest/purview-workflow 1.0.0-alpha.20250108.1 → 1.0.0-alpha.20250109.2

package/README.md

@@ -22,7 +22,7 @@ Use the client library for Purview Workflow to:
 
 ### Create and authenticate a `PurviewWorkflowClient`
 
-Since the Workflow service uses an Azure Active Directory (AAD) bearer token for authentication and identification, an email address should be encoded into the token to allow for notification when using Workflow. It is recommended that the [Azure Identity][azure_identity] library be used  with a the [UsernamePasswordCredential][username_password_credential]. Before using the [Azure Identity][azure_identity] library with Workflow, [an application][app_registration] should be registered and used for the clientId passed to the [UsernamePasswordCredential][username_password_credential].
+Since the Workflow service uses an Azure Active Directory (AAD) bearer token for authentication and identification, an email address should be encoded into the token to allow for notification when using Workflow. It is recommended that the [Azure Identity][azure_identity] library be used with a the [UsernamePasswordCredential][username_password_credential]. Before using the [Azure Identity][azure_identity] library with Workflow, [an application][app_registration] should be registered and used for the clientId passed to the [UsernamePasswordCredential][username_password_credential].
 Set the values of the client ID, tenant ID, username and password as environment variables:
 AZURE_CLIENT_ID, AZURE_TENANT_ID, USERNAME, PASSWORD
 
@@ -40,13 +40,8 @@ const username = process.env["USERNAME"];
 const password = process.env["PASSWORD"];
 const client = PurviewWorkflow(
   endpoint,
-  new UsernamePasswordCredential(
-        tenantId,
-        clientId,
-        username,
-        password
-      )
-  );
+  new UsernamePasswordCredential(tenantId, clientId, username, password),
+);
 ```
 
 ## Examples
@@ -60,7 +55,7 @@ The following section provides several code snippets covering some of the most c
 
 ```typescript
 import createPurviewWorkflowClient, {
-  SubmitUserRequestsParameters
+  SubmitUserRequestsParameters,
 } from "@azure-rest/purview-workflow";
 import { UsernamePasswordCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
@@ -74,7 +69,7 @@ async function userRequestsSubmit() {
   const username = process.env["USERNAME"];
   const password = process.env["PASSWORD"];
 
-  const credential = new UsernamePasswordCredential(tenantId , clientId, username, password);
+  const credential = new UsernamePasswordCredential(tenantId, clientId, username, password);
   const client = createPurviewWorkflowClient(endpoint, credential);
   const options: SubmitUserRequestsParameters = {
     body: {
@@ -87,12 +82,12 @@ async function userRequestsSubmit() {
               name: "term",
               anchor: { glossaryGuid: "20031e20-b4df-4a66-a61d-1b0716f3fa48" },
               nickName: "term",
-              status: "Approved"
-            }
-          }
-        }
-      ]
-    }
+              status: "Approved",
+            },
+          },
+        },
+      ],
+    },
   };
   const result = await client.path("/userrequests").post(options);
   if (isUnexpected(result)) {
@@ -109,7 +104,7 @@ userRequestsSubmit().catch(console.error);
 ```typescript
 // This taskId represents an existing workflow task. The id can be obtained by calling GET /workflowtasks API.
 import createPurviewWorkflowClient, {
-  SubmitUserRequestsParameters
+  SubmitUserRequestsParameters,
 } from "@azure-rest/purview-workflow";
 import { UsernamePasswordCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
@@ -125,7 +120,7 @@ async function approvalTaskApprove() {
   const client = createPurviewWorkflowClient(endpoint, credential);
   const taskId = "98d98e2c-23fa-4157-a3f8-ff8ce5cc095c";
   const options: ApproveApprovalTaskParameters = {
-    body: { comment: "Thanks for raising this!" }
+    body: { comment: "Thanks for raising this!" },
   };
   const result = await client
     .path("/workflowtasks/{taskId}/approve-approval", taskId)
@@ -154,9 +149,10 @@ setLogLevel("info");
 For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
 
 <!-- LINKS -->
+
 [product_documentation]: https://learn.microsoft.com/azure/purview/concept-workflow
 [azure_subscription]: https://azure.microsoft.com/free/dotnet/
-[purview_resource]: https://docs.microsoft.com/azure/purview/create-catalog-portal
+[purview_resource]: https://learn.microsoft.com/azure/purview/create-catalog-portal
 [azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#readme
 [app_registration]: https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
 [username_password_credential]: https://learn.microsoft.com/javascript/api/@azure/identity/usernamepasswordcredential?view=azure-node-latest

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure-rest/purview-workflow",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "1.0.0-alpha.20250108.1",
+  "version": "1.0.0-alpha.20250109.2",
   "description": "A generated SDK for PurviewWorkflow.",
   "keywords": [
     "node",
@@ -100,8 +100,7 @@
     "productSlugs": [
       "azure"
     ],
-    "disableDocsMs": true,
-    "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure-rest/purview-workflow?view=azure-node-preview"
+    "disableDocsMs": true
   },
   "type": "module",
   "tshy": {