diff options
author | Rigel Kent <sendmemail@rigelk.eu> | 2018-11-15 14:10:15 +0100 |
---|---|---|
committer | Rigel Kent <sendmemail@rigelk.eu> | 2018-11-15 14:10:16 +0100 |
commit | 3e9e6f2f14fda845e6000cfada07d1bfb176bd21 (patch) | |
tree | c8ab535f0f5ff0454b1e1df36ce4d8473846d676 /support/doc/development | |
parent | 6cb3482ceba2e0564a05b525699f29a1f5ff20a2 (diff) | |
download | PeerTube-3e9e6f2f14fda845e6000cfada07d1bfb176bd21.tar.gz PeerTube-3e9e6f2f14fda845e6000cfada07d1bfb176bd21.tar.zst PeerTube-3e9e6f2f14fda845e6000cfada07d1bfb176bd21.zip |
migrate Swagger 2.0 spec to OpenAPI 3.0.0
Diffstat (limited to 'support/doc/development')
-rw-r--r-- | support/doc/development/server/code.md | 10 |
1 files changed, 5 insertions, 5 deletions
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/). | |||
41 | 41 | ||
42 | The server is composed by: | 42 | The server is composed by: |
43 | 43 | ||
44 | * a REST API (Express framework) | 44 | * a REST API (relying on the Express framework) documented on http://docs.joinpeertube.org/api.html |
45 | * a WebTorrent Tracker | 45 | * a WebTorrent Tracker (slightly custom version of [webtorrent/bittorrent-tracker](https://github.com/webtorrent/bittorrent-tracker#server)) |
46 | 46 | ||
47 | A video is seeded by the server with the [WebSeed](http://www.bittorrent.org/beps/bep_0019.html) protocol (HTTP). | 47 | A video is seeded by the server with the [WebSeed](http://www.bittorrent.org/beps/bep_0019.html) protocol (HTTP). |
48 | 48 | ||
49 | ![Architecture scheme](/support/doc/development/server/upload-video.png) | 49 | ![Architecture scheme](/support/doc/development/server/upload-video.png) |
50 | 50 | ||
51 | When a user uploads a video, the rest API create the torrent file and then adds it to its database. | 51 | When a user uploads a video, the REST API creates the torrent file and then adds it to its database. |
52 | 52 | ||
53 | 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. | 53 | 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. |
54 | 54 | ||
55 | ## Newcomers | 55 | ## Newcomers |
56 | 56 | ||
57 | The server entrypoint is [server.ts](/server.ts). You can begin to look at this file. | 57 | The server entrypoint is [server.ts](/server.ts). Looking at this file is a good start. |
58 | Then you can try to understand the [controllers](/server/controllers): they are the entrypoint of each API request. | 58 | Then you can try to understand the [controllers](/server/controllers): they are the entrypoints of each API request. |