Merge branch 'feat/code-samples-webhooks-builds-runs' into feat/code-samples-tasks

m-murasovs · m-murasovs · commit 6a75eb4137b8 · 2024-12-11T18:29:59.000+01:00
diff --git a/apify-api/openapi/code_samples/javascript/act_builds_get.js b/apify-api/openapi/code_samples/javascript/act_builds_get.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const { items } = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .actor('<ACTOR ID>')
     .builds()
     .list();
 
diff --git a/apify-api/openapi/code_samples/javascript/act_builds_post.js b/apify-api/openapi/code_samples/javascript/act_builds_post.js
@@ -1,7 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const build = await apifyClient.actor('apify~my-sample-actor').build('0.0');
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const build = await apifyClient
+    .actor('<ACTOR ID>')
+    .build('0.0');
 
 console.log(build);
diff --git a/apify-api/openapi/code_samples/javascript/act_delete.js b/apify-api/openapi/code_samples/javascript/act_delete.js
@@ -1,5 +1,6 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-await apifyClient.actor('apify~my-sample-actor').delete();
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+await apifyClient.actor('<ACTOR ID>').delete();
diff --git a/apify-api/openapi/code_samples/javascript/act_get.js b/apify-api/openapi/code_samples/javascript/act_get.js
@@ -1,7 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const actor = await apifyClient.actor('apify~my-sample-actor').get();
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const actor = await apifyClient
+    .actor('<ACTOR ID>')
+    .get();
 
 console.log(actor);
diff --git a/apify-api/openapi/code_samples/javascript/act_put.js b/apify-api/openapi/code_samples/javascript/act_put.js
@@ -1,9 +1,12 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const updatedActor = await apifyClient.actor('apify~my-sample-actor').update({
-    title: 'New title',
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
 });
+const updatedActor = await apifyClient
+    .actor('<ACTOR ID>')
+    .update({
+        title: 'New title',
+    });
 
 console.log(updatedActor);
diff --git a/apify-api/openapi/code_samples/javascript/act_runs_get.js b/apify-api/openapi/code_samples/javascript/act_runs_get.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const { items } = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .actor('<ACTOR ID>')
     .runs()
     .list();
 
diff --git a/apify-api/openapi/code_samples/javascript/act_runs_last_get.js b/apify-api/openapi/code_samples/javascript/act_runs_last_get.js
@@ -1,7 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const lastRun = await apifyClient.actor('apify~my-sample-actor').lastRun();
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const lastRun = await apifyClient
+    .actor('<ACTOR ID>')
+    .lastRun();
 
 console.log(lastRun);
diff --git a/apify-api/openapi/code_samples/javascript/act_runs_post.js b/apify-api/openapi/code_samples/javascript/act_runs_post.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const run = await apifyClient.actor('apify~my-sample-actor')
-    .start(/** Your Actor's input */);
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const run = await apifyClient
+    .actor('<ACTOR ID>')
+    .start({ /** <ACTOR INPUT> */ });
 
 console.log(run);
diff --git a/apify-api/openapi/code_samples/javascript/act_version_delete.js b/apify-api/openapi/code_samples/javascript/act_version_delete.js
@@ -1,7 +1,9 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+await apifyClient
+    .actor('<ACTOR ID>')
     .version('0.1')
     .delete();
diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+await apifyClient
+    .actor('<ACTOR ID>')
     .version('0.1')
     .envVar('MY_ENV_VAR')
     .delete();
diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const envVar = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const envVar = await apifyClient
+    .actor('<ACTOR ID>')
     .version('0.1')
     .envVar('MY_ENV_VAR')
     .get();
diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js
@@ -1,13 +1,15 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const updatedEnvVar = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const updatedEnvVar = await apifyClient
+    .actor('<ACTOR ID>')
     .version('0.1')
     .envVar('MY_ENV_VAR')
     .update({
         name: 'MY_ENV_VAR',
-        value: '54321',
+        value: 'my-new-value',
     });
 
 console.log(updatedEnvVar);
diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const { items } = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .actor('<ACTOR ID>')
     .version('0.1')
     .envVars()
     .list();
diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js
@@ -1,13 +1,15 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const envVar = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const envVar = await apifyClient
+    .actor('<ACTOR ID>')
     .version('0.1')
     .envVars()
     .create({
         name: 'MY_ENV_VAR',
-        value: '12345',
+        value: 'my-new-value',
         isSecret: true,
     });
 
