Skip to content

Commit

Permalink
Merge pull request #30 from apivideo/change-from-specification
Browse files Browse the repository at this point in the history
Change from spec: update mp4 urls
  • Loading branch information
bot-api-video authored May 2, 2022
2 parents 4a46356 + 6d11940 commit aa92cea
Show file tree
Hide file tree
Showing 27 changed files with 57 additions and 198 deletions.
2 changes: 1 addition & 1 deletion .openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
Original file line number Diff line number Diff line change
@@ -1 +1 @@
83a284189e8563226661d57e8ab4ca3a79c4cf6b98a313c193e42cd7ad04c433
fa7ac2451c4cf442853cb5c85c8372aa1c7969a3232442adf3109d7346edc5f2
15 changes: 0 additions & 15 deletions Sources/APIs/CaptionsAPI.swift
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ open class CaptionsAPI {
Upload a caption
- POST /videos/{videoId}/captions/{language}
- Upload a VTT file to add captions to your video. Read our [captioning tutorial](https://api.video/blog/tutorials/adding-captions) for more details.
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to add a caption to.
- parameter language: (path) A valid BCP 47 language representation.
- parameter file: (form) The video text track (VTT) you want to upload.
Expand Down Expand Up @@ -102,9 +99,6 @@ open class CaptionsAPI {
- Retrieve a caption for a video in a specific language. If the language is available, the caption is returned. Otherwise, you will get a error indicating the caption was not found.
Tutorials that use the [captions endpoint](https://api.video/blog/endpoints/captions).
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want captions for.
- parameter language: (path) A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation
- returns: RequestBuilder<Caption>
Expand Down Expand Up @@ -160,9 +154,6 @@ Tutorials that use the [captions endpoint](https://api.video/blog/endpoints/capt
Update a caption
- PATCH /videos/{videoId}/captions/{language}
- To have the captions on automatically, use this method to set default: true.
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to have automatic captions for.
- parameter language: (path) A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.
- parameter captionsUpdatePayload: (body)
Expand Down Expand Up @@ -218,9 +209,6 @@ Tutorials that use the [captions endpoint](https://api.video/blog/endpoints/capt
Delete a caption
- DELETE /videos/{videoId}/captions/{language}
- Delete a caption in a specific language by providing the video ID for the video you want to delete the caption from and the language the caption is in.
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to delete a caption from.
- parameter language: (path) A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.
- returns: RequestBuilder<Void>
Expand Down Expand Up @@ -276,9 +264,6 @@ Tutorials that use the [captions endpoint](https://api.video/blog/endpoints/capt
List video captions
- GET /videos/{videoId}/captions
- Retrieve a list of available captions for the videoId you provide.
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to retrieve a list of captions for.
- parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
- parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
Expand Down
12 changes: 0 additions & 12 deletions Sources/APIs/ChaptersAPI.swift
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ open class ChaptersAPI {
Upload a chapter
- POST /videos/{videoId}/chapters/{language}
- Upload a VTT file to add chapters to your video. Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos) for more details.
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to upload a chapter for.
- parameter language: (path) A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.
- parameter file: (form) The VTT file describing the chapters you want to upload.
Expand Down Expand Up @@ -100,9 +97,6 @@ open class ChaptersAPI {
Retrieve a chapter
- GET /videos/{videoId}/chapters/{language}
- Retrieve a chapter for a video in a specific language. Chapters help your viewers find the sections of the video they are most interested in viewing. Tutorials that use the [chapters endpoint](https://api.video/blog/endpoints/chapters).
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to show a chapter for.
- parameter language: (path) A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.
- returns: RequestBuilder<Chapter>
Expand Down Expand Up @@ -157,9 +151,6 @@ open class ChaptersAPI {
Delete a chapter
- DELETE /videos/{videoId}/chapters/{language}
- Delete a chapter in a specific language by providing the video ID for the video you want to delete the chapter from and the language the chapter is in.
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to delete a chapter from.
- parameter language: (path) A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.
- returns: RequestBuilder<Void>
Expand Down Expand Up @@ -215,9 +206,6 @@ open class ChaptersAPI {
List video chapters
- GET /videos/{videoId}/chapters
- Retrieve a list of all chapters for a specified video.
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to retrieve a list of chapters for.
- parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
- parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
Expand Down
21 changes: 0 additions & 21 deletions Sources/APIs/LiveStreamsAPI.swift
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ open class LiveStreamsAPI {
Create live stream
- POST /live-streams
- A live stream will give you the 'connection point' to RTMP your video stream to api.video. It will also give you the details for viewers to watch the same livestream. The public=false 'private livestream' is available as a BETA feature, and should be limited to livestreams of 3,000 viewers or fewer. See our [Live Stream Tutorial](https://api.video/blog/tutorials/live-stream-tutorial) for a walkthrough of this API with OBS. Your RTMP endpoint for the livestream is rtmp://broadcast.api.video/s/{streamKey} Tutorials that [create live streams](https://api.video/blog/endpoints/live-create).
- BASIC:
- type: http
- name: bearerAuth
- parameter liveStreamCreationPayload: (body)
- returns: RequestBuilder<LiveStream>
*/
Expand Down Expand Up @@ -85,9 +82,6 @@ open class LiveStreamsAPI {
Retrieve live stream
- GET /live-streams/{liveStreamId}
- Supply a liveStreamId, and you'll get all the details for streaming into, and watching the livestream. Tutorials that use the [show livestream endpoint](https://api.video/blog/endpoints/live-stream-status).
- BASIC:
- type: http
- name: bearerAuth
- parameter liveStreamId: (path) The unique ID for the live stream you want to watch.
- returns: RequestBuilder<LiveStream>
*/
Expand Down Expand Up @@ -138,9 +132,6 @@ open class LiveStreamsAPI {
Update a live stream
- PATCH /live-streams/{liveStreamId}
- Use this endpoint to update the player, or to turn recording on/off (saving a copy of the livestream). NOTE: If the livestream is actively streaming, changing the recording status will only affect the NEXT stream. The public=false \"private livestream\" is available as a BETA feature, and should be limited to livestreams of 3,000 viewers or fewer.
- BASIC:
- type: http
- name: bearerAuth
- parameter liveStreamId: (path) The unique ID for the live stream that you want to update information for such as player details, or whether you want the recording on or off.
- parameter liveStreamUpdatePayload: (body)
- returns: RequestBuilder<LiveStream>
Expand Down Expand Up @@ -191,9 +182,6 @@ open class LiveStreamsAPI {
Delete a live stream
- DELETE /live-streams/{liveStreamId}
- If you do not need a live stream any longer, you can send a request to delete it. All you need is the liveStreamId.
- BASIC:
- type: http
- name: bearerAuth
- parameter liveStreamId: (path) The unique ID for the live stream that you want to remove.
- returns: RequestBuilder<Void>
*/
Expand Down Expand Up @@ -256,9 +244,6 @@ open class LiveStreamsAPI {
List all live streams
- GET /live-streams
- With no parameters added to the url, this will return all livestreams. Query by name or key to limit the list.
- BASIC:
- type: http
- name: bearerAuth
- parameter streamKey: (query) The unique stream key that allows you to stream videos. (optional)
- parameter name: (query) You can filter live streams by their name or a part of their name. (optional)
- parameter sortBy: (query) Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format. (optional)
Expand Down Expand Up @@ -319,9 +304,6 @@ open class LiveStreamsAPI {
Upload a thumbnail
- POST /live-streams/{liveStreamId}/thumbnail
- Upload an image to use as a backdrop for your livestream. Tutorials that [update live stream thumbnails](https://api.video/blog/endpoints/live-upload-a-thumbnail).
- BASIC:
- type: http
- name: bearerAuth
- parameter liveStreamId: (path) The unique ID for the live stream you want to upload.
- parameter file: (form) The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB.
- returns: RequestBuilder<LiveStream>
Expand Down Expand Up @@ -376,9 +358,6 @@ open class LiveStreamsAPI {
Delete a thumbnail
- DELETE /live-streams/{liveStreamId}/thumbnail
- Send the unique identifier for a live stream to delete its thumbnail.
- BASIC:
- type: http
- name: bearerAuth
- parameter liveStreamId: (path) The unique identifier of the live stream whose thumbnail you want to delete.
- returns: RequestBuilder<LiveStream>
*/
Expand Down
21 changes: 0 additions & 21 deletions Sources/APIs/PlayerThemesAPI.swift
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ open class PlayerThemesAPI {
Create a player
- POST /players
- Create a player for your video, and customise it.
- BASIC:
- type: http
- name: bearerAuth
- parameter playerThemeCreationPayload: (body)
- returns: RequestBuilder<PlayerTheme>
*/
Expand Down Expand Up @@ -85,9 +82,6 @@ open class PlayerThemesAPI {
Retrieve a player
- GET /players/{playerId}
- Use a player ID to retrieve details about the player and display it for viewers.
- BASIC:
- type: http
- name: bearerAuth
- parameter playerId: (path) The unique identifier for the player you want to retrieve.
- returns: RequestBuilder<PlayerTheme>
*/
Expand Down Expand Up @@ -138,9 +132,6 @@ open class PlayerThemesAPI {
Update a player
- PATCH /players/{playerId}
- Use a player ID to update specific details for a player. NOTE: It may take up to 10 min before the new player configuration is available from our CDN.
- BASIC:
- type: http
- name: bearerAuth
- parameter playerId: (path) The unique identifier for the player.
- parameter playerThemeUpdatePayload: (body)
- returns: RequestBuilder<PlayerTheme>
Expand Down Expand Up @@ -191,9 +182,6 @@ open class PlayerThemesAPI {
Delete a player
- DELETE /players/{playerId}
- Delete a player if you no longer need it. You can delete any player that you have the player ID for.
- BASIC:
- type: http
- name: bearerAuth
- parameter playerId: (path) The unique identifier for the player you want to delete.
- returns: RequestBuilder<Void>
*/
Expand Down Expand Up @@ -263,9 +251,6 @@ open class PlayerThemesAPI {
List all player themes
- GET /players
- Retrieve a list of all the player themes you created, as well as details about each one. Tutorials that use the [player endpoint](https://api.video/blog/endpoints/player).
- BASIC:
- type: http
- name: bearerAuth
- parameter sortBy: (query) createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. (optional)
- parameter sortOrder: (query) Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. (optional)
- parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
Expand Down Expand Up @@ -323,9 +308,6 @@ open class PlayerThemesAPI {
Upload a logo
- POST /players/{playerId}/logo
- The uploaded image maximum size should be 200x100 and its weight should be 100KB. It will be scaled down to 30px height and converted to PNG to be displayed in the player.
- BASIC:
- type: http
- name: bearerAuth
- parameter playerId: (path) The unique identifier for the player.
- parameter file: (form) The name of the file you want to use for your logo.
- parameter link: (form) A public link that you want to advertise in your player. For example, you could add a link to your company. When a viewer clicks on your logo, they will be taken to this address. (optional)
Expand Down Expand Up @@ -382,9 +364,6 @@ open class PlayerThemesAPI {
Delete logo
- DELETE /players/{playerId}/logo
- Delete the logo associated to a player.
- BASIC:
- type: http
- name: bearerAuth
- parameter playerId: (path) The unique identifier for the player.
- returns: RequestBuilder<Void>
*/
Expand Down
9 changes: 0 additions & 9 deletions Sources/APIs/RawStatisticsAPI.swift
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ open class RawStatisticsAPI {
/**
List live stream player sessions
- GET /analytics/live-streams/{liveStreamId}
- BASIC:
- type: http
- name: bearerAuth
- parameter liveStreamId: (path) The unique identifier for the live stream you want to retrieve analytics for.
- parameter period: (query) Period must have one of the following formats: - For a day : \&quot;2018-01-01\&quot;, - For a week: \&quot;2018-W01\&quot;, - For a month: \&quot;2018-01\&quot; - For a year: \&quot;2018\&quot; For a range period: - Date range: \&quot;2018-01-01/2018-01-15\&quot; (optional)
- parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
Expand Down Expand Up @@ -100,9 +97,6 @@ open class RawStatisticsAPI {
List player session events
- GET /analytics/sessions/{sessionId}/events
- Useful to track and measure video's engagement.
- BASIC:
- type: http
- name: bearerAuth
- parameter sessionId: (path) A unique identifier you can use to reference and track a session with.
- parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
- parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
Expand Down Expand Up @@ -162,9 +156,6 @@ open class RawStatisticsAPI {
List video player sessions
- GET /analytics/videos/{videoId}
- Retrieve all available user sessions for a specific video. Tutorials that use the [analytics endpoint](https://api.video/blog/endpoints/analytics).
- BASIC:
- type: http
- name: bearerAuth
- parameter videoId: (path) The unique identifier for the video you want to retrieve session information for.
- parameter period: (query) Period must have one of the following formats: - For a day : 2018-01-01, - For a week: 2018-W01, - For a month: 2018-01 - For a year: 2018 For a range period: - Date range: 2018-01-01/2018-01-15 (optional)
- parameter metadata: (query) Metadata and [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) filter. Send an array of key value pairs you want to filter sessios with. (optional)
Expand Down
12 changes: 0 additions & 12 deletions Sources/APIs/UploadTokensAPI.swift
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ open class UploadTokensAPI {
Generate an upload token
- POST /upload-tokens
- Use this endpoint to generate an upload token. You can use this token to authenticate video uploads while keeping your API key safe. Tutorials using [delegated upload](https://api.video/blog/endpoints/delegated-upload).
- BASIC:
- type: http
- name: bearerAuth
- parameter tokenCreationPayload: (body)
- returns: RequestBuilder<UploadToken>
*/
Expand Down Expand Up @@ -85,9 +82,6 @@ open class UploadTokensAPI {
Retrieve upload token
- GET /upload-tokens/{uploadToken}
- You can retrieve details about a specific upload token if you have the unique identifier for the upload token. Add it in the path of the endpoint. Details include time-to-live (ttl), when the token was created, and when it will expire.
- BASIC:
- type: http
- name: bearerAuth
- parameter uploadToken: (path) The unique identifier for the token you want information about.
- returns: RequestBuilder<UploadToken>
*/
Expand Down Expand Up @@ -137,9 +131,6 @@ open class UploadTokensAPI {
Delete an upload token
- DELETE /upload-tokens/{uploadToken}
- Delete an existing upload token. This is especially useful for tokens you may have created that do not expire.
- BASIC:
- type: http
- name: bearerAuth
- parameter uploadToken: (path) The unique identifier for the upload token you want to delete. Deleting a token will make it so the token can no longer be used for authentication.
- returns: RequestBuilder<Void>
*/
Expand Down Expand Up @@ -208,9 +199,6 @@ open class UploadTokensAPI {
List all active upload tokens.
- GET /upload-tokens
- A delegated token is used to allow secure uploads without exposing your API key. Use this endpoint to retrieve a list of all currently active delegated tokens. Tutorials using [delegated upload](https://api.video/blog/endpoints/delegated-upload).
- BASIC:
- type: http
- name: bearerAuth
- parameter sortBy: (query) Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ISO-8601 format. (optional)
- parameter sortOrder: (query) Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. (optional)
- parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
Expand Down
Loading

0 comments on commit aa92cea

Please sign in to comment.