Merge branch 'master' into readme-consolidation

.github/styles/config/vocabularies/Docs/accept.txt

@@ -1,9 +1,90 @@
-apify(?=-\w+)
+Apify(?=-\w+)
+@apify\.com
+\bApify\b
 Actor(s)?
+SDK(s)
+[Ss]torages
+Crawlee
+[Aa]utoscaling
+CU
+
 booleans
-Docusaurus
 env
+npm
+serverless
+[Bb]oolean
+node_modules
+[Rr]egex
+[Mm]onorepo
+[Gg]ist
+SDK
+Dockerfile
+Docker's
+
+Docusaurus
 navbar
 nginx
 npm
 camelCase
+
+:::caution
+:::note
+:::info
+:::tip
+:::warning
+
+maxWidth
+startUrls
+
+PDFs
+dataset's
+gif
+Gzip
+
+API's
+APIs
+webhook's
+idempotency
+backoff
+
+Authy
+reCaptcha
+OAuth
+untrusted
+unencrypted
+proxied
+
+LLM
+embedder
+chatbot
+[Ll]angchain
+
+[Kk]eboola
+[Aa]irbyte
+[Qq]drant
+[Pp]inecone
+[Mm]ilvus
+[Zz]illiz
+llama_index
+[Ff]lowise
+
+exploitability
+[Ww]hitepaper
+[Cc]ron
+scalably
+metamorph
+hostname
+IPs
+unscoped
+multistep
+[Aa]utogenerated
+preconfigured
+[Dd]atacenter
+
+[Ww]ikipedia
+[Zz]apier
+[Tt]rello
+[Pp]refill
+
+
+[Mm]ultiselect

.github/workflows/lychee.yml

@@ -36,7 +36,7 @@ jobs:
 
             -   name: Run Lychee Link Checker
                 id: lychee
-                uses: lycheeverse/lychee-action@v2.1.0
+                uses: lycheeverse/lychee-action@v2.2.0
                 env:
                     GITHUB_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
                 with:

.github/workflows/vale.yaml

@@ -32,3 +32,4 @@ jobs:
                     fail_on_error: true
                     vale_flags: '--minAlertLevel=error'
                     reporter: github-pr-annotations
+

.gitignore

@@ -21,3 +21,4 @@ tsconfig.tsbuildinfo
 sources/api/*
 !sources/api/sidebars.js
 apify-api.yaml
+apify-docs-theme/package-lock.json

.redocly.yaml

@@ -27,3 +27,4 @@ plugins:
 decorators:
     apify/legacy-doc-url-decorator: on
     apify/client-references-links-decorator: on
+    apify/code-samples-decorator: on

.vale.ini

@@ -0,0 +1,28 @@
+StylesPath = .github/styles
+MinAlertLevel = warning
+IgnoredScopes = code, tt, table, tr, td
+
+Vocab = Docs
+
+Packages = write-good, Microsoft
+
+[formats]
+mdx = md
+
+[*.md]
+BasedOnStyles = Vale, Apify, write-good, Microsoft
+# Ignore URLs, HTML/XML tags starting with capital letter, lines containing = sign, http & https URL ending with ] or ) & email addresses
+TokenIgnores = (<\/?[A-Z].+>), ([^\n]+=[^\n]*), (\[[^\]]+\]\([^\)]+\)), ([^\n]+@[^\n]+\.[^\n]), ({[^}]*}), (`[^`]*`), (`\w+`)
+Vale.Spelling = YES
+
+
+# Disabling rules (NO)
+Microsoft.Contractions = NO
+Microsoft.Foreign = NO
+Microsoft.We = NO
+Microsoft.Quotes = NO
+Microsoft.ThereIs = NO
+Microsoft.Auto = NO
+Microsoft.URLFormat = NO
+Microsoft.GeneralURL = NO
+Microsoft.RangeFormat = NO

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const updatedActor = await apifyClient
+    .actor('<ACTOR ID>')
+    .update({
+        title: 'New title',
+    });
+
+console.log(updatedActor);

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+await apifyClient
+    .actor('<ACTOR ID>')
+    .version('0.1')
+    .delete();

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

@@ -0,0 +1,10 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+await apifyClient
+    .actor('<ACTOR ID>')
+    .version('0.1')
+    .envVar('MY_ENV_VAR')
+    .delete();

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

@@ -0,0 +1,12 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const envVar = await apifyClient
+    .actor('<ACTOR ID>')
+    .version('0.1')
+    .envVar('MY_ENV_VAR')
+    .get();
+
+console.log(envVar);

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

@@ -0,0 +1,15 @@
+import { ApifyClient } from 'apify-client';
+
+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: 'my-new-value',
+    });
+
+console.log(updatedEnvVar);

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

@@ -0,0 +1,12 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const { items } = await apifyClient
+    .actor('<ACTOR ID>')
+    .version('0.1')
+    .envVars()
+    .list();
+
+console.log(items);

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

@@ -0,0 +1,16 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const envVar = await apifyClient
+    .actor('<ACTOR ID>')
+    .version('0.1')
+    .envVars()
+    .create({
+        name: 'MY_ENV_VAR',
+        value: 'my-new-value',
+        isSecret: true,
+    });
+
+console.log(envVar);

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

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

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

@@ -0,0 +1,13 @@
+import { ApifyClient } from 'apify-client';
+
+const apifyClient = new ApifyClient({
+    token: '<TOKEN>',
+});
+const updatedVersion = await apifyClient
+    .actor('<ACTOR ID>')
+    .version('0.1')
+    .update({
+        buildTag: 'latest',
+    });
+
+console.log(updatedVersion);

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

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

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

@@ -0,0 +1,15 @@
+import { ApifyClient } from 'apify-client';
+
+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/repo',
+    });
+
+console.log(version);