From: Chocobozzz <me@florianbigard.com>
Date: Wed, 7 Mar 2018 12:13:40 +0000 (+0100)
Subject: Add api base path in documentation
X-Git-Tag: v1.0.0-alpha.5~7
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=ea65a47623a545ed8023347d752cdd5fe5700e5d;p=oweals%2Fpeertube.git

Add api base path in documentation
---

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 @@
               </div>
               <div class="doc-examples">
                 <section>
+                  <h5>API Endpoint</h5>
+                  <!-- <div class="hljs"> --><pre><code>https://peertube.example.com/api/v1</code></pre>
+                  <!-- </div> -->
+                  <h5>Schemes:
+                    <span>https</span>
+                  </h5>
                   <h5>Version:
-                    <span>0.0.15-alpha</span>
+                    <span>1.0.0-alpha</span>
                   </h5>
                 </section>
               </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 @@
 swagger: '2.0'
 info:
   title: PeerTube
-  version: 0.0.15-alpha
+  version: 1.0.0-alpha
   description: Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
+host: peertube.example.com
+basePath: '/api/v1'
+schemes:
+  - https
 paths:
   '/accounts/{id}':
     get: