Skip to content

Commit 6ab6cae

Browse files
dannyrooseveltdannyroosevelt
authored
Fixing bad componentId references (#16868)
* Fixing bad componentId references * Update api-proxy.mdx * Update pnpm-lock.yaml
1 parent 34a2c4e commit 6ab6cae

File tree

6 files changed

+31
-23
lines changed

6 files changed

+31
-23
lines changed

‎docs-v2/pages/connect/api-proxy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Before getting started with the Connect proxy, make sure you've already gone thr
2424

2525
## Getting started
2626

27-
You can send requests to the Connect proxy using the [Pipedream SDK](/connect/sdk/) with a fetch-style interface, or by making a request to the [REST API](/rest-api/connect/proxy/).
27+
You can send requests to the Connect proxy using the [Pipedream SDK](#using-the-pipedream-sdk) with a fetch-style interface, or directly to the [Pipedream REST API](#using-the-rest-api).
2828

2929
- A [Pipedream OAuth client](/rest-api/auth/#oauth) to make authenticated requests to Pipedream's API
3030
- Connect [environment](/connect/managed-auth/environments/) (ex, `production` or `development`)

‎docs-v2/pages/connect/api.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1450,7 +1450,7 @@ const pd: BackendClient = createBackendClient(clientOpts);
14501450
// Retrieve the configuration options for the "projectId" prop of the "List
14511451
// Commits" component for the Gitlab app.
14521452
const requestOpts: ConfigureComponentOpts = {
1453-
id: "gitlab-list-commits",
1453+
componentId: "gitlab-list-commits",
14541454
configuredProps: {
14551455
gitlab: {
14561456
authProvisionId: "apn_kVh9AoD",
@@ -1489,7 +1489,7 @@ const pd = createBackendClient({
14891489
// Retrieve the configuration options for the "projectId" prop of the "List
14901490
// Commits" component for the Gitlab app.
14911491
const { options } = await pd.configureComponent({
1492-
id: "gitlab-list-commits",
1492+
componentId: "gitlab-list-commits",
14931493
configuredProps: {
14941494
gitlab: {
14951495
authProvisionId: "apn_kVh9AoD",
@@ -1662,7 +1662,7 @@ const pd: BackendClient = createBackendClient(clientOpts);
16621662
// Retrieve the configuration options for the "Add Single Row" component for
16631663
// the Google Sheets app. Note that the `sheetId` prop is a dynamic prop.
16641664
const requestOpts: ReloadComponentPropsOpts = {
1665-
id: "google_sheets-add-single-row",
1665+
componentId: "google_sheets-add-single-row",
16661666
configuredProps: {
16671667
googleSheets: {
16681668
authProvisionId: "apn_V1hMoE7",
@@ -1699,7 +1699,7 @@ const pd = createBackendClient({
16991699
// Retrieve the configuration options for the "Add Single Row" component for
17001700
// the Google Sheets app. Note that the `sheetId` prop is a dynamic prop.
17011701
const { dynamicProps } = await pd.reloadComponentProps({
1702-
id: "google_sheets-add-single-row",
1702+
componentId: "google_sheets-add-single-row",
17031703
configuredProps: {
17041704
googleSheets: {
17051705
authProvisionId: "apn_V1hMoE7",
@@ -1873,7 +1873,7 @@ const pd: BackendClient = createBackendClient(clientOpts);
18731873

18741874
// Run the "List Commits" action for the Gitlab app
18751875
const requestOpts: RunActionOpts = {
1876-
id: "gitlab-list-commits",
1876+
actionId: "gitlab-list-commits",
18771877
configuredProps: {
18781878
gitlab: {
18791879
authProvisionId: "apn_kVh9AoD",
@@ -1916,7 +1916,7 @@ const {
19161916
os, // The observations produced by the action
19171917
ret, // The value returned by the action
19181918
} = await pd.runAction({
1919-
id: "gitlab-list-commits",
1919+
actionId: "gitlab-list-commits",
19201920
configuredProps: {
19211921
gitlab: {
19221922
authProvisionId: "apn_kVh9AoD",
@@ -2078,7 +2078,7 @@ const pd: BackendClient = createBackendClient(clientOpts);
20782078

20792079
// Deploy the "New Issue (Instant)" trigger for the Gitlab app
20802080
const requestOpts: DeployTriggerOpts = {
2081-
id: "gitlab-new-issue",
2081+
triggerId: "gitlab-new-issue",
20822082
configuredProps: {
20832083
gitlab: {
20842084
authProvisionId: "apn_kVh9AoD",
@@ -2117,7 +2117,7 @@ const pd = createBackendClient({
21172117

21182118
// Deploy the "New Issue (Instant)" trigger for the Gitlab app
21192119
const { data: deployedTrigger } = await pd.deployTrigger({
2120-
id: "gitlab-new-issue",
2120+
triggerId: "gitlab-new-issue",
21212121
configuredProps: {
21222122
gitlab: {
21232123
authProvisionId: "apn_kVh9AoD",

‎docs-v2/pages/connect/components.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ as an example, to illustrate a call that retrieves the options for the
335335
```javascript
336336
const { options } = await pd.configureComponent({
337337
externalUserId: "abc-123",
338-
id: "gitlab-list-commits",
338+
componentId: "gitlab-list-commits",
339339
propName: "projectId",
340340
configuredProps: {
341341
gitlab: {
@@ -605,7 +605,7 @@ to the following endpoint:
605605
```javascript
606606
const resp = await pd.runAction({
607607
externalUserId: "abc-123",
608-
id: "gitlab-list-commits",
608+
actionId: "gitlab-list-commits",
609609
configuredProps: {
610610
gitlab: {
611611
authProvisionId: "apn_kVh9AoD",
@@ -713,7 +713,7 @@ Deploy a source for your users:
713713
```javascript
714714
const { data: deployedTrigger } = await pd.deployTrigger({
715715
externalUserId: "abc-123",
716-
id: "gitlab-new-issue",
716+
triggerId: "gitlab-new-issue",
717717
configuredProps: {
718718
gitlab: {
719719
authProvisionId: "apn_kVh9AoD",
@@ -852,7 +852,7 @@ Generate a unique HTTP webhook URL for your end users to configure in any other
852852
```javascript
853853
const { data: deployedTrigger } = await pd.deployTrigger({
854854
externalUserId: "abc-123",
855-
id: "http-new-requests",
855+
triggerId: "http-new-requests",
856856
webhookUrl: "https://events.example.com/http-new-requests"
857857
});
858858

@@ -917,7 +917,7 @@ When defining schedules, you can pass one of the following:
917917
```javascript
918918
const { data: deployedTrigger } = await pd.deployTrigger({
919919
externalUserId: "abc-123",
920-
id: "schedule-custom-interval",
920+
triggerId: "schedule-custom-interval",
921921
configuredProps: {
922922
"cron": {
923923
"intervalSeconds": 900
@@ -977,7 +977,7 @@ Generate a unique email address for your customers to emit events to
977977
```javascript
978978
const { data: deployedTrigger } = await pd.deployTrigger({
979979
externalUserId: "abc-123",
980-
id: "email-new-email",
980+
triggerId: "email-new-email",
981981
webhookUrl: "https://events.example.com/email-new-email"
982982
});
983983

@@ -1123,7 +1123,7 @@ You can call `configureComponent` on the `sql` prop to retrieve database schema
11231123
const resp = await pd.configureComponent({
11241124
externalUserId: externalUserId,
11251125
propName: "sql",
1126-
id: "postgresql-execute-custom-query",
1126+
componentId: "postgresql-execute-custom-query",
11271127
configuredProps: {
11281128
postgresql: {
11291129
authProvisionId: accountId
@@ -1235,7 +1235,7 @@ const { dynamicProps } = await pd.reloadProps({ … });
12351235
// Then use the dynamicProps.id when running the action
12361236
const resp = await pd.runAction({
12371237
externalUserId: "abc-123",
1238-
id: "google_sheets-add-single-row",
1238+
actionId: "google_sheets-add-single-row",
12391239
dynamicPropsId: dynamicProps.id, // Must include this
12401240
configuredProps: {
12411241
googleSheets: {

‎docs-v2/pages/connect/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ import VideoPlayer from "@/components/VideoPlayer";
99

1010
![Connect visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1738731467/pd-connect-viz_cep0uq.png)
1111

12-
## Use managed auth
12+
## Managed auth
1313

1414
- Handle authorization or accept API keys on behalf of your users, for any of Pipedream's [{process.env.PUBLIC_APPS}+ APIs](https://pipedream.com/apps)
1515
- Use the [Client SDK](https://github.com/PipedreamHQ/pipedream/tree/master/packages/sdk) or [Connect Link](/connect/managed-auth/quickstart/#or-use-connect-link) to accept auth in minutes
1616
- Ship new integrations quickly with Pipedream's approved OAuth clients, or use your own
1717

1818

19-
## Act on behalf of your users
19+
## Make requests on behalf of your users
2020

21-
- Retrieve OAuth access tokens and API keys for your end users with Pipedream's [REST API](/connect/api/)
22-
- [Add 10k pre-built tools and triggers](/connect/components) from {process.env.PUBLIC_APPS}+ APIs to your AI agent or embed them in your SaaS app
23-
- Develop and deploy complex multi-step [workflows](/connect/workflows/) in our best-in-class [visual builder](/workflows/building-workflows/)
21+
- Use [Pipedream's MCP server](/connect/mcp/developers) to provide your AI agent 10,000+ tools from {process.env.PUBLIC_APPS}+ APIs
22+
- Add our [entire registry](https://github.com/PipedreamHQ/pipedream/tree/master/components) of [pre-built tools and triggers](/connect/components) from {process.env.PUBLIC_APPS}+ APIs to your SaaS app or workflow builder
2423
- Send custom API requests while still avoiding dealing with customer credentials with the [Connect proxy](/connect/api-proxy/)
24+
- Develop and deploy complex multi-step [workflows](/connect/workflows/) in our best-in-class [visual builder](/workflows/building-workflows/)
2525

2626
{/* <Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1724194758/Screenshot_2024-08-20_at_3.59.05_PM_rfylfq.png" alt="Pipedream Connect overview" width={800} height={529} /> */}
2727

‎docs-v2/pages/connect/managed-auth/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Check out the [full API docs](/connect/api/#create-token) for all parameters you
126126
Now that your users have connected an account, you can use their auth in one of a few ways:
127127

128128
1. [Expose 10k+ tools](/connect/components/) to your AI app or agent and call them on behalf of your customers
129-
2. [Send custom requests](/connect/proxy/) to any one of the 2500+ APIs using the Connect API proxy
129+
2. [Send custom requests](/connect/api-proxy/) to any one of the 2500+ APIs using the Connect API proxy
130130
3. [Use Pipedream's visual workflow builder](/connect/workflows/) to define complex logic to run on behalf of your users
131131
4. [Embed Pipedream components directly in your app](/connect/components/) to run actions and triggers on their behalf
132132

‎pnpm-lock.yaml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)