aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2020-02-17 09:03:49 +0100
committerChocobozzz <me@florianbigard.com>2020-02-17 09:03:49 +0100
commit1d17d86349fd2b3a9bc85145d02383ba4aea4dc0 (patch)
tree8f6e7138123b8f7c46d618f9695c30a39f16e111 /support/doc/api
parenta30a136c9896c656cab98d2c92cde32c534dc098 (diff)
parent45de2dfcb5b3d56f0bc978b25b9746354890262e (diff)
downloadPeerTube-1d17d86349fd2b3a9bc85145d02383ba4aea4dc0.tar.gz
PeerTube-1d17d86349fd2b3a9bc85145d02383ba4aea4dc0.tar.zst
PeerTube-1d17d86349fd2b3a9bc85145d02383ba4aea4dc0.zip
Merge branch 'open-api-clients' into develop
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml3
1 files changed, 3 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index b1e5f90f8..180f65bcf 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -13,6 +13,7 @@ info:
13 altText: PeerTube Project Homepage 13 altText: PeerTube Project Homepage
14 description: | 14 description: |
15 # Introduction 15 # Introduction
16
16 The PeerTube API is built on HTTP(S). Our API is RESTful. It has predictable 17 The PeerTube API is built on HTTP(S). Our API is RESTful. It has predictable
17 resource URLs. It returns HTTP response codes to indicate errors. It also 18 resource URLs. It returns HTTP response codes to indicate errors. It also
18 accepts and returns JSON in the HTTP body. You can use your favorite 19 accepts and returns JSON in the HTTP body. You can use your favorite
@@ -22,11 +23,13 @@ info:
22 which generates a client SDK in the language of your choice. 23 which generates a client SDK in the language of your choice.
23 24
24 # Authentication 25 # Authentication
26
25 When you sign up for an account, you are given the possibility to generate 27 When you sign up for an account, you are given the possibility to generate
26 sessions, and authenticate using this session token. One session token can 28 sessions, and authenticate using this session token. One session token can
27 currently be used at a time. 29 currently be used at a time.
28 30
29 # Errors 31 # Errors
32
30 The API uses standard HTTP status codes to indicate the success or failure 33 The API uses standard HTTP status codes to indicate the success or failure
31 of the API call. The body of the response will be JSON in the following 34 of the API call. The body of the response will be JSON in the following
32 format. 35 format.