Skip to content

Commit c3b4996

Browse files
Bill LeoutsakosBill Leoutsakos
authored andcommitted
fix(docs): render items output properties
1 parent 6a3b51d commit c3b4996

8 files changed

Lines changed: 69 additions & 3 deletions

File tree

‎apps/docs/content/docs/en/integrations/gong.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,7 @@ Retrieve detailed call data including trackers, topics, highlights, and AI spotl
247247
| ↳ `section` | string | Outline section name |
248248
| ↳ `startTime` | number | Section start in seconds from call start |
249249
| ↳ `duration` | number | Section duration in seconds |
250+
| ↳ `items` | array | Bullet items within the section |
250251
| ↳ `keyPoints` | array | AI-generated key points of the call |
251252
| ↳ `text` | string | Key point text |
252253
| ↳ `callOutcome` | object | AI-determined call outcome \(Call Spotlight\) |
@@ -273,6 +274,9 @@ Retrieve detailed call data including trackers, topics, highlights, and AI spotl
273274
| ↳ `occurrences` | array | Details per occurrence |
274275
| ↳ `highlights` | array | AI-generated highlights including next steps, action items, and key moments |
275276
| ↳ `title` | string | Title of the highlight |
277+
| ↳ `items` | array | Individual highlight items |
278+
| ↳ `text` | string | Text of the highlight item |
279+
| ↳ `startTimes` | array | Start times in seconds from call start |
276280
| ↳ `interaction` | object | Interaction statistics |
277281
| ↳ `interactionStats` | array | Interaction stat measurements \(Longest Monologue, Interactivity, Patience, etc.\) |
278282
| ↳ `name` | string | Stat name |

‎apps/docs/content/docs/en/integrations/google_forms.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,16 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
146146
| ↳ `quizSettings` | object | Quiz settings |
147147
| ↳ `isQuiz` | boolean | Whether the form is a quiz |
148148
| ↳ `emailCollectionType` | string | Email collection type |
149+
| ↳ `items` | array | The form items \(questions, sections, etc.\) |
150+
| ↳ `itemId` | string | Item ID |
151+
| ↳ `title` | string | Item title |
152+
| ↳ `description` | string | Item description |
153+
| ↳ `questionItem` | json | Question item configuration |
154+
| ↳ `questionGroupItem` | json | Question group configuration |
155+
| ↳ `pageBreakItem` | json | Page break configuration |
156+
| ↳ `textItem` | json | Text item configuration |
157+
| ↳ `imageItem` | json | Image item configuration |
158+
| ↳ `videoItem` | json | Video item configuration |
149159
| ↳ `revisionId` | string | The revision ID of the form |
150160
| ↳ `responderUri` | string | The URI to share with responders |
151161
| ↳ `linkedSheetId` | string | The ID of the linked Google Sheet |

