Skip to content

feat: Updated OpenAPI spec #53

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 11, 2026
Merged

feat: Updated OpenAPI spec #53

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
6 changes: 4 additions & 2 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 @@ -101,6 +101,8 @@ public bool TryPickImage(
: throw new global::System.InvalidOperationException($"Expected union variant 'Image' but the value was {ToString()}.");

/// <summary>
/// **Notice: The TextAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.** This type<br/>
/// continues to function; no behaviour change for existing integrations.<br/>
/// The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom<br/>
/// [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
/// </summary>
Expand Down Expand Up @@ -342,7 +344,7 @@ public bool TryPickRichCaption(
: throw new global::System.InvalidOperationException($"Expected union variant 'RichCaption' but the value was {ToString()}.");

/// <summary>
/// **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**<br/>
/// **Notice: The HtmlAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**<br/>
/// The HtmlAsset clip type lets you create text based layout and formatting using<br/>
/// HTML and CSS. You can also set the height and width of a bounding box for the HTML<br/>
/// content to sit within. Text and elements will wrap within the bounding box.
Expand Down Expand Up @@ -419,7 +421,7 @@ public bool TryPickHtml5(
: throw new global::System.InvalidOperationException($"Expected union variant 'Html5' but the value was {ToString()}.");

/// <summary>
/// **Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**<br/>
/// **Notice: The TitleAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**<br/>
/// The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
/// </summary>
#if NET6_0_OR_GREATER
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Shotstack/Generated/Shotstack.Models.HtmlAsset.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Shotstack
{
/// <summary>
/// **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**<br/>
/// **Notice: The HtmlAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**<br/>
/// The HtmlAsset clip type lets you create text based layout and formatting using<br/>
/// HTML and CSS. You can also set the height and width of a bounding box for the HTML<br/>
/// content to sit within. Text and elements will wrap within the bounding box.
Expand Down
5 changes: 5 additions & 0 deletions src/libs/Shotstack/Generated/Shotstack.Models.Soundtrack.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
namespace Shotstack
{
/// <summary>
/// **Notice: The Soundtrack is deprecated, use an [AudioAsset](#tocs_audioasset) clip on its own track instead.** This type continues to function; no behaviour change for existing integrations.<br/>
/// A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
/// </summary>
[global::System.Obsolete("This model marked as deprecated.")]
public sealed partial class Soundtrack
{
/// <summary>
Expand All @@ -15,6 +17,7 @@ public sealed partial class Soundtrack
/// <example>https://s3-ap-northeast-1.amazonaws.com/my-bucket/music.mp3</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>
Expand All @@ -26,12 +29,14 @@ public sealed partial class Soundtrack
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("effect")]
[global::System.Text.Json.Serialization.JsonConverter(typeof(global::Shotstack.JsonConverters.SoundtrackEffectJsonConverter))]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.SoundtrackEffect? Effect { get; set; }

/// <summary>
/// Set the volume for the soundtrack between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("volume")]
[global::System.Obsolete("This property marked as deprecated.")]
public double? Volume { get; set; }

/// <summary>
Expand Down
25 changes: 13 additions & 12 deletions src/libs/Shotstack/Generated/Shotstack.Models.TextAsset.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@
namespace Shotstack
{
/// <summary>
/// **Notice: The TextAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.** This type<br/>
/// continues to function; no behaviour change for existing integrations.<br/>
/// The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom<br/>
/// [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
/// </summary>
[global::System.Obsolete("This model marked as deprecated.")]
public sealed partial class TextAsset
{
/// <summary>
Expand All @@ -16,6 +19,7 @@ public sealed partial class TextAsset
/// <default>global::Shotstack.TextAssetType.Text</default>
[global::System.Text.Json.Serialization.JsonPropertyName("type")]
[global::System.Text.Json.Serialization.JsonConverter(typeof(global::Shotstack.JsonConverters.TextAssetTypeJsonConverter))]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.TextAssetType Type { get; set; } = global::Shotstack.TextAssetType.Text;

/// <summary>
Expand All @@ -25,6 +29,7 @@ public sealed partial class TextAsset
/// <example>Hello World</example>
[global::System.Text.Json.Serialization.JsonPropertyName("text")]
[global::System.Text.Json.Serialization.JsonRequired]
[global::System.Obsolete("This property marked as deprecated.")]
public required string Text { get; set; }

/// <summary>
Expand All @@ -33,6 +38,7 @@ public sealed partial class TextAsset
/// </summary>
/// <example>400</example>
[global::System.Text.Json.Serialization.JsonPropertyName("width")]
[global::System.Obsolete("This property marked as deprecated.")]
public int? Width { get; set; }

/// <summary>
Expand All @@ -41,36 +47,42 @@ public sealed partial class TextAsset
/// </summary>
/// <example>200</example>
[global::System.Text.Json.Serialization.JsonPropertyName("height")]
[global::System.Obsolete("This property marked as deprecated.")]
public int? Height { get; set; }

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

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

/// <summary>
/// Horizontal and vertical alignment properties for text.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("alignment")]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.TextAlignment? Alignment { get; set; }

/// <summary>
/// Text stroke (outline) properties.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("stroke")]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.TextStroke? Stroke { get; set; }

/// <summary>
/// Animation properties for text entrance effects.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("animation")]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.TextAnimation? Animation { get; set; }

/// <summary>
Expand All @@ -79,6 +91,7 @@ public sealed partial class TextAsset
/// </summary>
/// <example>...</example>
[global::System.Text.Json.Serialization.JsonPropertyName("ellipsis")]
[global::System.Obsolete("This property marked as deprecated.")]
public string? Ellipsis { get; set; }

/// <summary>
Expand Down Expand Up @@ -159,17 +172,5 @@ public TextAsset()
{
}

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

}
}
9 changes: 4 additions & 5 deletions src/libs/Shotstack/Generated/Shotstack.Models.Timeline.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

#pragma warning disable CS0618 // Type or member is obsolete

#nullable enable

namespace Shotstack
Expand All @@ -9,9 +11,11 @@ namespace Shotstack
public sealed partial class Timeline
{
/// <summary>
/// **Notice: The Soundtrack is deprecated, use an [AudioAsset](#tocs_audioasset) clip on its own track instead.** This type continues to function; no behaviour change for existing integrations.<br/>
/// A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("soundtrack")]
[global::System.Obsolete("This property marked as deprecated.")]
public global::Shotstack.Soundtrack? Soundtrack { get; set; }

/// <summary>
Expand Down Expand Up @@ -51,9 +55,6 @@ public sealed partial class Timeline
/// <param name="tracks">
/// A timeline consists of an array of tracks, each track containing clips. Tracks are layered on top of each other in the same order they are added to the array with the top most track layered over the top of those below it. Ensure that a track containing titles is the top most track so that it is displayed above videos and images.
/// </param>
/// <param name="soundtrack">
/// A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
/// </param>
/// <param name="background">
/// A hexadecimal value for the timeline background colour. Defaults to #000000 (black).
/// </param>
Expand All @@ -68,12 +69,10 @@ public sealed partial class Timeline
#endif
public Timeline(
global::System.Collections.Generic.IList<global::Shotstack.Track> tracks,
global::Shotstack.Soundtrack? soundtrack,
string? background,
global::System.Collections.Generic.IList<global::Shotstack.Font>? fonts,
bool? cache)
{
this.Soundtrack = soundtrack;
this.Background = background;
this.Fonts = fonts;
this.Tracks = tracks ?? throw new global::System.ArgumentNullException(nameof(tracks));
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Shotstack/Generated/Shotstack.Models.TitleAsset.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Shotstack
{
/// <summary>
/// **Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**<br/>
/// **Notice: The TitleAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**<br/>
/// The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
/// </summary>
[global::System.Obsolete("This model marked as deprecated.")]
Expand Down
13 changes: 8 additions & 5 deletions src/libs/Shotstack/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,7 +791,8 @@
"description": "A timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout. A timeline consists of layers called tracks. Tracks are composed of titles, images, audio, html or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time.",
"properties": {
"soundtrack": {
"description": "A music or audio soundtrack file in mp3 format.",
"deprecated": true,
"description": "A music or audio soundtrack file in mp3 format. Deprecated - use an [AudioAsset](#tocs_audioasset) clip on its own track instead.",
"$ref": "#/components/schemas/Soundtrack"
},
"background": {
Expand Down Expand Up @@ -825,7 +826,8 @@
"type": "object"
},
"Soundtrack": {
"description": "A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.",
"deprecated": true,
"description": "**Notice: The Soundtrack is deprecated, use an [AudioAsset](#tocs_audioasset) clip on its own track instead.** This type continues to function; no behaviour change for existing integrations.\nA music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.",
"properties": {
"src": {
"description": "The URL of the mp3 audio file. The URL must be publicly accessible or include credentials.",
Expand Down Expand Up @@ -1360,7 +1362,8 @@
]
},
"TextAsset": {
"description": "The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom\n[Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.\n",
"deprecated": true,
"description": "**Notice: The TextAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.** This type\ncontinues to function; no behaviour change for existing integrations.\n\nThe TextAsset is used to add text and titles to a video. The text can be styled with built in and custom\n[Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.\n",
"type": "object",
"properties": {
"type": {
Expand Down Expand Up @@ -2199,7 +2202,7 @@
},
"HtmlAsset": {
"deprecated": true,
"description": "**Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**\n\nThe HtmlAsset clip type lets you create text based layout and formatting using\nHTML and CSS. You can also set the height and width of a bounding box for the HTML\ncontent to sit within. Text and elements will wrap within the bounding box.\n",
"description": "**Notice: The HtmlAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**\n\nThe HtmlAsset clip type lets you create text based layout and formatting using\nHTML and CSS. You can also set the height and width of a bounding box for the HTML\ncontent to sit within. Text and elements will wrap within the bounding box.\n",
"type": "object",
"properties": {
"type": {
Expand Down Expand Up @@ -2295,7 +2298,7 @@
},
"TitleAsset": {
"deprecated": true,
"description": "**Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**\n\nThe TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.\n",
"description": "**Notice: The TitleAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**\n\nThe TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.\n",
"type": "object",
"properties": {
"type": {
Expand Down