DOCS-3163: Update TS connection code (#3719)

viamrobotics · Dec 2, 2024 · 2979eb9 · 2979eb9
1 parent 49b57ef
commit 2979eb9
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 43 deletions.
diff --git a/docs/how-tos/control-motor.md b/docs/how-tos/control-motor.md
@@ -491,14 +491,14 @@ const main = async () => {
 
   const machine = await VIAM.createRobotClient({
     host,
-    credential: {
-      type: "api-key",
-      // Replace "<API-KEY>" (including brackets) with your machine's API key
-      payload: "<API-KEY>",
+    credentials: {
+      type: 'api-key'
+          /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
+      payload: '<API-KEY>',
+      authEntity: '<API-KEY-ID>'
+      /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
     },
-    // Replace "<API-KEY-ID>" (including brackets) with your machine's API key ID
-    authEntity: "<API-KEY-ID>",
-    signalingAddress: "https://app.viam.com:443",
+    signalingAddress: 'https://app.viam.com:443',
   });
 
   button().onclick = async () => {

diff --git a/docs/how-tos/drive-rover.md b/docs/how-tos/drive-rover.md
@@ -520,14 +520,14 @@ async function main() {
 
   const machine = await VIAM.createRobotClient({
     host,
-    credential: {
-      type: "api-key",
-      // Replace "<API-KEY>" (including brackets) with your machine's API key
-      payload: "<API-KEY>",
+    credentials: {
+      type: 'api-key'
+          /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
+      payload: '<API-KEY>',
+      authEntity: '<API-KEY-ID>'
+      /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
     },
-    // Replace "<API-KEY-ID>" (including brackets) with your machine's API key ID
-    authEntity: "<API-KEY-ID>",
-    signalingAddress: "https://app.viam.com:443",
+    signalingAddress: 'https://app.viam.com:443',
   });
 
   button().onclick = async () => {
@@ -1017,14 +1017,14 @@ const main = async () => {
 
   const machine = await VIAM.createRobotClient({
     host,
-    credential: {
-      type: "api-key",
-      // Replace "<API-KEY>" (including brackets) with your machine's API key
-      payload: "<API-KEY>",
+    credentials: {
+      type: 'api-key'
+          /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
+      payload: '<API-KEY>',
+      authEntity: '<API-KEY-ID>'
+      /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
     },
-    // Replace "<API-KEY-ID>" (including brackets) with your machine's API key ID
-    authEntity: "<API-KEY-ID>",
-    signalingAddress: "https://app.viam.com:443",
+    signalingAddress: 'https://app.viam.com:443',
   });
 
   button().onclick = async () => {

diff --git a/docs/sdks/_index.md b/docs/sdks/_index.md
@@ -212,14 +212,14 @@ async function main() {
 
   const robot = await VIAM.createRobotClient({
     host,
-    credential: {
-      type: "api-key",
-      // Replace "<API-KEY>" (including brackets) with your machine's API key
-      payload: "<API-KEY>",
+    credentials: {
+      type: 'api-key'
+          /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
+      payload: '<API-KEY>',
+      authEntity: '<API-KEY-ID>'
+      /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
     },
-    // Replace "<API-KEY-ID>" (including brackets) with your API key ID
-    authEntity: "<API-KEY-ID>",
-    signalingAddress: "https://app.viam.com:443",
+    signalingAddress: 'https://app.viam.com:443',
   });
 
   console.log("Resources:");

diff --git a/docs/tutorials/control/air-quality-fleet.md b/docs/tutorials/control/air-quality-fleet.md
@@ -438,14 +438,13 @@ The following instructions describe how to set up an API key for one location.
 
     async function main() {
       const opts: VIAM.ViamClientOptions = {
-        credential: {
-          type: "api-key",
-          // Key with location operator permissions
-          // Replace <API-KEY> (including angle brackets)
-          payload: "<API-KEY>",
-          // Replace <API-KEY-ID> (including angle brackets)
-          authEntity: "<API-KEY-ID>",
-        },
+        credentials: {
+          type: 'api-key'
+              /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
+          payload: '<API-KEY>',
+          authEntity: '<API-KEY-ID>'
+          /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
+        }
       };
 
       const orgID: string = "<ORGANIZATION ID>"; // Replace

diff --git a/static/include/program/authenticate.md b/static/include/program/authenticate.md
@@ -50,14 +50,14 @@ const host = "ADDRESS FROM THE VIAM APP";
 
 const robot = await VIAM.createRobotClient({
   host,
-  credential: {
-    type: "api-key",
-    // Replace "<API-KEY>" (including brackets) with your machine's API key
-    payload: "<API-KEY>",
+  credentials: {
+    type: 'api-key'
+        /* Replace "<API-KEY>" (including brackets) with your machine's api key */,
+    payload: '<API-KEY>',
+    authEntity: '<API-KEY-ID>'
+    /* Replace "<API-KEY-ID>" (including brackets) with your machine's api key id */,
   },
-  // Replace "<API-KEY-ID>" (including brackets) with your machine's API key ID
-  authEntity: "<API-KEY-ID>",
-  signalingAddress: "https://app.viam.com:443",
+  signalingAddress: 'https://app.viam.com:443',
 });
 ```