aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2020-11-09 11:21:08 +0100
committerChocobozzz <chocobozzz@cpy.re>2020-11-09 15:33:04 +0100
commit4e239e3554ba7162c03e939f54133933527a1b74 (patch)
treed1061a3bd2bf4429f9399ef5173a1da80dd49e82 /support/doc/api
parentc655c9ef6f7ddb47a153adc04d5c10c6de3d5ed7 (diff)
downloadPeerTube-4e239e3554ba7162c03e939f54133933527a1b74.tar.gz
PeerTube-4e239e3554ba7162c03e939f54133933527a1b74.tar.zst
PeerTube-4e239e3554ba7162c03e939f54133933527a1b74.zip
Add open api doc for live
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml142
1 files changed, 142 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 4c6e0d12c..4a178e4d7 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -160,6 +160,7 @@ x-tagGroups:
160 - Video Playlists 160 - Video Playlists
161 - Video Ownership Change 161 - Video Ownership Change
162 - Video Mirroring 162 - Video Mirroring
163 - Live Videos
163 - Feeds 164 - Feeds
164 - name: Search 165 - name: Search
165 tags: 166 tags:
@@ -1481,6 +1482,129 @@ paths:
1481 '400': 1482 '400':
1482 description: '`magnetUri` or `targetUrl` or a torrent file missing' 1483 description: '`magnetUri` or `targetUrl` or a torrent file missing'
1483 1484
1485 /videos/live:
1486 post:
1487 summary: Create a live
1488 security:
1489 - OAuth2: []
1490 tags:
1491 - Live Videos
1492 - Video
1493 responses:
1494 '200':
1495 description: successful operation
1496 content:
1497 application/json:
1498 schema:
1499 $ref: '#/components/schemas/VideoUploadResponse'
1500 '403':
1501 description: Live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
1502 requestBody:
1503 content:
1504 multipart/form-data:
1505 schema:
1506 type: object
1507 properties:
1508 channelId:
1509 description: Channel id that will contain this live video
1510 type: integer
1511 saveReplay:
1512 type: boolean
1513 thumbnailfile:
1514 description: Live video/replay thumbnail file
1515 type: string
1516 format: binary
1517 previewfile:
1518 description: Live video/replay preview file
1519 type: string
1520 format: binary
1521 privacy:
1522 $ref: '#/components/schemas/VideoPrivacySet'
1523 category:
1524 description: Live video/replay category
1525 type: string
1526 licence:
1527 description: Live video/replay licence
1528 type: string
1529 language:
1530 description: Live video/replay language
1531 type: string
1532 description:
1533 description: Live video/replay description
1534 type: string
1535 support:
1536 description: A text tell the audience how to support the creator
1537 example: Please support my work on <insert crowdfunding plateform>! <3
1538 type: string
1539 nsfw:
1540 description: Whether or not this live video/replay contains sensitive content
1541 type: boolean
1542 name:
1543 description: Live video/replay name
1544 type: string
1545 tags:
1546 description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters)
1547 type: array
1548 minItems: 1
1549 maxItems: 5
1550 items:
1551 type: string
1552 minLength: 2
1553 maxLength: 30
1554 commentsEnabled:
1555 description: Enable or disable comments for this live video/replay
1556 type: boolean
1557 downloadEnabled:
1558 description: Enable or disable downloading for the replay of this live
1559 type: boolean
1560 required:
1561 - channelId
1562 - name
1563 encoding:
1564 thumbnailfile:
1565 contentType: image/jpeg
1566 previewfile:
1567 contentType: image/jpeg
1568
1569 /videos/live/{id}:
1570 get:
1571 summary: Get a live information
1572 security:
1573 - OAuth2: []
1574 tags:
1575 - Live Videos
1576 - Video
1577 parameters:
1578 - $ref: '#/components/parameters/idOrUUID'
1579 responses:
1580 '200':
1581 description: successful operation
1582 content:
1583 application/json:
1584 schema:
1585 $ref: '#/components/schemas/LiveVideoResponse'
1586 put:
1587 summary: Update a live information
1588 security:
1589 - OAuth2: []
1590 tags:
1591 - Live Videos
1592 - Video
1593 parameters:
1594 - $ref: '#/components/parameters/idOrUUID'
1595 requestBody:
1596 content:
1597 application/json:
1598 schema:
1599 $ref: '#/components/schemas/LiveVideoUpdate'
1600 responses:
1601 '204':
1602 description: Successful operation
1603 '400':
1604 description: Bad parameters or trying to update a live that has already started
1605 '403':
1606 description: Trying to save replay of the live but saving replay is not enabled on the instance
1607
1484 /users/me/abuses: 1608 /users/me/abuses:
1485 get: 1609 get:
1486 summary: List my abuses 1610 summary: List my abuses
@@ -3858,6 +3982,8 @@ components:
3858 type: string 3982 type: string
3859 format: uuid 3983 format: uuid
3860 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d 3984 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3985 isLive:
3986 type: boolean
3861 createdAt: 3987 createdAt:
3862 type: string 3988 type: string
3863 format: date-time 3989 format: date-time
@@ -5419,6 +5545,22 @@ components:
5419 maxItems: 100 5545 maxItems: 100
5420 items: 5546 items:
5421 $ref: '#/components/schemas/Plugin' 5547 $ref: '#/components/schemas/Plugin'
5548
5549 LiveVideoUpdate:
5550 properties:
5551 saveReplay:
5552 type: boolean
5553
5554 LiveVideoResponse:
5555 properties:
5556 rtmpUrl:
5557 type: string
5558 streamKey:
5559 type: string
5560 description: RTMP stream key to use to stream into this live video
5561 saveReplay:
5562 type: boolean
5563
5422 callbacks: 5564 callbacks:
5423 searchIndex: 5565 searchIndex:
5424 'https://search.example.org/api/v1/search/videos': 5566 'https://search.example.org/api/v1/search/videos':