Skip to content

Commit 43747d1

Browse files
Danny/fixing docs apps redirect (#16478)
* Update pnpm-lock.yaml * Fixing bad /apps redirect, adding catch-all redirect * Update pnpm-lock.yaml * Escaping unsafe characters and pnpm lock * Update 404.tsx * Merge branch 'danny/fixing-docs-apps-redirect' of github.com:PipedreamHQ/pipedream into danny/fixing-docs-apps-redirect * Update pnpm-lock.yaml * Delete apps.mdx * Updating header anchor tags * Update users.mdx * Modifying 404 handling * Add redirects for /apps/apps/ and /integrations/ paths * Linting * Removing 404 and middleware changes * Capitalize section headers in API docs * Update API reference links to match capitalized section headers * Update api.mdx * Update pnpm-lock.yaml
1 parent 7f4bbbf commit 43747d1

File tree

14 files changed

+56
-123
lines changed

14 files changed

+56
-123
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ docs/.vuepress/dist
1818
components/**/package-lock.json
1919
/packages/evals/
2020
/packages/sdk/examples/.next/
21+
22+
**/.claude/settings.local.json

docs-v2/next.config.mjs

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ export default withNextra({
3434
},
3535
async redirects() {
3636
return [
37+
{
38+
source: "/apps/apps/",
39+
destination: "/apps/",
40+
permanent: true,
41+
},
3742
{
3843
source: "/v3/",
3944
destination: "/",
@@ -69,11 +74,6 @@ export default withNextra({
6974
destination: "https://pipedream.com/apps/",
7075
permanent: true,
7176
},
72-
{
73-
source: "/apps/:path*/",
74-
destination: "https://pipedream.com/apps/:path*/",
75-
permanent: true,
76-
},
7777
{
7878
source: "/support/",
7979
destination: "https://pipedream.com/support/",
@@ -481,6 +481,11 @@ export default withNextra({
481481
destination: "/integrations/oauth-clients/",
482482
permanent: true,
483483
},
484+
{
485+
source: "/integrations/",
486+
destination: "/apps/",
487+
permanent: true,
488+
},
484489
{
485490
source: "/integrations/:path*/",
486491
destination: "/apps/:path*/",
@@ -561,6 +566,10 @@ export default withNextra({
561566
source: "/api-demo-connect/accounts/:id/",
562567
destination: "/api/demo-connect/accounts/:id",
563568
},
569+
{
570+
source: "/workflows/errors/",
571+
destination: "/workflows/building-workflows/errors/",
572+
},
564573
];
565574
},
566575
env: {

docs-v2/pages/apps/apps.mdx

Lines changed: 0 additions & 79 deletions
This file was deleted.

docs-v2/pages/connect/api.mdx

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ const pd = createBackendClient({
6767

6868
You'll primarily use the browser SDK to let your users securely connect apps from your frontend. Here, you
6969

70-
1. [Create a short-lived token on your server](#create-a-new-token)
70+
1. [Create a short-lived token on your server](#create-token)
7171
2. Initiate auth with that token to securely connect an account for a specific user
7272

7373
Here's a Next.js example [from our quickstart](/connect/managed-auth/quickstart/):
@@ -240,7 +240,7 @@ Your app will initiate the account connection flow for your end users in your fr
240240

241241
See [the Connect tokens docs](/connect/tokens/) for more information.
242242

243-
#### Create a new token
243+
#### Create token
244244

245245
```
246246
POST /{project_id}/tokens
@@ -383,9 +383,9 @@ curl -X POST https://api.pipedream.com/v1/connect/{project_id}/tokens \
383383

384384
### Accounts
385385

386-
#### List all accounts
386+
#### List All Accounts
387387

388-
List all connected accounts for all end users within a project.
388+
List all connected accounts for all externalusers within a project.
389389

390390
```
391391
GET /{project_id}/accounts/
@@ -650,7 +650,7 @@ curl -X GET \
650650
}
651651
```
652652

653-
#### Retrieve account details by ID
653+
#### Retrieve Account Details by ID
654654

655655
Retrieve the account details for a specific account based on the account ID
656656

@@ -823,9 +823,9 @@ curl -X GET \
823823
}
824824
```
825825

826-
#### Delete connected account
826+
#### Delete Connected Account
827827

828-
Delete a specific connected account for an end user, and any deployed triggers.
828+
Delete a specific connected account for an external user, and any deployed triggers.
829829

830830
```
831831
DELETE /{project_id}/accounts/{account_id}
@@ -910,7 +910,7 @@ curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/accounts/{acco
910910

911911
Pipedream returns a `204 No Content` response on successful account deletion
912912

913-
#### Delete all connected accounts for an app
913+
#### Delete All Connected Accounts for an App
914914

915915
Delete all connected accounts for a specific app
916916

@@ -999,9 +999,9 @@ curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/accounts/{acco
999999

10001000
Pipedream returns a `204 No Content` response on successful account deletion
10011001

1002-
#### Delete an end user
1002+
#### Delete External User
10031003

1004-
Delete an end user, all their connected accounts, and any deployed triggers.
1004+
Delete an external user, all their connected accounts, and any deployed triggers.
10051005

10061006
```
10071007
DELETE /{project_id}/users/{external_user_id}
@@ -1091,7 +1091,7 @@ Pipedream returns a `204 No Content` response on successful account deletion
10911091

10921092
### Components
10931093

1094-
#### List components
1094+
#### List Components
10951095

10961096
List all the components in the Pipedream registry.
10971097

@@ -1239,7 +1239,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components?a
12391239
```
12401240

12411241

1242-
#### Retrieve a component
1242+
#### Retrieve Component
12431243

12441244
Retrieve a specific component from the Pipedream registry.
12451245

@@ -1378,7 +1378,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components/g
13781378

13791379

13801380

1381-
#### Configure a component
1381+
#### Configure Component
13821382

13831383
Configure the a component's prop, based on the current component's
13841384
configuration. This endpoint will use the component's configuration to retrieve
@@ -1592,7 +1592,7 @@ curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/components/
15921592
}
15931593
```
15941594

1595-
#### Reload a component's props (i.e. configure dynamic props)
1595+
#### Reload Component Props
15961596

15971597
Reload the component's props after configuring a dynamic prop, based on the
15981598
current component's configuration. This endpoint will use the component's
@@ -1820,7 +1820,7 @@ curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/components/
18201820
}
18211821
```
18221822

1823-
#### Invoke an action
1823+
#### Invoke Action
18241824

18251825
Invoke an action component for a Pipedream Connect user in a project.
18261826

@@ -2009,7 +2009,7 @@ curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run
20092009
}
20102010
```
20112011

2012-
#### Deploy a trigger
2012+
#### Deploy Trigger
20132013

20142014
<Callout type="info">
20152015
See [here](/connect/components/#deploying-triggers) for more info on supported trigger types with example payloads
@@ -2242,7 +2242,7 @@ curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/triggers/de
22422242
}
22432243
```
22442244

2245-
#### List deployed triggers
2245+
#### List Deployed Triggers
22462246

22472247
List all of the deployed triggers for a given user.
22482248

@@ -2503,7 +2503,7 @@ curl -X GET \
25032503
}
25042504
```
25052505

2506-
#### Retrieve a deployed trigger
2506+
#### Retrieve Deployed Trigger
25072507

25082508
Retrieve a single deployed trigger for a given user.
25092509

@@ -2688,7 +2688,7 @@ curl -X GET \
26882688
}
26892689
```
26902690

2691-
#### Delete a deployed trigger
2691+
#### Delete Deployed Trigger
26922692

26932693
Delete deployed trigger for a given user.
26942694

@@ -2798,7 +2798,7 @@ curl -X DELETE \
27982798
Pipedream returns a `204 No Content` response on successful deletion
27992799

28002800

2801-
#### Retrieve the events emitted by a deployed trigger
2801+
#### Retrieve Events Emitted by Deployed Trigger
28022802

28032803
Retrieve a list of the last events that a deployed trigger emitted.
28042804

@@ -2995,7 +2995,7 @@ curl -X GET \
29952995
}
29962996
```
29972997

2998-
#### Retrieve the webhooks listening to a deployed trigger
2998+
#### Retrieve Webhooks Listening to Deployed Trigger
29992999

30003000
Retrieve the list of webhook URLs listening to a deployed trigger.
30013001

@@ -3116,7 +3116,7 @@ curl -X GET \
31163116
}
31173117
```
31183118

3119-
#### Update the webhooks listening to a deployed trigger
3119+
#### Update Webhooks Listening to Deployed Trigger
31203120

31213121
Update the list of webhook URLs that will listen to a deployed trigger.
31223122

@@ -3255,7 +3255,7 @@ curl -X PUT \
32553255
}
32563256
```
32573257

3258-
#### Retrieve the workflows listening to a deployed trigger
3258+
#### Retrieve Workflows Listening to Deployed Trigger
32593259

32603260
Retrieve the list of workflow IDs listening to a deployed trigger.
32613261

@@ -3377,7 +3377,7 @@ curl -X GET \
33773377
}
33783378
```
33793379

3380-
#### Update the workflows listening to a deployed trigger
3380+
#### Update Workflows Listening to Deployed Trigger
33813381

33823382
Update the list of workflows that will listen to a deployed trigger.
33833383

docs-v2/pages/connect/components.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -821,7 +821,7 @@ These are 2 categories of triggers you can deploy on behalf of your end users:
821821
- [Native triggers](#native-triggers)
822822

823823
<Callout type="info">
824-
Refer to the [full Connect API reference](/connect/api/#deploy-a-trigger) to list, retrieve, delete, and manage triggers for your user.
824+
Refer to the [full Connect API reference](/connect/api/#deploy-trigger) to list, retrieve, delete, and manage triggers for your user.
825825
</Callout>
826826

827827
### App-based event sources
@@ -833,7 +833,7 @@ Refer to the [full Connect API reference](/connect/api/#deploy-a-trigger) to lis
833833
- Many event sources attempt to retrieve a small set of historical events on deploy to provide visibility into the event shape for end users and developers
834834
- Exposing real test events make it easier to consume the event in downstream systems without requiring users to trigger real events ([more info](/components/contributing/guidelines/#surfacing-test-events))
835835
- However, this results in emitting those events to the listening webhook immediately, which may not always be ideal, depending on your use case
836-
- If you'd like to avoid emitting historical events, you can deploy a trigger without defining a `webhook_url`, then [update the listening webhooks for the deployed trigger](/connect/api/#update-the-webhooks-listening-to-a-deployed-trigger) after roughly a minute
836+
- If you'd like to avoid emitting historical events, you can deploy a trigger without defining a `webhook_url`, then [update the listening webhooks for the deployed trigger](/connect/api/#update-webhooks-listening-to-deployed-trigger) after roughly a minute
837837

838838

839839
### Native triggers

docs-v2/pages/connect/environments.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The `development` environment is not intended for production use with your custo
2727

2828
## How to specify the environment
2929

30-
You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. When users successfully connect their account, Pipedream saves the account credentials (API key, access token, etc.) for that `external_user_id` in the specified environment.
30+
You specify the environment when [creating a new Connect token](/connect/api/#create-token) with the Pipedream SDK or API. When users successfully connect their account, Pipedream saves the account credentials (API key, access token, etc.) for that `external_user_id` in the specified environment.
3131

3232
Always set the environment when you create the SDK client:
3333

docs-v2/pages/connect/managed-auth/connect-link.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ https://pipedream.com/_static/connect.html?token={token}&connectLink=true&app={a
2727

2828
## Success and error redirect URLs
2929

30-
To automatically redirect users somewhere after they complete the connection flow (or if an error occurs), define the `success_redirect_uri` and `error_redirect_uri` parameters during token creation. [See the API docs](/connect/api/#create-a-new-token) for details.
30+
To automatically redirect users somewhere after they complete the connection flow (or if an error occurs), define the `success_redirect_uri` and `error_redirect_uri` parameters during token creation. [See the API docs](/connect/api/#create-token) for details.
3131

3232
In the absence of these URLs, Pipedream will redirect the user to a Pipedream-hosted success or error page at the end of the connection flow.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ In the code below you can see how we generate a Connect token for an example use
7878
Once you have a token, return it to your frontend to start the account connection flow for the user, or redirect them to a Pipedream-hosted URL with [Connect Link](#or-use-connect-link).
7979

8080
<Callout type="info">
81-
Refer to the API docs for [full set of parameters you can pass](/connect/api/#create-a-new-token) in the `ConnectTokenCreate` call.
81+
Refer to the API docs for [full set of parameters you can pass](/connect/api/#create-token) in the `ConnectTokenCreate` call.
8282
</Callout>
8383

8484
### Connect your user's account
@@ -121,7 +121,7 @@ After generating a token in the [step above](#generate-a-short-lived-token), you
121121
<Callout type="info">
122122
Make sure to add the `app` parameter to the end of the URL to specify the app.
123123

124-
Check out the [full API docs](/connect/api/#create-a-new-token) for all parameters you can pass when creating tokens, including setting redirect URLs for success or error cases.
124+
Check out the [full API docs](/connect/api/#create-token) for all parameters you can pass when creating tokens, including setting redirect URLs for success or error cases.
125125
</Callout>
126126

127127
### Make authenticated requests

0 commit comments

Comments
 (0)