Skip to content

Commit fc001dd

Browse files
committed
Description/prop updates
1 parent 04742bd commit fc001dd

File tree

3 files changed

+16
-11
lines changed

3 files changed

+16
-11
lines changed

components/airtable_oauth/actions/common/common.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ export default {
1010
],
1111
withLabel: true,
1212
},
13+
warningAlert: {
14+
type: "alert",
15+
alertType: "warning",
16+
content: "**Note:** if using a custom expression to specify the `Base` (e.g. `{{steps.mydata.$return_value}}`) you should also use a custom expression for the `Table`, and any other props that depend on it.",
17+
},
1318
tableId: {
1419
propDefinition: [
1520
airtable,

components/airtable_oauth/actions/list-records/list-records.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import commonList from "../common/common-list.mjs";
44
export default {
55
key: "airtable_oauth-list-records",
66
name: "List Records",
7-
description: "Retrieve records from a table with automatic pagination. Optionally sort and filter results.",
7+
description: "Retrieve records from a table, optionally sorting and filtering results. [See the documentation](https://airtable.com/developers/web/api/list-records)",
88
type: "action",
9-
version: "0.0.6",
9+
version: "0.1.0",
1010
...commonList,
1111
props: {
1212
...common.props,

components/airtable_oauth/airtable_oauth.app.mjs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export default {
1818
baseId: {
1919
type: "string",
2020
label: "Base",
21-
description: "The base ID",
21+
description: "The Base ID.",
2222
async options({ prevContext }) {
2323
const params = {};
2424
if (prevContext?.newOffset) {
@@ -44,7 +44,7 @@ export default {
4444
tableId: {
4545
type: "string",
4646
label: "Table",
47-
description: "The table ID. If referencing a **Base** dynamically using data from another step (e.g., `{{steps.trigger.event.metadata.baseId}}`), you will not be able to select from the list of Tables, and automatic table options will not work when configuring this step. Please enter a custom expression to specify the **Table**.",
47+
description: "The Table ID.",
4848
async options({ baseId }) {
4949
let tables;
5050
try {
@@ -63,7 +63,7 @@ export default {
6363
viewId: {
6464
type: "string",
6565
label: "View",
66-
description: "The view ID. If referencing a **Table** dynamically using data from another step (e.g., `{{steps.trigger.event.metadata.tableId}}`), you will not be able to select from the list of Views for this step. Please enter a custom expression to specify the **View**.",
66+
description: "The View ID.",
6767
async options({
6868
baseId, tableId,
6969
}) {
@@ -85,8 +85,8 @@ export default {
8585
},
8686
sortFieldId: {
8787
type: "string",
88-
label: "Sort: Field",
89-
description: "Optionally select a field to sort results. To sort by multiple fields, use the **Filter by Forumla** field. If referencing a **Table** dynamically using data from another step (e.g., `{{steps.mydata.$return_value}}`), automatic field options won't work when configuring this step. Please enter a custom expression to specify the **Sort: Field**.",
88+
label: "Sort by Field",
89+
description: "Optionally select a field to sort results by. To sort by multiple fields, use the **Filter by Formula** field.",
9090
optional: true,
9191
async options({
9292
baseId, tableId,
@@ -181,27 +181,27 @@ export default {
181181
returnFieldsByFieldId: {
182182
type: "boolean",
183183
label: "Return Fields By Field ID",
184-
description: "An optional boolean value that lets you return field objects where the key is the field id. This defaults to `false`, which returns field objects where the key is the field name.",
184+
description: "If set to `true`, the returned field objects will have the field ID as the key, instead of the field name (default behavior).",
185185
optional: true,
186186
},
187187
sortDirection: {
188188
type: "string",
189189
label: "Sort: Direction",
190-
description: "This field will be ignored if you don't select a field to sort by.",
190+
description: "If sorting by a field, which direction to sort by.",
191191
options: SORT_DIRECTION_OPTIONS,
192192
default: "desc",
193193
optional: true,
194194
},
195195
maxRecords: {
196196
type: "integer",
197197
label: "Max Records",
198-
description: "Optionally limit the maximum number of records to return. Leave blank to retrieve all records.",
198+
description: "The maximum number of records to return. Leave blank to retrieve all records.",
199199
optional: true,
200200
},
201201
filterByFormula: {
202202
type: "string",
203203
label: "Filter by Formula",
204-
description: "Optionally provide a [formula](https://support.airtable.com/hc/en-us/articles/203255215-Formula-Field-Reference) used to filter records. The formula will be evaluated for each record, and if the result is not `0`, `false`, `\"\"`, `NaN`, `[]`, or `#Error!` the record will be included in the response. For example, to only include records where `Name` isn't empty, pass `NOT({Name} = '')`.",
204+
description: "Optionally provide a [formula (see the documentation)](https://support.airtable.com/hc/en-us/articles/203255215-Formula-Field-Reference) used to filter records. The formula will be evaluated for each record, and if the result is not `0`, `false`, `\"\"`, `NaN`, `[]`, or `#Error!` the record will be included in the response. For example, to only include records where `Name` isn't empty, use `NOT({Name} = '')`.",
205205
optional: true,
206206
},
207207
records: {

0 commit comments

Comments
 (0)