feat(secret-rotation): updated helper text for options

backend/src/ee/secretRotation/templates/mysql.ts

@@ -1,4 +1,4 @@
-import { TProviderFunctionTypes, TDbProviderClients, TAssignOp } from "../types";
+import { TAssignOp, TDbProviderClients, TProviderFunctionTypes } from "../types";
 
 export const MYSQL_TEMPLATE = {
   inputs: {
@@ -9,9 +9,17 @@ export const MYSQL_TEMPLATE = {
       host: { type: "string" as const },
       database: { type: "string" as const },
       port: { type: "integer" as const, default: "3306" },
-      username1: { type: "string", default: "infisical-sql-user1" },
-      username2: { type: "string", default: "infisical-sql-user2" },
-      ca: { type: "string" }
+      username1: {
+        type: "string",
+        default: "infisical-sql-user1",
+        desc: "This user must be created in your database"
+      },
+      username2: {
+        type: "string",
+        default: "infisical-sql-user2",
+        desc: "This user must be created in your database"
+      },
+      ca: { type: "string", desc: "SSL certificate for db auth(string)" }
     },
     required: [
       "admin_username",

backend/src/ee/secretRotation/templates/postgres.ts

@@ -1,4 +1,4 @@
-import { TProviderFunctionTypes, TDbProviderClients, TAssignOp } from "../types";
+import { TAssignOp, TDbProviderClients, TProviderFunctionTypes } from "../types";
 
 export const POSTGRES_TEMPLATE = {
   inputs: {
@@ -9,9 +9,17 @@ export const POSTGRES_TEMPLATE = {
       host: { type: "string" as const },
       database: { type: "string" as const },
       port: { type: "integer" as const, default: "5432" },
-      username1: { type: "string", default: "infisical-pg-user1" },
-      username2: { type: "string", default: "infisical-pg-user2" },
-      ca: { type: "string" }
+      username1: {
+        type: "string",
+        default: "infisical-pg-user1",
+        desc: "This user must be created in your database"
+      },
+      username2: {
+        type: "string",
+        default: "infisical-pg-user2",
+        desc: "This user must be created in your database"
+      },
+      ca: { type: "string", desc: "SSL certificate for db auth(string)" }
     },
     required: [
       "admin_username",

backend/src/ee/secretRotation/templates/sendgrid.ts

@@ -1,11 +1,15 @@
-import { TProviderFunctionTypes, TAssignOp } from "../types";
+import { TAssignOp, TProviderFunctionTypes } from "../types";
 
 export const SENDGRID_TEMPLATE = {
   inputs: {
     type: "object" as const,
     properties: {
-      admin_api_key: { type: "string" as const },
-      scopes: { type: "array", items: { type: "string" as const } }
+      admin_api_key: { type: "string" as const, desc: "Sendgrid admin api key to create new keys" },
+      scopes: {
+        type: "array",
+        items: { type: "string" as const },
+        desc: "Scopes for created tokens by rotation(Array)"
+      }
     },
     required: ["admin_api_key", "scopes"],
     additionalProperties: false

backend/src/ee/secretRotation/types.ts

@@ -103,7 +103,7 @@ export type TProviderFunction = THttpProviderFunction | TDbProviderFunction;
 export type TProviderTemplate = {
   inputs: {
     type: "object";
-    properties: Record<string, { type: string; [x: string]: unknown }>;
+    properties: Record<string, { type: string; [x: string]: unknown; desc?: string }>;
     required?: string[];
   };
   outputs: Record<string, unknown>;