Skip to content

feat: Updated OpenAPI spec #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Aug 29, 2026
Merged

feat: Updated OpenAPI spec #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/libs/Shotstack/Generated/Shotstack.Models.Asset.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ public bool TryPickLuma(
: throw new global::System.InvalidOperationException($"Expected union variant 'Luma' but the value was {ToString()}.");

/// <summary>
/// **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**<br/>
/// The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will<br/>
/// be read and burnt to the video.<br/>
/// Captions can be applied independently from a video or audio file for greater<br/>
Expand Down
21 changes: 9 additions & 12 deletions src/libs/Shotstack/Generated/Shotstack.Models.CaptionAsset.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
namespace Shotstack
{
/// <summary>
/// **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**<br/>
/// The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will<br/>
/// be read and burnt to the video.<br/>
/// Captions can be applied independently from a video or audio file for greater<br/>
Expand All @@ -12,6 +13,7 @@ namespace Shotstack
/// To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with<br/>
/// matching start and end time.
/// </summary>
[global::System.Obsolete("This model marked as deprecated.")]
public sealed partial class CaptionAsset
{
/// <summary>
Expand All @@ -21,6 +23,7 @@ public sealed partial class CaptionAsset
/// <default>global::Shotstack.CaptionAssetType.Caption</default>
[global::System.Text.Json.Serialization.JsonPropertyName("type")]
[global::System.Text.Json.Serialization.JsonConverter(typeof(global::Shotstack.JsonConverters.CaptionAssetTypeJsonConverter))]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.CaptionAssetType Type { get; set; } = global::Shotstack.CaptionAssetType.Caption;

/// <summary>
Expand All @@ -30,24 +33,28 @@ public sealed partial class CaptionAsset
/// <example>https://s3-ap-northeast-1.amazonaws.com/my-bucket/captions.srt</example>
[global::System.Text.Json.Serialization.JsonPropertyName("src")]
[global::System.Text.Json.Serialization.JsonRequired]
[global::System.Obsolete("This property marked as deprecated.")]
public required string Src { get; set; }

/// <summary>
/// Font properties for captions text.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("font")]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.CaptionFont? Font { get; set; }

/// <summary>
/// Displays a background box behind the caption text.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("background")]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.CaptionBackground? Background { get; set; }

/// <summary>
/// The margin properties for captions. Margins are used to position the caption text and background on the screen.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("margin")]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.CaptionMargin? Margin { get; set; }

/// <summary>
Expand All @@ -56,6 +63,7 @@ public sealed partial class CaptionAsset
/// </summary>
/// <example>2</example>
[global::System.Text.Json.Serialization.JsonPropertyName("trim")]
[global::System.Obsolete("This property marked as deprecated.")]
public double? Trim { get; set; }

/// <summary>
Expand All @@ -64,6 +72,7 @@ public sealed partial class CaptionAsset
/// </summary>
/// <example>1</example>
[global::System.Text.Json.Serialization.JsonPropertyName("speed")]
[global::System.Obsolete("This property marked as deprecated.")]
public float? Speed { get; set; }

/// <summary>
Expand Down Expand Up @@ -128,17 +137,5 @@ public CaptionAsset()
{
}

/// <summary>
/// Creates a new <see cref="CaptionAsset"/> from its single non-const required field,
/// hardcoding any const discriminator fields.
/// </summary>
public static CaptionAsset FromSrc(string src)
{
return new CaptionAsset
{
Src = src,
};
}

}
}
2 changes: 2 additions & 0 deletions src/libs/Shotstack/Generated/Shotstack.Models.RenderResponseData.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ public sealed partial class RenderResponseData
/// &lt;li&gt;`fetching` - assets are being fetched&lt;/li&gt;<br/>
/// &lt;li&gt;`preprocessing` - video assets are being processed for compatibility&lt;/li&gt;<br/>
/// &lt;li&gt;`rendering` - the asset is being rendered&lt;/li&gt;<br/>
/// &lt;li&gt;`generating` - AI/media generation is in progress&lt;/li&gt;<br/>
/// &lt;li&gt;`saving` - the final asset is being saved to storage&lt;/li&gt;<br/>
/// &lt;li&gt;`done` - the asset is ready to be downloaded&lt;/li&gt;<br/>
/// &lt;li&gt;`failed` - there was an error rendering the asset&lt;/li&gt;<br/>
Expand Down Expand Up @@ -143,6 +144,7 @@ public sealed partial class RenderResponseData
/// &lt;li&gt;`fetching` - assets are being fetched&lt;/li&gt;<br/>
/// &lt;li&gt;`preprocessing` - video assets are being processed for compatibility&lt;/li&gt;<br/>
/// &lt;li&gt;`rendering` - the asset is being rendered&lt;/li&gt;<br/>
/// &lt;li&gt;`generating` - AI/media generation is in progress&lt;/li&gt;<br/>
/// &lt;li&gt;`saving` - the final asset is being saved to storage&lt;/li&gt;<br/>
/// &lt;li&gt;`done` - the asset is ready to be downloaded&lt;/li&gt;<br/>
/// &lt;li&gt;`failed` - there was an error rendering the asset&lt;/li&gt;<br/>
Expand Down
7 changes: 7 additions & 0 deletions src/libs/Shotstack/Generated/Shotstack.Models.RenderResponseDataStatus.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ namespace Shotstack
/// &lt;li&gt;`fetching` - assets are being fetched&lt;/li&gt;<br/>
/// &lt;li&gt;`preprocessing` - video assets are being processed for compatibility&lt;/li&gt;<br/>
/// &lt;li&gt;`rendering` - the asset is being rendered&lt;/li&gt;<br/>
/// &lt;li&gt;`generating` - AI/media generation is in progress&lt;/li&gt;<br/>
/// &lt;li&gt;`saving` - the final asset is being saved to storage&lt;/li&gt;<br/>
/// &lt;li&gt;`done` - the asset is ready to be downloaded&lt;/li&gt;<br/>
/// &lt;li&gt;`failed` - there was an error rendering the asset&lt;/li&gt;<br/>
Expand All @@ -32,6 +33,10 @@ public enum RenderResponseDataStatus
/// <summary>
///
/// </summary>
Generating,
/// <summary>
///
/// </summary>
Preprocessing,
/// <summary>
///
Expand Down Expand Up @@ -62,6 +67,7 @@ public static string ToValueString(this RenderResponseDataStatus value)
RenderResponseDataStatus.Done => "done",
RenderResponseDataStatus.Failed => "failed",
RenderResponseDataStatus.Fetching => "fetching",
RenderResponseDataStatus.Generating => "generating",
RenderResponseDataStatus.Preprocessing => "preprocessing",
RenderResponseDataStatus.Queued => "queued",
RenderResponseDataStatus.Rendering => "rendering",
Expand All @@ -79,6 +85,7 @@ public static string ToValueString(this RenderResponseDataStatus value)
"done" => RenderResponseDataStatus.Done,
"failed" => RenderResponseDataStatus.Failed,
"fetching" => RenderResponseDataStatus.Fetching,
"generating" => RenderResponseDataStatus.Generating,
"preprocessing" => RenderResponseDataStatus.Preprocessing,
"queued" => RenderResponseDataStatus.Queued,
"rendering" => RenderResponseDataStatus.Rendering,
Expand Down
6 changes: 4 additions & 2 deletions src/libs/Shotstack/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1894,7 +1894,8 @@
]
},
"CaptionAsset": {
"description": "The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with\nmatching start and end time.\n",
"deprecated": true,
"description": "**Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**\n\nThe CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with\nmatching start and end time.\n",
"type": "object",
"properties": {
"type": {
Expand Down Expand Up @@ -4458,12 +4459,13 @@
"example": "basic"
},
"status": {
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`preprocessing` - video assets are being processed for compatibility</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`preprocessing` - video assets are being processed for compatibility</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`generating` - AI/media generation is in progress</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
"enum": [
"queued",
"fetching",
"preprocessing",
"rendering",
"generating",
"saving",
"done",
"failed"
Expand Down