You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/api.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -403,7 +403,7 @@ GET /{project_id}/accounts/
403
403
404
404
The ID or name slug the app you'd like to retrieve. For example, Slack's unique app ID is `app_OkrhR1`, and its name slug is `slack`.
405
405
406
-
You can find the app's ID in the response from the [List apps]((/core/rest-api/#list-apps) endpoint, and the name slug under the **Authentication** section of any [app page](https://pipedream.com/apps).
406
+
You can find the app's ID in the response from the [List apps](/core/rest-api/#list-apps) endpoint, and the name slug under the **Authentication** section of any [app page](https://pipedream.com/apps).
407
407
408
408
---
409
409
@@ -1113,7 +1113,7 @@ The ID or name slug the app you'd like to retrieve. For example, Slack's unique
1113
1113
app ID is `app_OkrhR1`, and its name slug is `slack`.
1114
1114
1115
1115
You can find the app's ID in the response from the [List
1116
-
apps]((/core/rest-api/#list-apps) endpoint, and the name slug under the
1116
+
apps](/core/rest-api/#list-apps) endpoint, and the name slug under the
1117
1117
**Authentication** section of any [app page](https://pipedream.com/apps).
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/components.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Check out the [public demo app](https://pdrm.co/connect) to see the API and SDK
33
33
<Callouttype="info">
34
34
Refer to the [Connect API docs](/connect/api/) for the full API reference. Below is a quickstart with a few specific examples.
35
35
36
-
You can skip steps 1 and 2 if you already know the component you want to use or if you'd prefer to [pass a natural language prompt to Pipedream's component search API]((/core/rest-api/#search-for-registry-components).
36
+
You can skip steps 1 and 2 if you already know the component you want to use or if you'd prefer to [pass a natural language prompt to Pipedream's component search API](/core/rest-api/#search-for-registry-components).
37
37
</Callout>
38
38
39
39
<Steps>
@@ -676,9 +676,9 @@ above:
676
676
677
677
#### Deploying a source
678
678
679
-
Because sources are exercised by events that happen on a third-party service,
680
-
their semantics are different from actions. Once a source is configured, it must
681
-
be deployed to start listening for events. When deploying a source, you
679
+
Because sources are exercised by events that happen on a third-party service,
680
+
their semantics are different from actions. Once a source is configured, it must
681
+
be deployed to start listening for events. When deploying a source, you
682
682
can define either a webhook URL or a Pipedream workflow ID to consume those events.
683
683
684
684
Deploying a source is done by sending a payload similar to the one used for
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/managed-auth/quickstart.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ You'll need these when configuring the SDK and making API requests.
74
74
75
75
### Generate a short-lived token
76
76
77
-
To securely initiate account connections for your users, you'll need generate a short-lived token for your users and use that in the [account connection flow](#connect-your-users-account). See [the docs on Connect tokens](/connect/tokens/) for a general overview of why we need to create tokens and scope them to end users.
77
+
To securely initiate account connections for your users, you'll need to generate a short-lived token for your users and use that in the [account connection flow](#connect-your-users-account). See [the docs on Connect tokens](/connect/tokens/) for a general overview of why we need to create tokens and scope them to end users.
78
78
79
79
In the Next.js example here, we're running [Next server components](https://nextjs.org/docs/app/building-your-application/rendering/server-components) in `app/server.ts`. We call the `serverConnectTokenCreate` method from the frontend to retrieve a token **for a specific user**.
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/workflows.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -263,11 +263,11 @@ You have two options for triggering workflows that run on behalf of your end use
263
263
264
264
### HTTP Webhook
265
265
266
-
The most common way to trigger workflows is via HTTP webhook. We strongly recommend [creating a Pipedream OAuth client]((/core/rest-api/auth#creating-an-oauth-client) and authenticating inbound requests to your workflows.
266
+
The most common way to trigger workflows is via HTTP webhook. We strongly recommend [creating a Pipedream OAuth client](/core/rest-api/auth#creating-an-oauth-client) and authenticating inbound requests to your workflows.
267
267
268
268
To get started, you'll need:
269
269
270
-
-[OAuth client ID and secret]((/core/rest-api/auth#creating-an-oauth-client) (optional but recommended)
270
+
-[OAuth client ID and secret](/core/rest-api/auth#creating-an-oauth-client) (optional but recommended)
271
271
- Your [project ID](/core/projects/#finding-your-projects-id)
272
272
- Your workflow's HTTP endpoint URL
273
273
- The [external user ID](/connect/api/#external-users) of your end user
Copy file name to clipboardExpand all lines: docs-v2/pages/core/cli/reference.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,7 +121,7 @@ Generate new app and component files from templates.
121
121
122
122
#### `pd init app`
123
123
124
-
Creates a directory and [an app file](/(/core/core/contributing/components/guidelines/#app-files) from a template
124
+
Creates a directory and [an app file](/core/core/contributing/components/guidelines/#app-files) from a template
125
125
126
126
```bash
127
127
# Creates google_calendar/ directory and google_calendar.mjs file
@@ -146,7 +146,7 @@ Creates a new directory and [an event source](/core/workflows/triggers/) from a
146
146
pd init source cancelled-event
147
147
```
148
148
149
-
You can attach [database](/core/contributing/components/api//#db), [HTTP](/core/contributing/components/api//#http), or [Timer](/core/contributing/components/api//#timer) props to your template using the following flags:
149
+
You can attach [database](/core/contributing/components/api/#db), [HTTP](/core/contributing/components/api/#http), or [Timer](/core/contributing/components/api/#timer) props to your template using the following flags:
Copy file name to clipboardExpand all lines: docs-v2/pages/core/contributing/components/actions-quickstart.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ We recommend that you complete the examples below in order.
57
57
58
58
### hello world!
59
59
60
-
The following code represents a simple component that can be published as an action ([learn more](/core/contributing/components/api//) about the component structure). When used in a workflow, it will export `hello world!` as the return value for the step.
60
+
The following code represents a simple component that can be published as an action ([learn more](/core/contributing/components/api/) about the component structure). When used in a workflow, it will export `hello world!` as the return value for the step.
61
61
62
62
```javascript
63
63
exportdefault {
@@ -109,7 +109,7 @@ Keep the browser tab open. We'll return to this workflow in the rest of the exam
109
109
110
110
### hello [name]!
111
111
112
-
Next, let's update the component to capture some user input. First, add a `string`[prop](/core/contributing/components/api//#props) called `name` to the component.
112
+
Next, let's update the component to capture some user input. First, add a `string`[prop](/core/contributing/components/api/#props) called `name` to the component.
113
113
114
114
```java
115
115
export default {
@@ -340,7 +340,7 @@ export default {
340
340
};
341
341
```
342
342
343
-
Then add an [app prop](/core/contributing/components/api//#app-props) to use Pipedream managed auth with this component. For this example, we'll add an app prop for Github:
343
+
Then add an [app prop](/core/contributing/components/api/#app-props) to use Pipedream managed auth with this component. For this example, we'll add an app prop for Github:
344
344
345
345
```javascript
346
346
import { Octokit } from"@octokit/rest";
@@ -397,7 +397,7 @@ export default {
397
397
};
398
398
```
399
399
400
-
In order to help users understand what's happening with each action step, we recommend surfacing a brief summary with `$summary` ([read more](/core/contributing/components/api//#actions) about exporting data using `$.export`).
400
+
In order to help users understand what's happening with each action step, we recommend surfacing a brief summary with `$summary` ([read more](/core/contributing/components/api/#actions) about exporting data using `$.export`).
401
401
402
402
```javascript
403
403
import { Octokit } from"@octokit/rest";
@@ -486,6 +486,6 @@ Select an existing account or connect a new one, and then deploy your workflow a
486
486
487
487
## What's Next?
488
488
489
-
You're ready to start authoring and publishing actions on Pipedream! You can also check out the [detailed component reference](/core/contributing/components/api//#component-api) at any time!
489
+
You're ready to start authoring and publishing actions on Pipedream! You can also check out the [detailed component reference](/core/contributing/components/api/#component-api) at any time!
490
490
491
491
If you have any questions or feedback, please [reach out](https://pipedream.com/community)!
Copy file name to clipboardExpand all lines: docs-v2/pages/core/contributing/components/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,7 +99,7 @@ Finally, the target app must be integrated with Pipedream. You can explore all a
99
99
100
100
### Component API Reference
101
101
102
-
After getting familiar with source/action development using the quickstart guides, check out [the Component API Reference](/core/contributing/components/api//) and [examples on GitHub](https://github.com/PipedreamHQ/pipedream/tree/master/components) to learn more.
102
+
After getting familiar with source/action development using the quickstart guides, check out [the Component API Reference](/core/contributing/components/api/) and [examples on GitHub](https://github.com/PipedreamHQ/pipedream/tree/master/components) to learn more.
Copy file name to clipboardExpand all lines: docs-v2/pages/core/contributing/components/sources-quickstart.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -679,6 +679,6 @@ Save and reload your source in the Pipedream UI. You should now see a countdown
679
679
680
680
## What's Next?
681
681
682
-
You're ready to start authoring and deploying components on Pipedream! You can also check out the [detailed component reference](/core/contributing/components/api//) at any time!
682
+
You're ready to start authoring and deploying components on Pipedream! You can also check out the [detailed component reference](/core/contributing/components/api/) at any time!
683
683
684
684
If you have any questions or feedback, please join our [public Slack](https://pipedream.com/support).
Copy file name to clipboardExpand all lines: docs-v2/pages/core/contributing/components/typescript.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,7 @@ See [the RSS sources and actions](https://github.com/PipedreamHQ/pipedream/tree/
88
88
89
89
We welcome PRs in [the `PipedreamHQ/pipedream` repo](https://github.com/PipedreamHQ/pipedream), where we store all sources and actions, the `@pipedream/types` package, these docs, and other Pipedream code. Here are a few known issues durin the **beta**:
90
90
91
-
-`this` is strictly-typed within `methods`, `run`, `hooks`, and everywhere you have access to `this` in [the component API](/core/contributing/components/api//). But this typing can be improved. For example, we don't yet map props to their appropriate TypeScript type (everything is typed with `any`).
91
+
-`this` is strictly-typed within `methods`, `run`, `hooks`, and everywhere you have access to `this` in [the component API](/core/contributing/components/api/). But this typing can be improved. For example, we don't yet map props to their appropriate TypeScript type (everything is typed with `any`).
92
92
- The compile -> publish lifecycle hasn't been fully-automated when you're developing in the `pipedream` repo. Currently, you have to run `npm run build` from the repo root, then use the `pd` CLI to publish components after compilation. It would be nice to run `tsc-watch` and have that compile and publish the new version of the component using the `--onSuccess` flag, publishing any sources or actions accordingly.
93
93
- We should add a linter (like `dtslint`) to all TypeScript components). Currently, `dtslint` is configured only for the `@pipedream/types` package.
0 commit comments