From 2186386cca113506791583cb07d6ccacba7af4e0 Mon Sep 17 00:00:00 2001
From: Chocobozzz <me@florianbigard.com>
Date: Tue, 12 Jun 2018 20:04:58 +0200
Subject: Add concept of video state, and add ability to wait transcoding
 before publishing a video

---
 support/doc/api/html/index.html | 26 ++++++++++++++++++++++++++
 support/doc/api/openapi.yaml    |  8 ++++++++
 support/doc/tools.md            |  9 +++++++--
 3 files changed, 41 insertions(+), 2 deletions(-)

(limited to 'support')

diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html
index b75a2a8ba..e1bf61b06 100644
--- a/support/doc/api/html/index.html
+++ b/support/doc/api/html/index.html
@@ -3435,6 +3435,19 @@
                       <p>Video description</p>
                     </div>
                   </div>
+                  <div class="prop-row prop-group">
+                    <div class="prop-name">
+                      <div class="prop-title">waitTranscoding</div>
+                      <div class="prop-subtitle"> in formData </div>
+                      <div class="prop-subtitle">
+                        <span class="json-property-type">boolean</span>
+                        <span class="json-property-range" title="Value limits"></span>
+                      </div>
+                    </div>
+                    <div class="prop-value">
+                      <p>Whether or not we wait transcoding before publish the video</p>
+                    </div>
+                  </div>
                   <div class="prop-row prop-group">
                     <div class="prop-name">
                       <div class="prop-title">support</div>
@@ -4009,6 +4022,19 @@
                       <p>Video category</p>
                     </div>
                   </div>
+                  <div class="prop-row prop-group">
+                    <div class="prop-name">
+                      <div class="prop-title">waitTranscoding</div>
+                      <div class="prop-subtitle"> in formData </div>
+                      <div class="prop-subtitle">
+                        <span class="json-property-type">boolean</span>
+                        <span class="json-property-range" title="Value limits"></span>
+                      </div>
+                    </div>
+                    <div class="prop-value">
+                      <p>Whether or not we wait transcoding before publish the video</p>
+                    </div>
+                  </div>
                   <div class="prop-row prop-group">
                     <div class="prop-name">
                       <div class="prop-title">licence</div>
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index a1e286973..be40af570 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -682,6 +682,10 @@ paths:
           in: formData
           type: string
           description: 'Video description'
+        - name: waitTranscoding
+          in: formData
+          type: boolean
+          description: 'Whether or not we wait transcoding before publish the video'
         - name: support
           in: formData
           type: string
@@ -814,6 +818,10 @@ paths:
           in: formData
           type: number
           description: 'Video category'
+        - name: waitTranscoding
+          in: formData
+          type: boolean
+          description: 'Whether or not we wait transcoding before publish the video'
         - name: licence
           in: formData
           type: number
diff --git a/support/doc/tools.md b/support/doc/tools.md
index 85ce0428d..26b44c835 100644
--- a/support/doc/tools.md
+++ b/support/doc/tools.md
@@ -63,13 +63,18 @@ $ node dist/server/tools/import-videos.js \
   * Vimeo: https://vimeo.com/xxxxxx
   * Dailymotion: https://www.dailymotion.com/xxxxx
 
- The script will get all public videos from Youtube, download them and upload to PeerTube.  
- Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
+The script will get all public videos from Youtube, download them and upload to PeerTube.
+Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
+
+Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
+
 
 ### upload.js
 
 You can use this script to import videos directly from the CLI.
 
+Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
+
 ```
 $ cd ${CLONE}
 $ node dist/server/tools/upload.js --help
-- 
cgit v1.2.3