From a3244cd6e65cad13fbbdf3535708b067b7a79b13 Mon Sep 17 00:00:00 2001 From: HavenDV Date: Tue, 12 Nov 2024 18:14:01 +0400 Subject: [PATCH] fix: Fixed missing xml param doc for required deprecated properties. --- src/libs/AutoSDK/Sources/Sources.Models.cs | 2 +- .../NewtonsoftJson/_#G.Models.Transcript.g.verified.cs | 6 ++++++ .../SystemTextJson/_#G.Models.Transcript.g.verified.cs | 6 ++++++ .../NewtonsoftJson/_#G.Models.Repository.g.verified.cs | 5 +++++ .../SystemTextJson/_#G.Models.Repository.g.verified.cs | 5 +++++ .../_#G.Models.NullableRepository.g.verified.cs | 5 +++++ ...ranchProtectionRequestRequiredStatusChecks.g.verified.cs | 3 +++ .../NewtonsoftJson/_#G.Models.Repository.g.verified.cs | 5 +++++ .../_#G.Models.NullableRepository.g.verified.cs | 5 +++++ ...ranchProtectionRequestRequiredStatusChecks.g.verified.cs | 3 +++ .../SystemTextJson/_#G.Models.Repository.g.verified.cs | 5 +++++ .../NewtonsoftJson/_#G.Models.OpenAIFile.g.verified.cs | 3 +++ .../SystemTextJson/_#G.Models.OpenAIFile.g.verified.cs | 3 +++ .../Twitch/NewtonsoftJson/_#G.Models.Channel.g.verified.cs | 5 +++++ .../Twitch/NewtonsoftJson/_#G.Models.Stream.g.verified.cs | 5 +++++ .../Twitch/SystemTextJson/_#G.Models.Channel.g.verified.cs | 5 +++++ .../Twitch/SystemTextJson/_#G.Models.Stream.g.verified.cs | 5 +++++ 17 files changed, 75 insertions(+), 1 deletion(-) diff --git a/src/libs/AutoSDK/Sources/Sources.Models.cs b/src/libs/AutoSDK/Sources/Sources.Models.cs index 8a14930919..03c05bf208 100644 --- a/src/libs/AutoSDK/Sources/Sources.Models.cs +++ b/src/libs/AutoSDK/Sources/Sources.Models.cs @@ -105,7 +105,7 @@ public sealed partial class {modelData.ClassName} /// /// Initializes a new instance of the class. /// -{modelData.Properties.Where(static x => !x.IsDeprecated).Select(x => $@" +{modelData.Properties.Where(static x => x.IsRequired || !x.IsDeprecated).Select(x => $@" {x.Summary.ToXmlDocumentationForParam(x.ParameterName, level: 8)}").Inject()} {(modelData.Settings.TargetFramework.StartsWith("net8", StringComparison.OrdinalIgnoreCase) ? "[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]" : " ")} public {modelData.ClassName}( diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/NewtonsoftJson/_#G.Models.Transcript.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/NewtonsoftJson/_#G.Models.Transcript.g.verified.cs index da492599b2..5be98e3cc2 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/NewtonsoftJson/_#G.Models.Transcript.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/NewtonsoftJson/_#G.Models.Transcript.g.verified.cs @@ -568,6 +568,12 @@ public sealed partial class Transcript /// /// Error message of why the transcript failed /// + /// + /// The language model that was used for the transcript + /// + /// + /// The acoustic model that was used for the transcript + /// public Transcript( global::System.Guid id, string audioUrl, diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/SystemTextJson/_#G.Models.Transcript.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/SystemTextJson/_#G.Models.Transcript.g.verified.cs index a2dfe92f01..1fad059ad5 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/SystemTextJson/_#G.Models.Transcript.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/SystemTextJson/_#G.Models.Transcript.g.verified.cs @@ -588,6 +588,12 @@ public sealed partial class Transcript /// /// Error message of why the transcript failed /// + /// + /// The language model that was used for the transcript + /// + /// + /// The acoustic model that was used for the transcript + /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public Transcript( global::System.Guid id, diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/NewtonsoftJson/_#G.Models.Repository.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/NewtonsoftJson/_#G.Models.Repository.g.verified.cs index 2201fec5e6..1a34be65c6 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/NewtonsoftJson/_#G.Models.Repository.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/NewtonsoftJson/_#G.Models.Repository.g.verified.cs @@ -911,6 +911,11 @@ public sealed partial class Repository /// Example: true /// /// + /// + /// Whether downloads are enabled.
+ /// Default Value: true
+ /// Example: true + /// /// /// Whether discussions are enabled.
/// Default Value: false
diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/SystemTextJson/_#G.Models.Repository.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/SystemTextJson/_#G.Models.Repository.g.verified.cs index b349ded60b..2d1ded2966 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/SystemTextJson/_#G.Models.Repository.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/SystemTextJson/_#G.Models.Repository.g.verified.cs @@ -988,6 +988,11 @@ public sealed partial class Repository /// Example: true /// /// + /// + /// Whether downloads are enabled.
+ /// Default Value: true
+ /// Example: true + /// /// /// Whether discussions are enabled.
/// Default Value: false
diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.NullableRepository.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.NullableRepository.g.verified.cs index 0e04d546d5..ec92e8791f 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.NullableRepository.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.NullableRepository.g.verified.cs @@ -911,6 +911,11 @@ public sealed partial class NullableRepository /// Example: true /// /// + /// + /// Whether downloads are enabled.
+ /// Default Value: true
+ /// Example: true + /// /// /// Whether discussions are enabled.
/// Default Value: false
diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs index bfd828807f..c8ce5e6f92 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs @@ -39,6 +39,9 @@ public sealed partial class ReposUpdateBranchProtectionRequestRequiredStatusChec /// /// Require branches to be up to date before merging. /// + /// + /// **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + /// /// /// The list of status checks to require in order to merge into this branch. /// diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.Repository.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.Repository.g.verified.cs index 2201fec5e6..1a34be65c6 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.Repository.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.Repository.g.verified.cs @@ -911,6 +911,11 @@ public sealed partial class Repository /// Example: true /// /// + /// + /// Whether downloads are enabled.
+ /// Default Value: true
+ /// Example: true + /// /// /// Whether discussions are enabled.
/// Default Value: false
diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.NullableRepository.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.NullableRepository.g.verified.cs index f7c4ca1486..d1306e1978 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.NullableRepository.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.NullableRepository.g.verified.cs @@ -988,6 +988,11 @@ public sealed partial class NullableRepository /// Example: true /// /// + /// + /// Whether downloads are enabled.
+ /// Default Value: true
+ /// Example: true + /// /// /// Whether discussions are enabled.
/// Default Value: false
diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs index 01501560f4..dac8a740ba 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs @@ -41,6 +41,9 @@ public sealed partial class ReposUpdateBranchProtectionRequestRequiredStatusChec /// /// Require branches to be up to date before merging. /// + /// + /// **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + /// /// /// The list of status checks to require in order to merge into this branch. /// diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.Repository.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.Repository.g.verified.cs index b349ded60b..2d1ded2966 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.Repository.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.Repository.g.verified.cs @@ -988,6 +988,11 @@ public sealed partial class Repository /// Example: true /// /// + /// + /// Whether downloads are enabled.
+ /// Default Value: true
+ /// Example: true + /// /// /// Whether discussions are enabled.
/// Default Value: false
diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/OpenAi/NewtonsoftJson/_#G.Models.OpenAIFile.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/OpenAi/NewtonsoftJson/_#G.Models.OpenAIFile.g.verified.cs index 5914f97bcf..087bf025f4 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/OpenAi/NewtonsoftJson/_#G.Models.OpenAIFile.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/OpenAi/NewtonsoftJson/_#G.Models.OpenAIFile.g.verified.cs @@ -85,6 +85,9 @@ public sealed partial class OpenAIFile /// /// The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`. /// + /// + /// Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`. + /// public OpenAIFile( string id, int bytes, diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/OpenAi/SystemTextJson/_#G.Models.OpenAIFile.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/OpenAi/SystemTextJson/_#G.Models.OpenAIFile.g.verified.cs index 146a897716..7964e93ea2 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/OpenAi/SystemTextJson/_#G.Models.OpenAIFile.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/OpenAi/SystemTextJson/_#G.Models.OpenAIFile.g.verified.cs @@ -95,6 +95,9 @@ public sealed partial class OpenAIFile /// /// The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`. /// + /// + /// Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`. + /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public OpenAIFile( string id, diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/NewtonsoftJson/_#G.Models.Channel.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/NewtonsoftJson/_#G.Models.Channel.g.verified.cs index 1382cb9704..5a974b61b2 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/NewtonsoftJson/_#G.Models.Channel.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/NewtonsoftJson/_#G.Models.Channel.g.verified.cs @@ -113,6 +113,11 @@ public sealed partial class Channel /// /// A Boolean value that determines whether the broadcaster is streaming live. Is **true** if the broadcaster is streaming live; otherwise, **false**. /// + /// + /// **IMPORTANT** As of February 28, 2023, this field is deprecated and returns only an empty array. If you use this field, please update your code to use the `tags` field.
+ ///
+ /// The list of tags that apply to the stream. The list contains IDs only when the channel is steaming live. For a list of possible tags, see [List of All Tags](https://www.twitch.tv/directory/all/tags). The list doesn’t include Category Tags. + /// /// /// The tags applied to the channel. /// diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/NewtonsoftJson/_#G.Models.Stream.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/NewtonsoftJson/_#G.Models.Stream.g.verified.cs index 2bfa5e9c35..42e6ddd88d 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/NewtonsoftJson/_#G.Models.Stream.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/NewtonsoftJson/_#G.Models.Stream.g.verified.cs @@ -154,6 +154,11 @@ public sealed partial class Stream /// /// A URL to an image of a frame from the last 5 minutes of the stream. Replace the width and height placeholders in the URL (`{width}x{height}`) with the size of the image you want, in pixels. /// + /// + /// **IMPORTANT** As of February 28, 2023, this field is deprecated and returns only an empty array. If you use this field, please update your code to use the `tags` field.
+ ///
+ /// The list of tags that apply to the stream. The list contains IDs only when the channel is steaming live. For a list of possible tags, see [List of All Tags](https://www.twitch.tv/directory/all/tags). The list doesn’t include Category Tags. + /// /// /// The tags applied to the stream. /// diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/SystemTextJson/_#G.Models.Channel.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/SystemTextJson/_#G.Models.Channel.g.verified.cs index 21f59d76a3..fa263f4fcc 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/SystemTextJson/_#G.Models.Channel.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/SystemTextJson/_#G.Models.Channel.g.verified.cs @@ -125,6 +125,11 @@ public sealed partial class Channel /// /// A Boolean value that determines whether the broadcaster is streaming live. Is **true** if the broadcaster is streaming live; otherwise, **false**. /// + /// + /// **IMPORTANT** As of February 28, 2023, this field is deprecated and returns only an empty array. If you use this field, please update your code to use the `tags` field.
+ ///
+ /// The list of tags that apply to the stream. The list contains IDs only when the channel is steaming live. For a list of possible tags, see [List of All Tags](https://www.twitch.tv/directory/all/tags). The list doesn’t include Category Tags. + /// /// /// The tags applied to the channel. /// diff --git a/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/SystemTextJson/_#G.Models.Stream.g.verified.cs b/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/SystemTextJson/_#G.Models.Stream.g.verified.cs index 4193431733..053d2522e3 100644 --- a/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/SystemTextJson/_#G.Models.Stream.g.verified.cs +++ b/src/tests/AutoSDK.SnapshotTests/Snapshots/Twitch/SystemTextJson/_#G.Models.Stream.g.verified.cs @@ -169,6 +169,11 @@ public sealed partial class Stream /// /// A URL to an image of a frame from the last 5 minutes of the stream. Replace the width and height placeholders in the URL (`{width}x{height}`) with the size of the image you want, in pixels. /// + /// + /// **IMPORTANT** As of February 28, 2023, this field is deprecated and returns only an empty array. If you use this field, please update your code to use the `tags` field.
+ ///
+ /// The list of tags that apply to the stream. The list contains IDs only when the channel is steaming live. For a list of possible tags, see [List of All Tags](https://www.twitch.tv/directory/all/tags). The list doesn’t include Category Tags. + /// /// /// The tags applied to the stream. ///