Update authVersion comments

slackapi · Feb 28, 2022 · affafa2 · affafa2
1 parent 469962d
commit affafa2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/packages/oauth/src/install-provider-options.ts b/packages/oauth/src/install-provider-options.ts
@@ -70,7 +70,10 @@ export interface InstallProviderOptions {
   directInstall?: boolean; // default false, disables rendering "Add to Slack" page for /slack/install when true
 
   /**
-   * The default is "v2" ("v1" is for "classic" apps)
+   * The default is "v2" (a.k.a. Granular Bot Permissions), different from "v1" (a.k.a. "Classic Apps").
+   * More details here:
+   * - https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3
+   * - https://api.slack.com/authentication/migration
    */
   authVersion?: 'v1' | 'v2'; // default 'v2'
 

diff --git a/packages/oauth/src/install-provider.ts b/packages/oauth/src/install-provider.ts
@@ -42,7 +42,10 @@ export class InstallProvider {
   // Client Secret, which can be found under the Basic Information section of your application on https://api.slack.com/apps
   private clientSecret: string;
 
-  // The default is "v2" ("v1" is for "classic" apps)
+  // The default is "v2" (a.k.a. Granular Bot Permissions), different from "v1" (a.k.a. "Classic Apps").
+  // More details here:
+  // - https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3
+  // - https://api.slack.com/authentication/migration
   private authVersion: string;
 
   // @slack/logger logging used in this class