Add api base path in documentation
authorChocobozzz <me@florianbigard.com>
Wed, 7 Mar 2018 12:13:40 +0000 (13:13 +0100)
committerChocobozzz <me@florianbigard.com>
Wed, 7 Mar 2018 12:13:40 +0000 (13:13 +0100)
support/doc/api/html/index.html
support/doc/api/openapi.yaml

index 00cecb07a5e42d52c1b8ca7d5b1abf1e8f40d79e..ae4020def75d1b1e9e274525eb050cec714e262b 100644 (file)
               </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>
index bcb0c511e209ceba2986b30a5372934e55361d60..e8e593420292c199f80e289252effdf2f5074b09 100644 (file)
@@ -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: