aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api/openapi.yaml
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2018-01-24 11:54:32 +0100
committerChocobozzz <me@florianbigard.com>2018-01-24 11:54:32 +0100
commit5e1c08eb94746c44b8b14a12c0937aadb34feb57 (patch)
treeb12dc134fa7c19456c0cc012448a9877c22f5690 /support/doc/api/openapi.yaml
parent9ee83eb99e908c6038cbb6501bacfe18d092f0b6 (diff)
downloadPeerTube-5e1c08eb94746c44b8b14a12c0937aadb34feb57.tar.gz
PeerTube-5e1c08eb94746c44b8b14a12c0937aadb34feb57.tar.zst
PeerTube-5e1c08eb94746c44b8b14a12c0937aadb34feb57.zip
Add api doc in html
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r--support/doc/api/openapi.yaml18
1 files changed, 16 insertions, 2 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index e6d2f51d8..8ba784d4b 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1,7 +1,7 @@
1swagger: '2.0' 1swagger: '2.0'
2info: 2info:
3 title: peertube 3 title: PeerTube
4 version: 0.0.13-alpha 4 version: 0.0.15-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.
6paths: 6paths:
7 '/accounts/{id}': 7 '/accounts/{id}':
@@ -731,6 +731,10 @@ paths:
731 responses: 731 responses:
732 '200': 732 '200':
733 description: successful operation 733 description: successful operation
734 schema:
735 items:
736 type: array
737 $ref: '#/definitions/VideoComment'
734 post: 738 post:
735 tags: 739 tags:
736 - VideoComment 740 - VideoComment
@@ -769,6 +773,8 @@ paths:
769 responses: 773 responses:
770 '200': 774 '200':
771 description: successful operation 775 description: successful operation
776 schema:
777 $ref: '#/definitions/VideoCommentThreadTree'
772 "/video/{videoId}/comments/{commentId}": 778 "/video/{videoId}/comments/{commentId}":
773 post: 779 post:
774 tags: 780 tags:
@@ -963,6 +969,14 @@ definitions:
963 type: number 969 type: number
964 account: 970 account:
965 $ref: "#/definitions/Account" 971 $ref: "#/definitions/Account"
972 VideoCommentThreadTree:
973 properties:
974 comment:
975 $ref: "#/definitions/VideoComment"
976 children:
977 type: array
978 items:
979 $ref: "#/definitions/VideoCommentThreadTree"
966 Avatar: 980 Avatar:
967 properties: 981 properties:
968 path: 982 path: