Skip to content

Commit 6f18bd3

Browse files
committed
Removing ```text references.
yarn upgrade
1 parent 7202515 commit 6f18bd3

8 files changed

Lines changed: 2548 additions & 2118 deletions

File tree

docs/docs/api/auth/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You'll find this API key in your [Account Settings](https://pipedream.com/settin
1212

1313
Pipedream uses [Bearer Authentication](https://oauth.net/2/bearer-tokens/) to authorize your access to the API or SSE event streams. When you make API requests, pass an `Authorization` header of the following format:
1414

15-
```text
15+
```
1616
Authorization: Bearer <api key>
1717
```
1818

docs/docs/api/rest/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The base URL for all requests is **{{$site.themeConfig.API_BASE_URL}}** .
1818

1919
Pipedream uses [Bearer Authentication](https://oauth.net/2/bearer-tokens/) to authorize your access to the API. When you make API requests, pass an `Authorization` header of the following format:
2020

21-
```text
21+
```
2222
Authorization: Bearer <api key>
2323
```
2424

@@ -151,7 +151,7 @@ Retrieve information on the authenticated user.
151151

152152
**Endpoint**
153153

154-
```text
154+
```
155155
GET /users/me
156156
```
157157

@@ -195,7 +195,7 @@ This route returns the components `id`, `code`, `configurable_props`, and other
195195

196196
**Endpoint**
197197

198-
```text
198+
```
199199
POST /components
200200
```
201201

@@ -267,7 +267,7 @@ Retrieve a component by ID to determine its metadata and configurable props.
267267

268268
**Endpoint**
269269

270-
```text
270+
```
271271
GET /components/{id}
272272
```
273273

@@ -329,7 +329,7 @@ curl https://api.pipedream.com/v1/components/sc_JDi8EB \
329329

330330
**Endpoint**
331331

332-
```text
332+
```
333333
GET /users/me/sources/
334334
```
335335

@@ -378,7 +378,7 @@ curl 'https://api.pipedream.com/v1/users/me/sources' \
378378

379379
**Endpoint**
380380

381-
```text
381+
```
382382
POST /sources/
383383
```
384384

@@ -459,7 +459,7 @@ Example response from creating an RSS source that runs once a minute:
459459

460460
**Endpoint**
461461

462-
```text
462+
```
463463
PUT /sources/{id}
464464
```
465465

@@ -511,7 +511,7 @@ Default: `true`.
511511

512512
**Endpoint**
513513

514-
```text
514+
```
515515
DELETE /sources/{id}
516516
```
517517

@@ -529,7 +529,7 @@ You can configure a source, or a workflow, to receive events from any number of
529529

530530
**Endpoint**
531531

532-
```text
532+
```
533533
POST /subscriptions?emitter_id={emitting_component_id}&listener_id={receiving_source_id}
534534
```
535535

@@ -574,21 +574,21 @@ Retrieve up to the last 100 events emitted by a source.
574574

575575
**Endpoint**
576576

577-
```text
577+
```
578578
GET /sources/{id}/event_summaries
579579
```
580580

581581
**Notes and Examples**
582582

583583
The event data for events larger than `1KB` may get truncated in the response. If you're processing larger events, and need to see the full event data, pass `?expand=event`:
584584

585-
```text
585+
```
586586
GET /sources/{id}/event_summaries?expand=event
587587
```
588588

589589
Pass `?limit=N` to retrieve the last **N** events:
590590

591-
```text
591+
```
592592
GET /sources/{id}/event_summaries?limit=10
593593
```
594594

@@ -604,7 +604,7 @@ These IDs can be retrieved by using the [`GET /sources/{id}/event_summaries` end
604604

605605
**Endpoint**
606606

607-
```text
607+
```
608608
DELETE /sources/{id}/events
609609
```
610610

docs/docs/cli/install/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To install the CLI, run:
44

5-
```text
5+
```bash
66
curl https://cli.pipedream.com/install | sh
77
```
88

docs/docs/cli/login/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To start using the Pipedream CLI, you'll need to link it to your Pipedream accou
88

99
If you already have a Pipedream account, run
1010

11-
```text
11+
```
1212
pd login
1313
```
1414

@@ -18,7 +18,7 @@ Otherwise, you'll be asked to login.
1818

1919
Once you're done, go back to your shell and you should see confirmation that your account is linked:
2020

21-
```text
21+
```
2222
> pd login
2323
Logged in as dylburger (dylan@pipedream.com)
2424
```
@@ -27,15 +27,15 @@ Logged in as dylburger (dylan@pipedream.com)
2727

2828
If you haven't signed up for a Pipedream account, you can create an account using the CLI:
2929

30-
```text
30+
```
3131
pd signup
3232
```
3333

3434
This will open up a new window in your default browser. You'll be asked to sign up for Pipedream here. Once you do, your account will be linked to the CLI, writing your API key for that account to your [`pd` config file](/cli/reference/#cli-config-file).
3535

3636
Once you're done, go back to your shell and you should see confirmation that your account is linked:
3737

38-
```text
38+
```
3939
> pd signup
4040
Logged in as dylburger (dylan@pipedream.com)
4141
```
@@ -44,7 +44,7 @@ Logged in as dylburger (dylan@pipedream.com)
4444

4545
You can log out of the CLI by running:
4646

47-
```text
47+
```
4848
pd logout
4949
```
5050

docs/docs/cli/reference/README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Since this is a preview release, the commands you see below, and the [REST API](
1414

1515
To install the CLI, run:
1616

17-
```text
17+
```
1818
curl https://cli.pipedream.com/install | sh
1919
```
2020

@@ -34,7 +34,7 @@ We've also documented each command below, with usage examples for each.
3434

3535
Everywhere you can refer to a specific source as an argument, you can use the source's ID _or_ its name slug. For example, to retrieve details about a specific source using `pd describe`, you can use either of the following commands:
3636

37-
```text
37+
```
3838
λ ~/ pd describe dc_abc123
3939
4040
id: dc_abc123
@@ -53,7 +53,7 @@ Searching for sources matching http
5353

5454
Deletes an event source. Run:
5555

56-
```text
56+
```
5757
pd describe <source-id-or-name>
5858
```
5959

@@ -69,13 +69,13 @@ When you select a source, we'll deploy it and start listening for new events.
6969

7070
You can also deploy a specific source via Github URL:
7171

72-
```text
72+
```
7373
pd deploy https://github.com/PipedreamHQ/pipedream/blob/master/components/http/http.js
7474
```
7575

7676
or author a component locally and deploy that local file:
7777

78-
```text
78+
```
7979
pd deploy http.js
8080
```
8181

@@ -85,33 +85,33 @@ pd deploy http.js
8585

8686
Display the details for a source: its id, name, and other configuration details:
8787

88-
```text
88+
```
8989
pd describe <source-id-or-name>
9090
```
9191

9292
### `pd events`
9393

9494
Returns historical events sent to a source, and streams emitted events directly to the CLI.
9595

96-
```text
96+
```
9797
pd events <source-id-or-name>
9898
```
9999

100100
By default, `pd events` prints (up to) the last 10 events sent to your source.
101101

102-
```text
102+
```
103103
pd events -n 100 <source-id-or-name>
104104
```
105105

106106
`pd events -n N` retrieves the last `N` events sent to your source. We store the last 100 events sent to a source, so you can retrieve a max of 100 events using this command.
107107

108-
```text
108+
```
109109
pd events -f <source-id-or-name>
110110
```
111111

112112
`pd events -f` connects to the [SSE stream tied to your source](/api/sse/) and displays events as the source produces them.
113113

114-
```text
114+
```
115115
pd events -n N -f <source-id-or-name>
116116
```
117117

@@ -127,21 +127,21 @@ Lists Pipedream resources you own. Running `pd list` without any arguments promp
127127

128128
You can also list specific resource types directly:
129129

130-
```text
130+
```
131131
pd list sources
132132
```
133133

134-
```text
134+
```
135135
pd list streams
136136
```
137137

138138
`sources` and `streams` have shorter aliases, too:
139139

140-
```text
140+
```
141141
pd list so
142142
```
143143

144-
```text
144+
```
145145
pd list st
146146
```
147147

@@ -157,7 +157,7 @@ Running `pd logout` without any arguments removes the default API key from your
157157

158158
You can remove the API key for a specific profile by running:
159159

160-
```text
160+
```
161161
pd logout -p <profile>
162162
```
163163

@@ -179,25 +179,25 @@ Updates the code, props, or metadata for an event source.
179179

180180
If you deployed a source from Github, for example, someone might publish an update to that source, and you may want to run the updated code.
181181

182-
```text
182+
```
183183
pd update <source-id-or-name> --code https://github.com/PipedreamHQ/pipedream/blob/master/components/http/http.js
184184
```
185185

186186
You can change the name of a source:
187187

188-
```text
188+
```
189189
pd update <source-id-or-name> --name new-awesome-name
190190
```
191191

192192
You can deactivate a source if you want to stop it from running:
193193

194-
```text
194+
```
195195
pd update <source-id-or-name> --deactivate
196196
```
197197

198198
or activate a source you previously deactivated:
199199

200-
```text
200+
```
201201
pd update <source-id-or-name> --activate
202202
```
203203

@@ -209,19 +209,19 @@ Profiles allow you to work with multiple, named Pipedream accounts via the CLI.
209209

210210
When you [login to the CLI](/cli/login/), the CLI writes the API key for that account to your config file, in the `api_key` field:
211211

212-
```text
212+
```
213213
api_key = abc123
214214
```
215215

216216
You can set API keys for other, named profiles, too. Run
217217

218-
```text
218+
```
219219
pd login -p <profile>
220220
```
221221

222222
`<profile>` can be any string of shell-safe characters that you'd like to use to identify this new profile. The CLI opens up a browser asking you to login to your target Pipedream account, then writes the API key to a section of the config file under this profile:
223223

224-
```text
224+
```
225225
[your_profile]
226226
api_key = def456
227227
```
@@ -232,15 +232,15 @@ You can also run `pd signup -p <profile>` if you'd like to sign up for a new Pip
232232

233233
You can set a profile on any `pd` command by setting the `-p` or `--profile` flag. For example, to list the sources in a specific account, run:
234234

235-
```text
235+
```
236236
pd list sources --profile <profile>
237237
```
238238

239239
## Version
240240

241241
To get the current version of the `pd` CLI, run
242242

243-
```text
243+
```
244244
pd --version
245245
```
246246

0 commit comments

Comments
 (0)