aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-04-04 09:16:53 +0200
committerChocobozzz <me@florianbigard.com>2023-04-04 09:18:06 +0200
commit00ee545c2444c35ed0d37df9f91984246aa36124 (patch)
tree823ab6b93d9b144bc60adef5c69739b0e8fed808 /support/doc/api
parentb5f38b78984c69fd2b4270c50ed58a708174b935 (diff)
downloadPeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.tar.gz
PeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.tar.zst
PeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.zip
Remove $ for bash commands
It prevents easy copy
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/quickstart.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/support/doc/api/quickstart.md b/support/doc/api/quickstart.md
index 677745969..3a34a1429 100644
--- a/support/doc/api/quickstart.md
+++ b/support/doc/api/quickstart.md
@@ -7,7 +7,7 @@
7Some endpoints need authentication. We use OAuth 2.0 so first fetch the client tokens: 7Some endpoints need authentication. We use OAuth 2.0 so first fetch the client tokens:
8 8
9```bash 9```bash
10$ curl https://peertube.example.com/api/v1/oauth-clients/local 10curl https://peertube.example.com/api/v1/oauth-clients/local
11``` 11```
12 12
13Response example: 13Response example:
@@ -24,7 +24,7 @@ Response example:
24Now you can fetch the user token: 24Now you can fetch the user token:
25 25
26```bash 26```bash
27$ curl -X POST \ 27curl -X POST \
28 -d "client_id=v1ikx5hnfop4mdpnci8nsqh93c45rldf&client_secret=AjWiOapPltI6EnsWQwlFarRtLh4u8tDt&grant_type=password&response_type=code&username=your_user&password=your_password" \ 28 -d "client_id=v1ikx5hnfop4mdpnci8nsqh93c45rldf&client_secret=AjWiOapPltI6EnsWQwlFarRtLh4u8tDt&grant_type=password&response_type=code&username=your_user&password=your_password" \
29 https://peertube.example.com/api/v1/users/token 29 https://peertube.example.com/api/v1/users/token
30``` 30```
@@ -43,14 +43,14 @@ Response example:
43Just use the `access_token` in the `Authorization` header: 43Just use the `access_token` in the `Authorization` header:
44 44
45```bash 45```bash
46$ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/completed 46curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/completed
47``` 47```
48 48
49 49
50## List videos 50## List videos
51 51
52```bash 52```bash
53$ curl https://peertube.example.com/api/v1/videos 53curl https://peertube.example.com/api/v1/videos
54``` 54```
55 55
56## Libraries 56## Libraries