Skip to content

Updating references to accounts APIs #14987

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 2 commits into from
Dec 13, 2024
Merged

Updating references to accounts APIs #14987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9675ba4
Updating references to accounts APIs
dannyroosevelt Dec 13, 2024
f5d8cac
Fixing broken link refs
dannyroosevelt Dec 13, 2024
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
176 changes: 0 additions & 176 deletions docs-v2/pages/connected-accounts/api.mdx
View file
Open in desktop

This file was deleted.

5 changes: 4 additions & 1 deletion docs-v2/pages/connected-accounts/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Pipedream provides native integrations for [{process.env.PUBLIC_APPS}+ APIs](htt

- [Link that account to any step of a workflow](#connecting-accounts), using the associated credentials to make API requests to any service.
- [Manage permissions](#managing-connected-accounts), limiting access to sensitive accounts
- [Access credentials via API](#accessing-credentials-via-api), letting you build services anywhere and use Pipedream to handle auth

Pipedream handles OAuth for you, ensuring you always have a fresh access token to authorize requests, and [credentials are tightly-secured](/privacy-and-security/#third-party-oauth-grants-api-keys-and-environment-variables).

Expand Down Expand Up @@ -39,6 +38,10 @@ For example, if you add a new connected account for **Sendgrid**, you'll be aske

## Connecting accounts

<Callout type="info">
This section discusses connecting **your own account** within the Pipedream UI. If you're looking to use the connected accounts for your customers, check out the [Connect docs](/connect).
</Callout>

### From an action

Prebuilt actions that connect to a specific service require you connect your account for that service before you run your workflow. Click the **Connect [APP]** button to get started.
Expand Down
8 changes: 1 addition & 7 deletions docs-v2/pages/rest-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,6 @@ The ID of the custom [OAuth app](/connect/quickstart#create-a-pipedream-oauth-cl

---

`external_user_id` **string** (_optional_)

[The external user ID](/connect/api/#external-users) in your system that you want to retrieve accounts for.

---

`include_credentials` **boolean** (_optional_)

Pass `include_credentials=true` as a query-string parameter to include the account credentials in the response
Expand Down Expand Up @@ -233,7 +227,7 @@ curl 'https://api.pipedream.com/v1/accounts' \

### Get account

By default, this route returns metadata for a specific connected account. Set `include_credentials=true` to return credentials that you can use in any app where you need auth. [See this guide](/connected-accounts/api/) to learn more.
By default, this route returns metadata for a specific connected account. Set `include_credentials=true` to return credentials that you can use in any app where you need the actual credentials (API key or OAuth access token for example).

#### Endpoint

Expand Down
4 changes: 4 additions & 0 deletions docs-v2/vercel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,10 @@
{
"source": "/docs/workflows/networking",
"destination": "/docs/databases#connecting-to-restricted-databases"
},
{
"source": "/docs/connected-accounts/api",
"destination": "/docs/connect/api#accounts"
}
Comment on lines +280 to 284
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Redirect path verified and remaining references found

The destination path /docs/connect/api#accounts exists in docs-v2/pages/connect/api.mdx, and the content includes a comprehensive API reference with an "Accounts" section. However, there are two remaining references to the old path that need to be updated:

  • docs-v2/pages/rest-api/index.mdx
  • docs-v2/pages/connected-accounts/index.mdx
🔗 Analysis chain

Verify the destination path exists.

The redirect looks good, but let's ensure the destination path /docs/connect/api#accounts exists and contains the relevant content from the deleted documentation file.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of the destination path and related files

# Check if the destination file exists (without the #accounts anchor)
fd -t f "api.mdx" -p "docs-v2/pages/connect/"

# Look for any remaining references to the old path
rg -i "connected-accounts/api" --type=mdx

Length of output: 143

Script:

#!/bin/bash
# Check if the destination file exists and look for the 'accounts' section
rg -l "accounts" docs-v2/pages/connect/api.mdx

# Look for any remaining references to connected-accounts, without file type restriction
rg -i "connected-accounts/api"

# Check the content of the API documentation to verify the accounts section
cat docs-v2/pages/connect/api.mdx

Length of output: 64090

]
}
Loading