feat: add code samples for Runs and Builds (#1340)

apify-api/openapi/code_samples/javascript/act_runs_post.js

@@ -5,6 +5,6 @@ const apifyClient = new ApifyClient({
 });
 const run = await apifyClient
     .actor('<ACTOR ID>')
-    .start({ 'foo': 'bar' });
+    .start({ foo: 'bar' });
 
 console.log(run);

apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const abortedBuild = await apifyClient
+    .build('<BUILD ID>')
+    .abort();
+
+console.log(abortedBuild);

apify-api/openapi/code_samples/javascript/actorBuild_delete.js

@@ -0,0 +1,6 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+await apifyClient.build('<BUILD ID>').delete();

apify-api/openapi/code_samples/javascript/actorBuild_get.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const build = await apifyClient
+    .build('<BUILD ID>')
+    .get();
+
+console.log(build);

apify-api/openapi/code_samples/javascript/actorBuild_log_get.js

@@ -0,0 +1,11 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const buildLog = await apifyClient
+    .build('<BUILD ID>')
+    .log()
+    .get();
+
+console.log(buildLog);

apify-api/openapi/code_samples/javascript/actorBuilds_get.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .builds()
+    .list();
+
+console.log(items);

apify-api/openapi/code_samples/javascript/actorRun_abort_post.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const abortedRun = await apifyClient
+    .run('<RUN ID>')
+    .abort();
+
+console.log(abortedRun);

apify-api/openapi/code_samples/javascript/actorRun_delete.js

@@ -0,0 +1,6 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+await apifyClient.run('<RUN ID>').delete();

apify-api/openapi/code_samples/javascript/actorRun_get.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const run = await apifyClient
+    .run('<RUN ID>')
+    .get();
+
+console.log(run);

apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const metamorphedRun = await apifyClient
+    .run('<RUN ID>')
+    .metamorph('<ACTOR ID>');
+
+console.log(metamorphedRun);

apify-api/openapi/code_samples/javascript/actorRun_put.js

@@ -0,0 +1,12 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const updatedRun = await apifyClient
+    .run('<RUN ID>')
+    .update({
+        statusMessage: 'Actor has finished',
+    });
+
+console.log(updatedRun);

apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const rebootedRun = await apifyClient
+    .run('<RUN ID>')
+    .reboot();
+
+console.log(rebootedRun);

apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const resurrectedRun = await apifyClient
+    .run('<RUN ID>')
+    .resurrect();
+
+console.log(resurrectedRun);

apify-api/openapi/code_samples/javascript/actorRuns_get.js

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .runs()
+    .list();
+
+console.log(items);

apify-api/openapi/code_samples/javascript/actorTask_input_put.js

@@ -5,6 +5,6 @@ const apifyClient = new ApifyClient({
 });
 const updatedInput = await apifyClient
     .task('<TASK ID>')
-    .updateInput({ 'foo': 'baz' });
+    .updateInput({ foo: 'baz' });
 
 console.log(updatedInput);

apify-api/plugins/decorators/code-samples-decorator.js

@@ -24,8 +24,12 @@ function CodeSamplesDecorator(target) {
 
     const codeSamples = [];
 
+    // For some reason, the operationId for resurrect run is PostResurrectRun,
+    // so we change it here to keep the file names consistent
+    const operationId = target.operationId === 'PostResurrectRun' ? 'actorRun_resurrect_post' : target.operationId;
+
     for (const { lang, label } of LANGUAGES) {
-        const codeSamplePath = path.join(__dirname, `../../openapi/code_samples/${lang.toLowerCase()}/${target.operationId}.js`);
+        const codeSamplePath = path.join(__dirname, `../../openapi/code_samples/${lang.toLowerCase()}/${operationId}.js`);
 
         if (!existsSync(codeSamplePath)) {
             // Just use this console log in development to see which operations are missing a code sample.