interesting
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add api base path in documentation

This commit is contained in:
Chocobozzz 2018-03-07 13:13:40 +01:00
parent 28e014c096
commit ea65a47623
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
support/doc/api/html/index.html
View File

@ -264,8 +264,14 @@
</div> </div>
<div class="doc-examples"> <div class="doc-examples">
<section> <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: <h5>Version:
<span>0.0.15-alpha</span> <span>1.0.0-alpha</span>
</h5> </h5>
</section> </section>
</div> </div>

6
support/doc/api/openapi.yaml
View File

@ -1,8 +1,12 @@
swagger: '2.0' swagger: '2.0'
info: info:
title: PeerTube 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. 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: paths:
'/accounts/{id}': '/accounts/{id}':
get: get: