diff options
author | Chocobozzz <me@florianbigard.com> | 2018-03-07 13:13:40 +0100 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2018-03-07 13:13:40 +0100 |
commit | ea65a47623a545ed8023347d752cdd5fe5700e5d (patch) | |
tree | 364e71f27f14187a1f540850fb8db29c8038e28e /support | |
parent | 28e014c096f771c4474789c568d3e0c3abdbc95b (diff) | |
download | PeerTube-ea65a47623a545ed8023347d752cdd5fe5700e5d.tar.gz PeerTube-ea65a47623a545ed8023347d752cdd5fe5700e5d.tar.zst PeerTube-ea65a47623a545ed8023347d752cdd5fe5700e5d.zip |
Add api base path in documentation
Diffstat (limited to 'support')
-rw-r--r-- | support/doc/api/html/index.html | 8 | ||||
-rw-r--r-- | support/doc/api/openapi.yaml | 6 |
2 files changed, 12 insertions, 2 deletions
diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html index 00cecb07a..ae4020def 100644 --- a/support/doc/api/html/index.html +++ b/support/doc/api/html/index.html | |||
@@ -264,8 +264,14 @@ | |||
264 | </div> | 264 | </div> |
265 | <div class="doc-examples"> | 265 | <div class="doc-examples"> |
266 | <section> | 266 | <section> |
267 | <h5>API Endpoint</h5> | ||
268 | <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre> | ||
269 | <!-- </div> --> | ||
270 | <h5>Schemes: | ||
271 | <span>https</span> | ||
272 | </h5> | ||
267 | <h5>Version: | 273 | <h5>Version: |
268 | <span>0.0.15-alpha</span> | 274 | <span>1.0.0-alpha</span> |
269 | </h5> | 275 | </h5> |
270 | </section> | 276 | </section> |
271 | </div> | 277 | </div> |
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index bcb0c511e..e8e593420 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -1,8 +1,12 @@ | |||
1 | swagger: '2.0' | 1 | swagger: '2.0' |
2 | info: | 2 | info: |
3 | title: PeerTube | 3 | title: PeerTube |
4 | version: 0.0.15-alpha | 4 | version: 1.0.0-alpha |
5 | description: Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular. | 5 | description: Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular. |
6 | host: peertube.example.com | ||
7 | basePath: '/api/v1' | ||
8 | schemes: | ||
9 | - https | ||
6 | paths: | 10 | paths: |
7 | '/accounts/{id}': | 11 | '/accounts/{id}': |
8 | get: | 12 | get: |