‎apps/docs/content/docs/en/integrations/netsuite.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ List one page of a NetSuite record collection, optionally filtered with a q expr
6868
| ↳ `links` | array | Oracle HATEOAS links for the response |
6969
| ↳ `rel` | string | Link relationship |
7070
| ↳ `href` | string | Link target |
71+
| ↳ `items` | array | Matching record references in this page |
72+
| ↳ `id` | string | NetSuite record ID |
73+
| ↳ `links` | array | Oracle HATEOAS links for the record |
74+
| ↳ `rel` | string | Link relationship |
75+
| ↳ `href` | string | Link target |
7176
| ↳ `count` | number | Number of items in this page |
7277
| ↳ `hasMore` | boolean | Whether another page is available |
7378
| ↳ `offset` | number | Offset of this page |
@@ -526,6 +531,7 @@ Execute one page of a SuiteQL query through SuiteTalk REST web services.
526531
| ↳ `links` | array | Oracle HATEOAS links for the response |
527532
| ↳ `rel` | string | Link relationship |
528533
| ↳ `href` | string | Link target |
534+
| ↳ `items` | array | Items in this page; item fields depend on the record, query, or dataset |
529535
| ↳ `count` | number | Number of items in this page |
530536
| ↳ `hasMore` | boolean | Whether another page is available |
531537
| ↳ `offset` | number | Offset of this page |
@@ -555,6 +561,7 @@ List one page of SuiteAnalytics Workbook datasets available to the authenticated
555561
| ↳ `links` | array | Oracle HATEOAS links for the response |
556562
| ↳ `rel` | string | Link relationship |
557563
| ↳ `href` | string | Link target |
564+
| ↳ `items` | array | Items in this page; item fields depend on the record, query, or dataset |
558565
| ↳ `count` | number | Number of items in this page |
559566
| ↳ `hasMore` | boolean | Whether another page is available |
560567
| ↳ `offset` | number | Offset of this page |
@@ -585,6 +592,7 @@ Execute one page of a standard or custom SuiteAnalytics Workbook dataset.
585592
| ↳ `links` | array | Oracle HATEOAS links for the response |
586593
| ↳ `rel` | string | Link relationship |
587594
| ↳ `href` | string | Link target |
595+
| ↳ `items` | array | Items in this page; item fields depend on the record, query, or dataset |
588596
| ↳ `count` | number | Number of items in this page |
589597
| ↳ `hasMore` | boolean | Whether another page is available |
590598
| ↳ `offset` | number | Offset of this page |
@@ -612,6 +620,11 @@ List record types exposed to the authenticated role by the REST metadata catalog
612620
| ↳ `links` | array | Oracle HATEOAS links for the response |
613621
| ↳ `rel` | string | Link relationship |
614622
| ↳ `href` | string | Link target |
623+
| ↳ `items` | array | Record types exposed to the authenticated role |
624+
| ↳ `name` | string | REST record type script ID |
625+
| ↳ `links` | array | Oracle HATEOAS links for the response |
626+
| ↳ `rel` | string | Link relationship |
627+
| ↳ `href` | string | Link target |
615628

616629
### NetSuite Get Record Metadata
617630

@@ -663,6 +676,10 @@ List tasks for an asynchronous job or retrieve one task's completion status.
663676
| ↳ `progress` | string | Current task progress state |
664677
| ↳ `startTime` | string | Task start time |
665678
| ↳ `count` | number | Number of returned tasks |
679+
| ↳ `items` | array | Asynchronous task entries |
680+
| ↳ `links` | array | Links to individual tasks |
681+
| ↳ `rel` | string | Link relationship |
682+
| ↳ `href` | string | Link target |
666683
| ↳ `links` | array | HATEOAS links for the job or task collection |
667684
| ↳ `rel` | string | Link relationship |
668685
| ↳ `href` | string | Link target |

‎apps/docs/content/docs/en/integrations/onepassword.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ List all vaults accessible by the Connect token or Service Account
5959
| ↳ `description` | string | Vault description |
6060
| ↳ `attributeVersion` | number | Vault attribute version |
6161
| ↳ `contentVersion` | number | Vault content version |
62+
| ↳ `items` | number | Number of items in the vault |
6263
| ↳ `type` | string | Vault type \(USER_CREATED, PERSONAL, or EVERYONE\) |
6364
| ↳ `createdAt` | string | Creation timestamp |
6465
| ↳ `updatedAt` | string | Last update timestamp |

