From 3e9e6f2f14fda845e6000cfada07d1bfb176bd21 Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Thu, 15 Nov 2018 14:10:15 +0100 Subject: migrate Swagger 2.0 spec to OpenAPI 3.0.0 --- support/doc/development/server/code.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'support/doc/development/server/code.md') diff --git a/support/doc/development/server/code.md b/support/doc/development/server/code.md index e9ab7373c..3894c2542 100644 --- a/support/doc/development/server/code.md +++ b/support/doc/development/server/code.md @@ -41,18 +41,18 @@ Uses [JavaScript Standard Style](http://standardjs.com/). The server is composed by: - * a REST API (Express framework) - * a WebTorrent Tracker + * a REST API (relying on the Express framework) documented on http://docs.joinpeertube.org/api.html + * a WebTorrent Tracker (slightly custom version of [webtorrent/bittorrent-tracker](https://github.com/webtorrent/bittorrent-tracker#server)) A video is seeded by the server with the [WebSeed](http://www.bittorrent.org/beps/bep_0019.html) protocol (HTTP). ![Architecture scheme](/support/doc/development/server/upload-video.png) -When a user uploads a video, the rest API create the torrent file and then adds it to its database. +When a user uploads a video, the REST API creates the torrent file and then adds it to its database. If a user wants to watch the video, the tracker will indicate all other users that are watching the video + the HTTP url for the WebSeed. ## Newcomers -The server entrypoint is [server.ts](/server.ts). You can begin to look at this file. -Then you can try to understand the [controllers](/server/controllers): they are the entrypoint of each API request. +The server entrypoint is [server.ts](/server.ts). Looking at this file is a good start. +Then you can try to understand the [controllers](/server/controllers): they are the entrypoints of each API request. -- cgit v1.2.3