aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2021-05-11 01:50:36 +0200
committerRigel Kent <sendmemail@rigelk.eu>2021-05-11 01:50:42 +0200
commit2c4876f215884c0ada750245138d74460f8e4e2f (patch)
treeecc10079901e945c253acf1f92d551b5e870d1b2 /support/doc/api
parentde3876b815c9f095f557fe8bd6ee7c22d842c974 (diff)
downloadPeerTube-2c4876f215884c0ada750245138d74460f8e4e2f.tar.gz
PeerTube-2c4876f215884c0ada750245138d74460f8e4e2f.tar.zst
PeerTube-2c4876f215884c0ada750245138d74460f8e4e2f.zip
added descriptions for video files/import fields in openapi spec
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml52
1 files changed, 39 insertions, 13 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 1a0822c8f..458aa9c94 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1679,14 +1679,13 @@ paths:
1679 type: string 1679 type: string
1680 format: binary 1680 format: binary
1681 targetUrl: 1681 targetUrl:
1682 description: HTTP target URL 1682 $ref: '#/components/schemas/VideoImport/properties/targetUrl'
1683 type: string
1684 magnetUri: 1683 magnetUri:
1685 description: Magnet URI 1684 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
1686 type: string
1687 channelId: 1685 channelId:
1688 description: Channel id that will contain this video 1686 description: Channel id that will contain this video
1689 type: integer 1687 allOf:
1688 - $ref: '#/components/schemas/VideoChannel/properties/id'
1690 thumbnailfile: 1689 thumbnailfile:
1691 description: Video thumbnail file 1690 description: Video thumbnail file
1692 type: string 1691 type: string
@@ -4425,6 +4424,7 @@ components:
4425 `0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos. 4424 `0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.
4426 example: 240 4425 example: 240
4427 VideoResolutionConstant: 4426 VideoResolutionConstant:
4427 description: resolutions and their labels for the video
4428 properties: 4428 properties:
4429 id: 4429 id:
4430 $ref: '#/components/schemas/VideoResolutionSet' 4430 $ref: '#/components/schemas/VideoResolutionSet'
@@ -4490,14 +4490,19 @@ components:
4490 allOf: 4490 allOf:
4491 - $ref: '#/components/schemas/Video' 4491 - $ref: '#/components/schemas/Video'
4492 VideoFile: 4492 VideoFile:
4493 readOnly: true
4493 properties: 4494 properties:
4494 magnetUri: 4495 magnetUri:
4495 type: string 4496 type: string
4497 format: uri
4498 description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file
4499 example: magnet:?xs=https%3A%2F%2Fframatube.org%2Fstatic%2Ftorrents%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.torrent&xt=urn:btih:38b4747ff788b30bf61f59d1965cd38f9e48e01f&dn=What+is+PeerTube%3F&tr=wss%3A%2F%2Fframatube.org%2Ftracker%2Fsocket&tr=https%3A%2F%2Fframatube.org%2Ftracker%2Fannounce&ws=https%3A%2F%2Fframatube.org%2Fstatic%2Fwebseed%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.mp4
4500 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
4496 resolution: 4501 resolution:
4497 $ref: '#/components/schemas/VideoResolutionConstant' 4502 $ref: '#/components/schemas/VideoResolutionConstant'
4498 size: 4503 size:
4499 type: integer 4504 type: integer
4500 description: 'Video file size in bytes' 4505 description: Video file size in bytes
4501 torrentUrl: 4506 torrentUrl:
4502 type: string 4507 type: string
4503 description: Direct URL of the torrent file 4508 description: Direct URL of the torrent file
@@ -4516,9 +4521,11 @@ components:
4516 format: url 4521 format: url
4517 fps: 4522 fps:
4518 type: number 4523 type: number
4524 description: Frames per second of the video file
4519 metadataUrl: 4525 metadataUrl:
4520 type: string 4526 type: string
4521 format: url 4527 format: url
4528 description: URL dereferencing the output of ffprobe on the file
4522 VideoStreamingPlaylists: 4529 VideoStreamingPlaylists:
4523 allOf: 4530 allOf:
4524 - type: object 4531 - type: object
@@ -4719,6 +4726,9 @@ components:
4719 items: 4726 items:
4720 type: string 4727 type: string
4721 format: url 4728 format: url
4729 example:
4730 - https://peertube2.cpy.re/tracker/announce
4731 - wss://peertube2.cpy.re/tracker/socket
4722 files: 4732 files:
4723 type: array 4733 type: array
4724 items: 4734 items:
@@ -4803,11 +4813,14 @@ components:
4803 targetUrl: 4813 targetUrl:
4804 type: string 4814 type: string
4805 format: url 4815 format: url
4816 description: remote URL where to find the import's source video
4806 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d 4817 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
4807 magnetUri: 4818 magnetUri:
4808 type: string 4819 type: string
4809 format: uri 4820 format: uri
4821 description: magnet URI allowing to resolve the import's source video
4810 example: magnet:?xs=https%3A%2F%2Fframatube.org%2Fstatic%2Ftorrents%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.torrent&xt=urn:btih:38b4747ff788b30bf61f59d1965cd38f9e48e01f&dn=What+is+PeerTube%3F&tr=wss%3A%2F%2Fframatube.org%2Ftracker%2Fsocket&tr=https%3A%2F%2Fframatube.org%2Ftracker%2Fannounce&ws=https%3A%2F%2Fframatube.org%2Fstatic%2Fwebseed%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.mp4 4822 example: magnet:?xs=https%3A%2F%2Fframatube.org%2Fstatic%2Ftorrents%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.torrent&xt=urn:btih:38b4747ff788b30bf61f59d1965cd38f9e48e01f&dn=What+is+PeerTube%3F&tr=wss%3A%2F%2Fframatube.org%2Ftracker%2Fsocket&tr=https%3A%2F%2Fframatube.org%2Ftracker%2Fannounce&ws=https%3A%2F%2Fframatube.org%2Fstatic%2Fwebseed%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.mp4
4823 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
4811 torrentName: 4824 torrentName:
4812 type: string 4825 type: string
4813 state: 4826 state:
@@ -4821,7 +4834,9 @@ components:
4821 type: string 4834 type: string
4822 format: date-time 4835 format: date-time
4823 video: 4836 video:
4824 $ref: '#/components/schemas/Video' 4837 nullable: true
4838 allOf:
4839 - $ref: '#/components/schemas/Video'
4825 VideoImportsList: 4840 VideoImportsList:
4826 properties: 4841 properties:
4827 total: 4842 total:
@@ -5020,16 +5035,24 @@ components:
5020 type: string 5035 type: string
5021 format: url 5036 format: url
5022 name: 5037 name:
5023 type: string 5038 description: immutable name of the actor
5039 allOf:
5040 - $ref: '#/components/schemas/username'
5024 host: 5041 host:
5025 type: string 5042 type: string
5026 format: hostname 5043 format: hostname
5044 description: server on which the actor is resident
5027 hostRedundancyAllowed: 5045 hostRedundancyAllowed:
5028 type: boolean 5046 type: boolean
5047 description: whether this actor's host allows redundancy of its videos
5029 followingCount: 5048 followingCount:
5030 type: integer 5049 type: integer
5050 minimum: 0
5051 description: number of actors subscribed to by this actor, as seen by this instance
5031 followersCount: 5052 followersCount:
5032 type: integer 5053 type: integer
5054 minimum: 0
5055 description: number of followers of this actor, as seen by this instance
5033 createdAt: 5056 createdAt:
5034 type: string 5057 type: string
5035 format: date-time 5058 format: date-time
@@ -5043,11 +5066,15 @@ components:
5043 - $ref: '#/components/schemas/Actor' 5066 - $ref: '#/components/schemas/Actor'
5044 - properties: 5067 - properties:
5045 userId: 5068 userId:
5046 $ref: '#/components/schemas/id' 5069 description: object id for the user tied to this account
5070 allOf:
5071 - $ref: '#/components/schemas/User/properties/id'
5047 displayName: 5072 displayName:
5048 type: string 5073 type: string
5074 description: name displayed on the account's profile
5049 description: 5075 description:
5050 type: string 5076 type: string
5077 description: text or bio displayed on the account's profile
5051 UserWatchingVideo: 5078 UserWatchingVideo:
5052 properties: 5079 properties:
5053 currentTime: 5080 currentTime:
@@ -5698,7 +5725,8 @@ components:
5698 type: boolean 5725 type: boolean
5699 description: Has the user confirmed their email address? 5726 description: Has the user confirmed their email address?
5700 id: 5727 id:
5701 type: integer 5728 allOf:
5729 - $ref: '#/components/schemas/id'
5702 readOnly: true 5730 readOnly: true
5703 pluginAuth: 5731 pluginAuth:
5704 type: string 5732 type: string
@@ -6225,9 +6253,7 @@ components:
6225 type: string 6253 type: string
6226 nullable: true 6254 nullable: true
6227 magnetUri: 6255 magnetUri:
6228 type: string 6256 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
6229 format: uri
6230 nullable: true
6231 targetUri: 6257 targetUri:
6232 type: string 6258 type: string
6233 format: uri 6259 format: uri