Description standardizing and improvements

Author: GTFalcao

components/basecamp/actions/create-card/create-card.mjs

@@ -3,7 +3,7 @@ import app from "../../basecamp.app.mjs";
 export default {
   key: "basecamp-create-card",
   name: "Create a Card",
-  description: "Creates a card in the select column. [See the documentation](https://github.com/basecamp/bc3-api/blob/master/sections/card_table_cards.md#create-a-card)",
+  description: "Creates a card in a selected column. [See the documentation](https://github.com/basecamp/bc3-api/blob/master/sections/card_table_cards.md#create-a-card)",
   type: "action",
   version: "0.1.0",
   props: {
@@ -51,25 +51,26 @@ export default {
     title: {
       type: "string",
       label: "Title",
-      description: "Title of the card",
+      description: "The title of the new card.",
     },
     content: {
       type: "string",
       label: "Content",
-      description: "Content of the card",
+      description: "The content of the card. [See the documentation](https://github.com/basecamp/bc3-api/blob/master/sections/card_table_cards.md#create-a-card) for information on using HTML tags.",
       optional: true,
     },
     dueOn: {
       type: "string",
-      label: "Due on",
-      description: "Due date (ISO 8601) of the card, e.g.: `2023-12-12`",
+      label: "Due On",
+      description: "Due date (ISO 8601) of the card (e.g. `2023-12-12`).",
       optional: true,
     },
     notify: {
       type: "boolean",
-      label: "Notify",
-      description: "Whether to notify assignees. Defaults to false",
+      label: "Notify Assignees",
+      description: "Whether to notify assignees.",
       optional: true,
+      default: false,
     },
   },
   async run({ $ }) {
@@ -96,7 +97,7 @@ export default {
       },
     });
 
-    $.export("$summary", `Successfully created card with ID ${card.id}`);
+    $.export("$summary", `Successfully created card (ID: ${card.id}}`);
     return card;
   },
 };

components/basecamp/basecamp.app.mjs

@@ -7,8 +7,8 @@ export default {
   propDefinitions: {
     accountId: {
       type: "string",
-      label: "Account Id",
-      description: "The ID of the account.",
+      label: "Account ID",
+      description: "Select an account or provide an account ID.",
       async options() {
         const accounts = await this.getAccounts({});
         return accounts.map(({
@@ -22,8 +22,8 @@ export default {
     },
     projectId: {
       type: "string",
-      label: "Project Id",
-      description: "The ID of the project.",
+      label: "Project ID",
+      description: "Select a project or provide a project ID.",
       async options({
         accountId, page,
       }) {
@@ -44,8 +44,8 @@ export default {
     },
     messageBoardId: {
       type: "string",
-      label: "Message Board Id",
-      description: "The ID of the message board.",
+      label: "Message Board ID",
+      description: "Select a message board or provide a message board ID.",
       async options({
         accountId,
         projectId,
@@ -66,8 +66,8 @@ export default {
     },
     recordingId: {
       type: "string",
-      label: "Recording Id",
-      description: "The ID of the recording.",
+      label: "Recording ID",
+      description: "Select a recording or provide a recording ID.",
       async options({
         accountId,
         projectId,
@@ -104,7 +104,7 @@ export default {
     peopleIds: {
       type: "string[]",
       label: "People",
-      description: "An array of all people visible to the current user.",
+      description: "One or more people visible to the current user.",
       async options({
         accountId,
         projectId,
@@ -129,8 +129,8 @@ export default {
     },
     todoSetId: {
       type: "string",
-      label: "Todo Set Id",
-      description: "The ID of the todo set.",
+      label: "To-do Set Id",
+      description: "Select a to-do set or provide a to-do set ID.",
       async options({
         accountId,
         projectId,
@@ -151,8 +151,8 @@ export default {
     },
     campfireId: {
       type: "string",
-      label: "Campfire Id",
-      description: "The ID of the campfire.",
+      label: "Campfire ID",
+      description: "Select a campfire or provide a campfire ID.",
       async options({
         accountId,
         projectId,
@@ -173,8 +173,8 @@ export default {
     },
     todoListId: {
       type: "string",
-      label: "Todo List Id",
-      description: "The ID of the todo list.",
+      label: "To-do List Id",
+      description: "The ID of the to-do list.",
       async options({
         accountId,
         projectId,
@@ -201,7 +201,7 @@ export default {
     },
     messageTypeId: {
       type: "string",
-      label: "Message Types",
+      label: "Message Type",
       description: "Select a type for the message.",
       async options({
         accountId,
@@ -222,8 +222,8 @@ export default {
     },
     cardTableId: {
       type: "string",
-      label: "Card Table Id",
-      description: "The card table ID",
+      label: "Card Table ID",
+      description: "Select a card table or provide a card table ID.",
       async options({
         accountId, projectId,
       }) {
@@ -242,7 +242,7 @@ export default {
     columnId: {
       type: "string",
       label: "Column ID",
-      description: "The column ID",
+      description: "Select a column or provide a column ID.",
       async options({
         accountId, projectId, cardTableId,
       }) {
@@ -261,8 +261,8 @@ export default {
     },
     botId: {
       type: "string",
-      label: "Chat Bot ID",
-      description: "The ID of the chatbot to send message from",
+      label: "Chatbot ID",
+      description: "Select a chatbot to send the message from.",
       async options({
         accountId, projectId, campfireId,
       }) {

components/basecamp/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/basecamp",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "Pipedream Basecamp Components",
   "main": "basecamp.app.js",
   "keywords": [
@@ -14,6 +14,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.2.1"
+    "@pipedream/platform": "^3.0.3"
   }
 }