Skip to content

Fixing component key references in Connect docs #16653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 13, 2025
Merged

Fixing component key references in Connect docs #16653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e2ce28
Fixing component key references
dannyroosevelt May 13, 2025
b161b42
Update pnpm-lock.yaml
dannyroosevelt May 13, 2025
c433a25
Merge branch 'master' into danny/connect-docs-typos
dannyroosevelt May 13, 2025
9ab3e10
Fixing over-zealous Claude
dannyroosevelt May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 9 additions & 27 deletions docs-v2/pages/connect/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1314,9 +1314,7 @@ const pd = createBackendClient({
});

// Retrieve the "New Issue (Instant)" component for the Gitlab app
const { data: component } = await pd.getComponent({
key: "gitlab-new-issue",
});
const { data: component } = await pd.getComponent({ key: "gitlab-new-issue" });

// Parse and return the data you need
```
Expand Down Expand Up @@ -1452,9 +1450,7 @@ const pd: BackendClient = createBackendClient(clientOpts);
// Retrieve the configuration options for the "projectId" prop of the "List
// Commits" component for the Gitlab app.
const requestOpts: ConfigureComponentOpts = {
componentId: {
key: "gitlab-list-commits",
},
id: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -1493,9 +1489,7 @@ const pd = createBackendClient({
// Retrieve the configuration options for the "projectId" prop of the "List
// Commits" component for the Gitlab app.
const { options } = await pd.configureComponent({
componentId: {
key: "gitlab-list-commits",
},
id: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -1668,9 +1662,7 @@ const pd: BackendClient = createBackendClient(clientOpts);
// Retrieve the configuration options for the "Add Single Row" component for
// the Google Sheets app. Note that the `sheetId` prop is a dynamic prop.
const requestOpts: ReloadComponentPropsOpts = {
componentId: {
key: "google_sheets-add-single-row",
},
id: "google_sheets-add-single-row",
configuredProps: {
googleSheets: {
authProvisionId: "apn_V1hMoE7",
Expand Down Expand Up @@ -1707,9 +1699,7 @@ const pd = createBackendClient({
// Retrieve the configuration options for the "Add Single Row" component for
// the Google Sheets app. Note that the `sheetId` prop is a dynamic prop.
const { dynamicProps } = await pd.reloadComponentProps({
componentId: {
key: "google_sheets-add-single-row",
},
id: "google_sheets-add-single-row",
configuredProps: {
googleSheets: {
authProvisionId: "apn_V1hMoE7",
Expand Down Expand Up @@ -1883,9 +1873,7 @@ const pd: BackendClient = createBackendClient(clientOpts);

// Run the "List Commits" action for the Gitlab app
const requestOpts: RunActionOpts = {
actionId: {
key: "gitlab-list-commits",
},
id: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -1928,9 +1916,7 @@ const {
os, // The observations produced by the action
ret, // The value returned by the action
} = await pd.runAction({
actionId: {
key: "gitlab-list-commits",
},
id: "gitlab-list-commits",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -2092,9 +2078,7 @@ const pd: BackendClient = createBackendClient(clientOpts);

// Deploy the "New Issue (Instant)" trigger for the Gitlab app
const requestOpts: DeployTriggerOpts = {
triggerId: {
key: "gitlab-new-issue",
},
id: "gitlab-new-issue",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down Expand Up @@ -2133,9 +2117,7 @@ const pd = createBackendClient({

// Deploy the "New Issue (Instant)" trigger for the Gitlab app
const { data: deployedTrigger } = await pd.deployTrigger({
triggerId: {
key: "gitlab-new-issue",
},
id: "gitlab-new-issue",
configuredProps: {
gitlab: {
authProvisionId: "apn_kVh9AoD",
Expand Down
10 changes: 6 additions & 4 deletions docs-v2/pages/connect/components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,10 @@ steps, focused on getting the right input parameters (aka
Configuring each prop for a component often involves an API call to retrieve the possible values,
unless the values that a prop can take are static or free-form. The endpoint is accessible at:

```
POST /v1/connect/{project_id}/components/configure
```

Typically, the options for a prop are linked to a specific user's account. Each
of these props implements an `options` method that retrieves the necessary
options from the third-party API, formats them, and sends them back in the
Expand Down Expand Up @@ -1119,9 +1123,7 @@ You can call `configureComponent` on the `sql` prop to retrieve database schema
const resp = await pd.configureComponent({
externalUserId: externalUserId,
propName: "sql",
componentId: {
key: "postgresql-execute-custom-query",
},
id: "postgresql-execute-custom-query",
configuredProps: {
postgresql: {
authProvisionId: accountId
Expand Down Expand Up @@ -1234,7 +1236,7 @@ const { dynamicProps } = await pd.reloadProps({ … });
const resp = await pd.runAction({
externalUserId: "abc-123",
id: "google_sheets-add-single-row",
dynamicPropsId: dynamicProps.id, // Must include this
dynamicPropsId: dynamicProps.id, // Must include this
configuredProps: {
googleSheets: {
authProvisionId: account.id,
Expand Down
Loading