diff --git a/apify-api/openapi/code_samples/javascript/act_version_get.js b/apify-api/openapi/code_samples/javascript/act_version_get.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const version = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const version = await apifyClient
+    .actor('<ACTOR ID>')
     .version('0.1')
     .get();
 
diff --git a/apify-api/openapi/code_samples/javascript/act_version_put.js b/apify-api/openapi/code_samples/javascript/act_version_put.js
@@ -1,11 +1,13 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const updatedVersion = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const updatedVersion = await apifyClient
+    .actor('<ACTOR ID>')
     .version('0.1')
     .update({
-        gitRepoUrl: 'https://github.com/my-github-account/new-actor-repo',
+        buildTag: 'latest',
     });
 
 console.log(updatedVersion);
diff --git a/apify-api/openapi/code_samples/javascript/act_versions_get.js b/apify-api/openapi/code_samples/javascript/act_versions_get.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const { items } = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .actor('<ACTOR ID>')
     .versions()
     .list();
 
diff --git a/apify-api/openapi/code_samples/javascript/act_versions_post.js b/apify-api/openapi/code_samples/javascript/act_versions_post.js
@@ -1,13 +1,15 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const version = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const version = await apifyClient
+    .actor('<ACTOR ID>')
     .versions()
     .create({
         versionNumber: '0.1',
         sourceType: 'GIT_REPO',
-        gitRepoUrl: 'https://github.com/my-github-account/actor-repo',
+        gitRepoUrl: 'https://github.com/my/repo',
     });
 
 console.log(version);
diff --git a/apify-api/openapi/code_samples/javascript/act_webhooks_get.js b/apify-api/openapi/code_samples/javascript/act_webhooks_get.js
@@ -1,8 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-// Replace apify~my-sample-actor with your Actor's ID or technical name
-const { items } = await apifyClient.actor('apify~my-sample-actor')
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .actor('<ACTOR ID>')
     .webhooks()
     .list();
 
diff --git a/apify-api/openapi/code_samples/javascript/acts_get.js b/apify-api/openapi/code_samples/javascript/acts_get.js
@@ -1,6 +1,10 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-const { items } = await apifyClient.actors().list();
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .actors()
+    .list();
 
 console.log(items);
diff --git a/apify-api/openapi/code_samples/javascript/acts_post.js b/apify-api/openapi/code_samples/javascript/acts_post.js
@@ -1,6 +1,12 @@
 import { ApifyClient } from 'apify-client';
 
-const apifyClient = new ApifyClient({ token: 'my-token' });
-const myActor = await apifyClient.actors().create({ name: 'my-sample-actor' });
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const myActor = await apifyClient
+    .actors()
+    .create({
+        name: '<ACTOR NAME>',
+    });
 
 console.log(myActor);
diff --git a/sources/platform/actors/development/programming_interface/environment_variables.md b/sources/platform/actors/development/programming_interface/environment_variables.md
@@ -23,9 +23,11 @@ Here's a table of key system environment variables:
 | Environment Variable | Description |
 |----------------------|-------------|
 | `ACTOR_ID` | ID of the Actor. |
+| `ACTOR_FULL_NAME` | Full technical name of the Actor, in the format `owner-username/actor-name`. |
 | `ACTOR_RUN_ID` | ID of the Actor run. |
 | `ACTOR_BUILD_ID` | ID of the Actor build used in the run. |
 | `ACTOR_BUILD_NUMBER` | Build number of the Actor build used in the run. |
+| `ACTOR_BUILD_TAGS` | A comma-separated list of tags of the Actor build used in the run. Note that this environment variable is assigned at the time of start of the Actor and doesn't change over time, even if the assigned build tags change. |
 | `ACTOR_TASK_ID` | ID of the Actor task. Empty if Actor is run outside of any task, e.g. directly using the API. |
 | `ACTOR_EVENTS_WEBSOCKET_URL` | Websocket URL where Actor may listen for [events](/platform/actors/development/programming-interface/system-events) from Actor platform. |
 | `ACTOR_DEFAULT_DATASET_ID` | Unique identifier for the default dataset associated with the current Actor run. |
