Add Missing Descriptions to all Args. (#3048)

* Added description for args in Domain commands * Added missing descriptions for args in Addons command topic * Added missing descriptions for args in Local command topic * Added missing descriptions for args in CI command topic * Added missing descriptions for args in the Certs command topic * Added missing descriptions for args in the Labs command topic * Added missing descriptions for args in the Spaces command topic * Added missing descriptions for args in the Apps command topic * Added missing descriptions for args in the Access command topic * Added missing descriptions for args in the Features command topic * Added missing descriptions for args in the Keys command topic * Added missing descriptions for args in the Sessions command topic * Added missing descriptions for args in the Members command topic * Added missing descriptions for args in the PG command topic * Added missing descriptions for args in the Config command topic * Added missing descriptions for args in the Webhooks command topic * Added missing descriptions for args in the Authorizations command topic * Added missing descriptions for args in the Redis and Releases command topic * Added missing descriptions for args in the Redis and Drains command topic * Added missing descriptions for args in the Dynos command topic * Added missing descriptions for args in the Clients command topic * Updated unit tests to include new descriptions * Updates from ux feedback * Updated database arg descriptions * Added PG database arg descriptions (#3054) * Added PG database arg descriptions * Update packages/cli/src/package.nls.json +1 Co-authored-by: Sandy Lai <[email protected]> * Update packages/cli/src/package.nls.json Co-authored-by: Sandy Lai <[email protected]> * Update packages/cli/src/package.nls.json Co-authored-by: Sandy Lai <[email protected]> * Update packages/cli/src/package.nls.json Co-authored-by: Sandy Lai <[email protected]> --------- Co-authored-by: Sandy Lai <[email protected]> * Updates from Sandy's feedback * Update packages/cli/src/commands/addons/plans.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/clients/info.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/clients/rotate.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/clients/update.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/backups/cancel.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/local/index.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/ci/info.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/test/unit/commands/ci/info.unit.test.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/kill.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/ci/rerun.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/copy.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/addons/open.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/apps/open.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/clients/create.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/clients/create.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/config/get.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/keys/remove.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/backups/delete.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/backups/download.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/backups/info.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/backups/restore.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/backups/url.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/copy.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/diagnose.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/pg/settings/auto-explain/log-min-duration.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/ps/restart.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/ps/stop.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/cli.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/credentials.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/info.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/keyspace-notifications.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/maintenance.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/maxmemory.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/promote.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/stats-reset.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/timeout.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/upgrade.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/redis/wait.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/spaces/drains/set.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/webhooks/info.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/commands/webhooks/update.ts Co-authored-by: Helen Cheng <[email protected]> * Update packages/cli/src/package.nls.json Co-authored-by: Helen Cheng <[email protected]> --------- Co-authored-by: Sandy Lai <[email protected]> Co-authored-by: Helen Cheng <[email protected]>
heroku · Nov 6, 2024 · 634e0d9 · 634e0d9
1 parent 80ab352
commit 634e0d9
Show file tree

Hide file tree

Showing 140 changed files with 287 additions and 175 deletions.
diff --git a/packages/cli/src/commands/access/add.ts b/packages/cli/src/commands/access/add.ts
@@ -18,7 +18,7 @@ export default class AccessAdd extends Command {
   ]
 
   static args = {
-    email: Args.string({required: true}),
+    email: Args.string({required: true, description: 'email address of the team member'}),
   }
 
   public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/access/update.ts b/packages/cli/src/commands/access/update.ts
@@ -18,7 +18,7 @@ export default class Update extends Command {
     };
 
     static args = {
-      email: Args.string({required: true}),
+      email: Args.string({required: true, description: 'email address of the team member'}),
     };
 
     public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/attach.ts b/packages/cli/src/commands/addons/attach.ts
@@ -16,7 +16,7 @@ export default class Attach extends Command {
     };
 
     static args = {
-      addon_name: Args.string({required: true}),
+      addon_name: Args.string({required: true, description: 'unique identifier or globally unique name of the add-on'}),
     };
 
     public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/create.ts b/packages/cli/src/commands/addons/create.ts
@@ -64,7 +64,7 @@ export default class Create extends Command {
   }
 
   static args = {
-    'service:plan': Args.string({required: true}),
+    'service:plan': Args.string({required: true, description: 'unique identifier or unique name of the add-on service plan'}),
   }
 
   public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/destroy.ts b/packages/cli/src/commands/addons/destroy.ts
@@ -23,7 +23,7 @@ export default class Destroy extends Command {
   }
 
   static args = {
-    addonName: Args.string({required: true}),
+    addonName: Args.string({required: true, description: 'unique identifier or globally unique name of the add-on'}),
   }
 
   public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/detach.ts b/packages/cli/src/commands/addons/detach.ts
@@ -12,7 +12,7 @@ export default class Detach extends Command {
   }
 
   static args = {
-    attachment_name: Args.string({required: true}),
+    attachment_name: Args.string({required: true, description: 'unique identifier of the add-on attachment'}),
   };
 
   public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/docs.ts b/packages/cli/src/commands/addons/docs.ts
@@ -15,7 +15,7 @@ export default class Docs extends Command {
     };
 
     static args = {
-      addon: Args.string({required: true}),
+      addon: Args.string({required: true, description: 'unique identifier or globally unique name of the add-on'}),
     };
 
     public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/info.ts b/packages/cli/src/commands/addons/info.ts
@@ -17,7 +17,7 @@ export default class Info extends Command {
 
   static usage = `${topic}:info ADDON`
   static args = {
-    addon: Args.string({required: true}),
+    addon: Args.string({required: true, description: 'unique identifier or globally unique name of the add-on'}),
   }
 
   public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/open.ts b/packages/cli/src/commands/addons/open.ts
@@ -80,7 +80,7 @@ export default class Open extends Command {
   }
 
   public static args = {
-    addon: Args.string({required: true}),
+    addon: Args.string({required: true, description: 'unique identifier or globally unique name of the add-on'}),
   }
 
   public static async openUrl(url: string): Promise<void> {

diff --git a/packages/cli/src/commands/addons/plans.ts b/packages/cli/src/commands/addons/plans.ts
@@ -12,7 +12,7 @@ export default class Plans extends Command {
     };
 
     static args = {
-      service: Args.string({required: true}),
+      service: Args.string({required: true, description: 'unique identifier or globally unique name of the add-on'}),
     };
 
     public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/rename.ts b/packages/cli/src/commands/addons/rename.ts
@@ -7,8 +7,8 @@ export default class Rename extends Command {
   static description = 'rename an add-on';
 
   static args = {
-    addon_name: Args.string({required: true}),
-    new_name: Args.string({required: true}),
+    addon_name: Args.string({required: true, description: 'unique identifier or globally unique name of the add-on'}),
+    new_name: Args.string({required: true, description: 'new globally unique name of the add-on'}),
   };
 
   public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/addons/upgrade.ts b/packages/cli/src/commands/addons/upgrade.ts
@@ -26,8 +26,8 @@ export default class Upgrade extends Command {
   }
 
   static args = {
-    addon: Args.string({required: true}),
-    plan: Args.string(),
+    addon: Args.string({required: true, description: 'unique identifier or globally unique name of the add-on'}),
+    plan: Args.string({description: 'unique identifier or name of the plan'}),
   }
 
   private parsed = this.parse(Upgrade)

diff --git a/packages/cli/src/commands/addons/wait.ts b/packages/cli/src/commands/addons/wait.ts
@@ -16,7 +16,7 @@ export default class Wait extends Command {
     };
 
     static args = {
-      addon: Args.string(),
+      addon: Args.string({description: 'unique identifier or globally unique name of the add-on'}),
     };
 
     public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/apps/open.ts b/packages/cli/src/commands/apps/open.ts
@@ -19,7 +19,7 @@ export default class AppsOpen extends Command {
   }
 
   static args = {
-    path: Args.string({required: false}),
+    path: Args.string({required: false, description: 'base URL path of app'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/apps/rename.ts b/packages/cli/src/commands/apps/rename.ts
@@ -21,7 +21,7 @@ export default class AppsRename extends Command {
   }
 
   static args = {
-    newname: Args.string({required: true}),
+    newname: Args.string({required: true, description: 'new unique name of the app'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/apps/stacks/set.ts b/packages/cli/src/commands/apps/stacks/set.ts
@@ -24,7 +24,7 @@ Run git push heroku main to trigger a new build on myapp.`
   }
 
   static args = {
-    stack: Args.string({required: true}),
+    stack: Args.string({required: true, description: 'unique name or identifier of the stack'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/authorizations/info.ts b/packages/cli/src/commands/authorizations/info.ts
@@ -12,7 +12,7 @@ export default class AuthorizationsInfo extends Command {
   }
 
   static args = {
-    id: Args.string({required: true}),
+    id: Args.string({required: true, description: 'ID of the authorization'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/authorizations/revoke.ts b/packages/cli/src/commands/authorizations/revoke.ts
@@ -13,7 +13,7 @@ export default class AuthorizationsRevoke extends Command {
   ]
 
   static args = {
-    id: Args.string({required: true}),
+    id: Args.string({required: true, description: 'ID of the authorization'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/authorizations/rotate.ts b/packages/cli/src/commands/authorizations/rotate.ts
@@ -8,7 +8,7 @@ export default class AuthorizationsRotate extends Command {
   static description = 'updates an OAuth authorization token'
 
   static args = {
-    id: Args.string({required: true}),
+    id: Args.string({required: true, description: 'ID of the authorization'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/authorizations/update.ts b/packages/cli/src/commands/authorizations/update.ts
@@ -14,7 +14,7 @@ export default class AuthorizationsUpdate extends Command {
   }
 
   static args = {
-    id: Args.string({required: true}),
+    id: Args.string({required: true, description: 'ID of the authorization'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/certs/add.ts b/packages/cli/src/commands/certs/add.ts
@@ -49,8 +49,8 @@ export default class Add extends Command {
   }
 
   static args = {
-    CRT: Args.string({required: true}),
-    KEY: Args.string({required: true}),
+    CRT: Args.string({required: true, description: 'absolute path of the certificate file on disk'}),
+    KEY: Args.string({required: true, description: 'absolute path of the key file on disk'}),
   }
 
   public async run(): Promise<void> {

diff --git a/packages/cli/src/commands/certs/generate.ts b/packages/cli/src/commands/certs/generate.ts
@@ -32,7 +32,7 @@ export default class Generate extends Command {
   }
 
   static args = {
-    domain: Args.string({required: true}),
+    domain: Args.string({required: true, description: 'domain name to generate'}),
   }
 
   private parsed = this.parse(Generate)

diff --git a/packages/cli/src/commands/certs/update.ts b/packages/cli/src/commands/certs/update.ts
@@ -23,8 +23,8 @@ export default class Update extends Command {
   }
 
   static args = {
-    CRT: Args.string({required: true}),
-    KEY: Args.string({required: true}),
+    CRT: Args.string({required: true, description: 'absolute path of the certificate file on disk'}),
+    KEY: Args.string({required: true, description: 'absolute path of the key file on disk'}),
   }
 
   static examples = [heredoc`

diff --git a/packages/cli/src/commands/ci/config/get.ts b/packages/cli/src/commands/ci/config/get.ts
@@ -21,7 +21,7 @@ export default class CiConfigGet extends Command {
   }
 
   static args = {
-    key: Args.string({required: true}),
+    key: Args.string({required: true, description: 'name of the config var key'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/ci/info.ts b/packages/cli/src/commands/ci/info.ts
@@ -21,7 +21,7 @@ export default class CiInfo extends Command {
   }
 
   static args = {
-    'test-run': Args.string({required: true}),
+    'test-run': Args.string({required: true, description: 'auto-incremented test run number'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/ci/rerun.ts b/packages/cli/src/commands/ci/rerun.ts
@@ -23,7 +23,7 @@ export default class CiReRun extends Command {
   }
 
   static args = {
-    number: Args.string({required: false}),
+    number: Args.string({required: false, description: 'auto-incremented test run number'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/clients/create.ts b/packages/cli/src/commands/clients/create.ts
@@ -17,8 +17,8 @@ export default class ClientsCreate extends Command {
   }
 
   static args = {
-    name: Args.string({required: true}),
-    redirect_uri: Args.string({required: true}),
+    name: Args.string({required: true, description: 'name of the OAuth client'}),
+    redirect_uri: Args.string({required: true, description: 'redirect URL of the OAuth client'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/clients/destroy.ts b/packages/cli/src/commands/clients/destroy.ts
@@ -7,7 +7,7 @@ export default class ClientsDestroy extends Command {
   static description = 'delete client by ID'
 
   static args = {
-    id: Args.string({required: true}),
+    id: Args.string({required: true, description: 'ID of the OAuth client'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/clients/info.ts b/packages/cli/src/commands/clients/info.ts
@@ -15,7 +15,7 @@ export default class ClientsInfo extends Command {
   }
 
   static args = {
-    id: Args.string({required: true}),
+    id: Args.string({required: true, description: 'ID of the OAuth client'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/clients/rotate.ts b/packages/cli/src/commands/clients/rotate.ts
@@ -12,7 +12,7 @@ export default class ClientsRotate extends Command {
   }
 
   static args = {
-    id: Args.string({required: true}),
+    id: Args.string({required: true, description: 'ID of the OAuth client'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/clients/update.ts b/packages/cli/src/commands/clients/update.ts
@@ -34,7 +34,7 @@ export default class ClientsUpdate extends Command {
   }
 
   static args = {
-    id: Args.string({required: true}),
+    id: Args.string({required: true, description: 'ID of the OAuth client'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/config/get.ts b/packages/cli/src/commands/config/get.ts
@@ -15,7 +15,7 @@ production`
   static strict = false
 
   static args = {
-    KEY: Args.string({required: true}),
+    KEY: Args.string({required: true, description: 'key name of the config var value'}),
   }
 
   static flags = {

diff --git a/packages/cli/src/commands/domains/add.ts b/packages/cli/src/commands/domains/add.ts
@@ -27,7 +27,7 @@ export default class DomainsAdd extends Command {
   }
 
   static args = {
-    hostname: Args.string({required: true}),
+    hostname: Args.string({required: true, description: 'unique identifier of the domain or full hostname'}),
   }
 
   certSelect = async (certs: Array<Heroku.SniEndpoint>) => {

diff --git a/packages/cli/src/commands/domains/info.ts b/packages/cli/src/commands/domains/info.ts
@@ -16,7 +16,7 @@ export default class DomainsInfo extends Command {
   }
 
   static args = {
-    hostname: Args.string({required: true}),
+    hostname: Args.string({required: true, description: 'unique identifier of the domain or full hostname'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/domains/remove.ts b/packages/cli/src/commands/domains/remove.ts
@@ -15,7 +15,7 @@ export default class DomainsRemove extends Command {
   }
 
   static args = {
-    hostname: Args.string({required: true}),
+    hostname: Args.string({required: true, description: 'unique identifier of the domain or full hostname'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/domains/update.ts b/packages/cli/src/commands/domains/update.ts
@@ -19,7 +19,7 @@ export default class DomainsUpdate extends Command {
   }
 
   static args = {
-    hostname: Args.string({required: true}),
+    hostname: Args.string({required: true, description: 'unique identifier of the domain or full hostname'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/domains/wait.ts b/packages/cli/src/commands/domains/wait.ts
@@ -14,7 +14,7 @@ export default class DomainsWait extends Command {
   }
 
   static args = {
-    hostname: Args.string(),
+    hostname: Args.string({description: 'unique identifier of the domain or full hostname'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/drains/add.ts b/packages/cli/src/commands/drains/add.ts
@@ -11,7 +11,7 @@ export default class Add extends Command {
   }
 
   static args = {
-    url: Args.string({required: true}),
+    url: Args.string({required: true, description: 'URL of the log drain'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/drains/remove.ts b/packages/cli/src/commands/drains/remove.ts
@@ -13,7 +13,7 @@ export default class Remove extends Command {
   static example = 'drains:remove [URL|TOKEN]'
 
   static args = {
-    url: Args.string({required: true}),
+    url: Args.string({required: true, description: 'URL of the log drain'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/features/disable.ts b/packages/cli/src/commands/features/disable.ts
@@ -11,7 +11,7 @@ export default class Disable extends Command {
   }
 
   static args = {
-    feature: Args.string({required: true}),
+    feature: Args.string({required: true, description: 'unique identifier or name of the app feature'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/features/enable.ts b/packages/cli/src/commands/features/enable.ts
@@ -11,7 +11,7 @@ export default class Enable extends Command {
   }
 
   static args = {
-    feature: Args.string({required: true}),
+    feature: Args.string({required: true, description: 'unique identifier or name of the app feature'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/features/info.ts b/packages/cli/src/commands/features/info.ts
@@ -12,7 +12,7 @@ export default class Info extends Command {
   }
 
   static args = {
-    feature: Args.string({required: true}),
+    feature: Args.string({required: true, description: 'unique identifier or name of the app feature'}),
   }
 
   async run() {

diff --git a/packages/cli/src/commands/git/credentials.ts b/packages/cli/src/commands/git/credentials.ts
@@ -7,7 +7,7 @@ export class GitCredentials extends Command {
   static description = 'internal command for git-credentials'
 
   static args = {
-    command: Args.string({required: true}),
+    command: Args.string({required: true, description: 'command name of the git credentials'}),
   }
 
   async run() {