‎apps/docs/content/docs/en/integrations/sap_concur.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1479,6 +1479,7 @@ List allocations on an expense (GET /expensereports/v4/users/\{userId\}/context/
14791479
| --------- | ---- | ----------- |
14801480
| `status` | number | HTTP status code returned by Concur |
14811481
| `data` | json | Allocations list payload |
1482+
| ↳ `items` | array | Array of allocation objects \(allocationId, accountCode, percentage, allocationAmount, approvedAmount, claimedAmount, customData, expenseId, isSystemAllocation, isPercentEdited, overLimitAccountCode\) |
14821483

14831484
### SAP Concur List Attendee Associations
14841485

@@ -1547,6 +1548,12 @@ List budget categories (GET /budget/v4/budgetCategory).
15471548
| --------- | ---- | ----------- |
15481549
| `status` | number | HTTP status code returned by Concur |
15491550
| `data` | json | Budget categories collection payload |
1551+
| ↳ `items` | array | Array of budget category objects |
1552+
| ↳ `id` | string | Category ID |
1553+
| ↳ `name` | string | Admin-facing category name |
1554+
| ↳ `description` | string | Friendly name |
1555+
| ↳ `statusType` | string | Status: OPEN or REMOVED |
1556+
| ↳ `expenseTypes` | array | Expense types in this category \(id, featureTypeCode, expenseTypeCode, name\) |
15501557

15511558
### SAP Concur List Budgets
15521559

@@ -1573,6 +1580,7 @@ List budget item headers (GET /budget/v4/budgetItemHeader).
15731580
| --------- | ---- | ----------- |
15741581
| `status` | number | HTTP status code returned by Concur |
15751582
| `data` | json | Budget headers collection payload |
1583+
| ↳ `items` | array | Array of budget item header summaries \(id, name, description, budgetItemStatusType, budgetType, currencyCode, fiscalYear, budgetAmounts, owner, ...\) |
15761584
| ↳ `offset` | number | Page offset |
15771585
| ↳ `limit` | number | Page size |
15781586
| ↳ `totalCount` | number | Total result count |

‎apps/docs/content/docs/en/integrations/sharepoint.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,9 @@ Get metadata (and optionally columns/items) for a SharePoint list
267267
| ↳ `lastModifiedDateTime` | string | When the list was last modified |
268268
| ↳ `list` | object | List properties \(e.g., template\) |
269269
| ↳ `columns` | array | List column definitions |
270+
| ↳ `items` | array | List items \(with fields when expanded\) |
271+
| ↳ `id` | string | Item ID |
272+
| ↳ `fields` | object | Field values for the item |
270273
| `lists` | array | All lists in the site when no listId/title provided |
271274
| `items` | array | List items with expanded fields when reading list items |
272275
| ↳ `id` | string | Item ID |

‎apps/sim/tools/netsuite/netsuite.test.ts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* @vitest-environment node
33
*/
44
import { generateKeyPairSync } from 'node:crypto'
5+
import { readFileSync } from 'node:fs'
56
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
67
import {
78
netsuiteAttachRecordTool,
@@ -668,6 +669,26 @@ describe('NetSuite operation contracts', () => {
668669
}
669670
})
670671

672+
it('renders every declared collection items output in the generated integration docs', () => {
673+
const docs = readFileSync(
674+
new URL('../../../docs/content/docs/en/integrations/netsuite.mdx', import.meta.url),
675+
'utf8'
676+
)
677+
const operationHeadings = [
678+
'NetSuite List/Search Records',
679+
'NetSuite Execute SuiteQL',
680+
'NetSuite List SuiteAnalytics Datasets',
681+
'NetSuite Execute SuiteAnalytics Dataset',
682+
'NetSuite List Record Types',
683+
'NetSuite Get Async Task Status',
684+
]
685+
686+
for (const heading of operationHeadings) {
687+
const section = docs.split(`### ${heading}\n`, 2)[1]?.split('\n### ', 1)[0]
688+
expect(section, heading).toContain('| ↳ `items` | array |')
689+
}
690+
})
691+
671692
it('lists async tasks and requires a task ID for the documented task-status endpoint', async () => {
672693
const calls: string[] = []
673694
vi.stubGlobal(

‎scripts/generate-docs.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2602,7 +2602,7 @@ function parsePropertiesContent(
26022602
const propName = constMatch[1]
26032603
const constName = constMatch[2]
26042604

2605-
if (propName === 'items' || propName === 'properties' || propName === 'type') {
2605+
if (propName === 'properties' || propName === 'type') {
26062606
continue
26072607
}
26082608

@@ -2627,7 +2627,7 @@ function parsePropertiesContent(
26272627
const constName = propAccessMatch[2]
26282628
const accessedProp = propAccessMatch[3]
26292629

2630-
if (propName === 'items' || propName === 'properties' || propName === 'type') {
2630+
if (propName === 'properties' || propName === 'type') {
26312631
continue
26322632
}
26332633

@@ -2675,7 +2675,9 @@ function parsePropertiesContent(
26752675
while ((match = propStartRegex.exec(propertiesContent)) !== null) {
26762676
const propName = match[1]
26772677

2678-
if (propName === 'items' || propName === 'properties') {
2678+
// `items` can be an API response field. Nested array-schema `items` entries are
2679+
// excluded by the depth check below, so only the schema container itself is reserved here.
2680+
if (propName === 'properties') {
26792681
continue
26802682
}
26812683

0 commit comments

Comments
 (0)