diff options
author | Chocobozzz <me@florianbigard.com> | 2018-06-15 16:52:15 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2018-06-15 18:20:56 +0200 |
commit | bbe0f0645ca958d33a3f409b15166609733b663f (patch) | |
tree | edcd5d702c73cda74a2177c4bdc08c616334337d /support/doc/api | |
parent | 2baea0c77cc765f7cbca9c9a2f4272268892a35c (diff) | |
download | PeerTube-bbe0f0645ca958d33a3f409b15166609733b663f.tar.gz PeerTube-bbe0f0645ca958d33a3f409b15166609733b663f.tar.zst PeerTube-bbe0f0645ca958d33a3f409b15166609733b663f.zip |
Add ability to schedule video publication
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/html/index.html | 80 | ||||
-rw-r--r-- | support/doc/api/openapi.yaml | 25 |
2 files changed, 97 insertions, 8 deletions
diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html index e1bf61b06..24017e674 100644 --- a/support/doc/api/html/index.html +++ b/support/doc/api/html/index.html | |||
@@ -264,6 +264,7 @@ | |||
264 | <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a> | 264 | <a href="#definition-GetMeVideoRating"> GetMeVideoRating </a> |
265 | <a href="#definition-RegisterUser"> RegisterUser </a> | 265 | <a href="#definition-RegisterUser"> RegisterUser </a> |
266 | <a href="#definition-VideoChannelInput"> VideoChannelInput </a> | 266 | <a href="#definition-VideoChannelInput"> VideoChannelInput </a> |
267 | <a href="#definition-ScheduleVideoUpdate"> ScheduleVideoUpdate </a> | ||
267 | </nav> | 268 | </nav> |
268 | </div> | 269 | </div> |
269 | <div id="docs" class="row collapse expanded drawer" data-drawer> | 270 | <div id="docs" class="row collapse expanded drawer" data-drawer> |
@@ -3530,6 +3531,19 @@ | |||
3530 | <p>Video privacy</p> | 3531 | <p>Video privacy</p> |
3531 | </div> | 3532 | </div> |
3532 | </div> | 3533 | </div> |
3534 | <div class="prop-row prop-group"> | ||
3535 | <div class="prop-name"> | ||
3536 | <div class="prop-title">scheduleUpdate</div> | ||
3537 | <div class="prop-subtitle"> in formData </div> | ||
3538 | <div class="prop-subtitle"> | ||
3539 | <span class="json-property-type">[object Object]</span> | ||
3540 | <span class="json-property-range" title="Value limits"></span> | ||
3541 | </div> | ||
3542 | </div> | ||
3543 | <div class="prop-value"> | ||
3544 | <p class="no-description">(no description)</p> | ||
3545 | </div> | ||
3546 | </div> | ||
3533 | </section> | 3547 | </section> |
3534 | </div> | 3548 | </div> |
3535 | <div class="doc-examples"></div> | 3549 | <div class="doc-examples"></div> |
@@ -4161,12 +4175,7 @@ | |||
4161 | <span class="json-property-required"></span> | 4175 | <span class="json-property-required"></span> |
4162 | <div class="prop-subtitle"> in formData </div> | 4176 | <div class="prop-subtitle"> in formData </div> |
4163 | <div class="prop-subtitle"> | 4177 | <div class="prop-subtitle"> |
4164 | <span class="json-property-type">string</span> | 4178 | <span class="json-property-type">[object Object]</span> |
4165 | <span class="json-property-enum" title="Possible values"> | ||
4166 | <span class="json-property-enum-item">Public</span>, | ||
4167 | <span class="json-property-enum-item">Unlisted</span>, | ||
4168 | <span class="json-property-enum-item">Private</span> | ||
4169 | </span> | ||
4170 | <span class="json-property-range" title="Value limits"></span> | 4179 | <span class="json-property-range" title="Value limits"></span> |
4171 | </div> | 4180 | </div> |
4172 | </div> | 4181 | </div> |
@@ -4174,6 +4183,19 @@ | |||
4174 | <p>Video privacy</p> | 4183 | <p>Video privacy</p> |
4175 | </div> | 4184 | </div> |
4176 | </div> | 4185 | </div> |
4186 | <div class="prop-row prop-group"> | ||
4187 | <div class="prop-name"> | ||
4188 | <div class="prop-title">scheduleUpdate</div> | ||
4189 | <div class="prop-subtitle"> in formData </div> | ||
4190 | <div class="prop-subtitle"> | ||
4191 | <span class="json-property-type">[object Object]</span> | ||
4192 | <span class="json-property-range" title="Value limits"></span> | ||
4193 | </div> | ||
4194 | </div> | ||
4195 | <div class="prop-value"> | ||
4196 | <p class="no-description">(no description)</p> | ||
4197 | </div> | ||
4198 | </div> | ||
4177 | </section> | 4199 | </section> |
4178 | </div> | 4200 | </div> |
4179 | <div class="doc-examples"></div> | 4201 | <div class="doc-examples"></div> |
@@ -8345,6 +8367,52 @@ | |||
8345 | </div> | 8367 | </div> |
8346 | </div> | 8368 | </div> |
8347 | </div> | 8369 | </div> |
8370 | <div id="definition-ScheduleVideoUpdate" class="definition panel" data-traverse-target="definition-ScheduleVideoUpdate"> | ||
8371 | <h2 class="panel-title"> | ||
8372 | <a name="/definitions/ScheduleVideoUpdate"></a>ScheduleVideoUpdate: | ||
8373 | <!-- <span class="json-property-type"><span class="json-property-type">object</span> | ||
8374 | <span class="json-property-range" title="Value limits"></span> | ||
8375 | |||
8376 | |||
8377 | </span> --> | ||
8378 | </h2> | ||
8379 | <div class="doc-row"> | ||
8380 | <div class="doc-copy"> | ||
8381 | <section class="json-schema-properties"> | ||
8382 | <dl> | ||
8383 | <dt data-property-name="updateAt" class="has-description"> | ||
8384 | <span class="json-property-name">updateAt:</span> | ||
8385 | <span class="json-property-type">dateTime</span> | ||
8386 | <span class="json-property-range" title="Value limits"></span> | ||
8387 | </dt> | ||
8388 | <dd> | ||
8389 | <p>When to update the video</p> | ||
8390 | </dd> | ||
8391 | <dt data-property-name="privacy"> | ||
8392 | <span class="json-property-name">privacy:</span> | ||
8393 | <span class="json-property-type"> | ||
8394 | <span class=""> | ||
8395 | <a class="json-schema-ref" href="#/definitions/VideoPrivacy">VideoPrivacy</a> | ||
8396 | </span> | ||
8397 | </span> | ||
8398 | <span class="json-property-range" title="Value limits"></span> | ||
8399 | </dt> | ||
8400 | </dl> | ||
8401 | </section> | ||
8402 | </div> | ||
8403 | <div class="doc-examples"> | ||
8404 | <section> | ||
8405 | <h5>Example</h5> | ||
8406 | <!-- <div class="hljs"> --><pre><code class="hljs lang-json">{ | ||
8407 | <span class="hljs-attr">"updateAt"</span>: <span class="hljs-string">"dateTime"</span>, | ||
8408 | <span class="hljs-attr">"privacy"</span>: <span class="hljs-string">"string"</span> | ||
8409 | } | ||
8410 | </code></pre> | ||
8411 | <!-- </div> --> | ||
8412 | </section> | ||
8413 | </div> | ||
8414 | </div> | ||
8415 | </div> | ||
8348 | <div class="doc-row no-margin"> | 8416 | <div class="doc-row no-margin"> |
8349 | <div class="doc-copy doc-separator"> | 8417 | <div class="doc-copy doc-separator"> |
8350 | <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by | 8418 | <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by |
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index be40af570..4b7bc23b4 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -711,6 +711,12 @@ paths: | |||
711 | type: string | 711 | type: string |
712 | enum: [Public, Unlisted] | 712 | enum: [Public, Unlisted] |
713 | description: 'Video privacy' | 713 | description: 'Video privacy' |
714 | - name: scheduleUpdate | ||
715 | in: formData | ||
716 | required: false | ||
717 | description: 'Schedule an update at a specific datetime' | ||
718 | type: | ||
719 | $ref: '#/definitions/ScheduleVideoUpdate' | ||
714 | responses: | 720 | responses: |
715 | '200': | 721 | '200': |
716 | description: successful operation | 722 | description: successful operation |
@@ -864,9 +870,15 @@ paths: | |||
864 | - name: privacy | 870 | - name: privacy |
865 | in: formData | 871 | in: formData |
866 | required: true | 872 | required: true |
867 | type: string | 873 | type: |
868 | enum: [Public, Unlisted, Private] | 874 | $ref: '#/definitions/VideoPrivacy' |
869 | description: 'Video privacy' | 875 | description: 'Video privacy' |
876 | - name: scheduleUpdate | ||
877 | in: formData | ||
878 | required: false | ||
879 | description: 'Schedule an update at a specific datetime' | ||
880 | type: | ||
881 | $ref: '#/definitions/ScheduleVideoUpdate' | ||
870 | responses: | 882 | responses: |
871 | '200': | 883 | '200': |
872 | description: successful operation | 884 | description: successful operation |
@@ -1709,3 +1721,12 @@ definitions: | |||
1709 | type: string | 1721 | type: string |
1710 | description: | 1722 | description: |
1711 | type: string | 1723 | type: string |
1724 | ScheduleVideoUpdate: | ||
1725 | properties: | ||
1726 | updateAt: | ||
1727 | type: dateTime | ||
1728 | description: 'When to update the video' | ||
1729 | required: true | ||
1730 | privacy: | ||
1731 | $ref: '#/definitions/VideoPrivacy' | ||
1732 | required: false \ No newline at end of file | ||