Code Analysis - CA2227

Collection properties should be read only
https://docs.microsoft.com/en-gb/visualstudio/code-quality/ca2227

Suppress FxCopAnalyzers warning CA2227 as System.Text.Json.JsonSerializer.Deserialize in .NET Core 3.1 cannot deserialise to read-only properties.

There are two related issues that will allow System.Text.Json.JsonSerializer.Deserialize to deserialise to read-only properties in .NET Core 5.0:
1) Pull Request that includes support for non-public accessors: dotnet/runtime#34675
2) Issue regarding, among other things, adding to collections during deserialisation if the collection property has no setter: dotnet/runtime#30258

Author: watfordjc

OBSWebSocketLibrary/Models/Events/SceneItems.cs

@@ -10,7 +10,9 @@ public class SourceOrderChanged : EventBase
         [JsonPropertyName("scene-name")]
         public string SceneName { get; set; }
         [JsonPropertyName("scene-items")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.ObsEventSceneItem> SceneItems { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class SceneItemAdded : EventBase

OBSWebSocketLibrary/Models/Events/Scenes.cs

@@ -10,7 +10,9 @@ public class SwitchScenes : EventBase
         [JsonPropertyName("scene-name")]
         public string SceneName { get; set; }
         [JsonPropertyName("sources")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.SceneItem> Sources { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class ScenesChanged : EventBase

OBSWebSocketLibrary/Models/Events/Sources.cs

@@ -58,7 +58,9 @@ public class SourceAudioMixersChanged : EventBase
         [JsonPropertyName("sourceName")]
         public string SourceName { get; set; }
         [JsonPropertyName("mixers")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.ObsMixer> Mixers { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
         [JsonPropertyName("hexMixersValue")]
         public string HexMixersValue { get; set; }
     }
@@ -110,6 +112,8 @@ public class SourceFiltersReordered : EventBase
         [JsonPropertyName("sourceName")]
         public string SourceName { get; set; }
         [JsonPropertyName("filters")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.ObsFilter> Filters { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 }

OBSWebSocketLibrary/Models/Events/StudioMode.cs

@@ -10,7 +10,9 @@ public class PreviewSceneChanged : EventBase
         [JsonPropertyName("scene-name")]
         public string SceneName { get; set; }
         [JsonPropertyName("GetCurrentScene")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.SceneItem> GetCurrentScene { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class StudioModeSwitched : EventBase

OBSWebSocketLibrary/Models/RequestReplies/Outputs.cs

@@ -8,7 +8,9 @@ namespace OBSWebSocketLibrary.Models.RequestReplies
     public class ListOutputs : RequestReplyBase
     {
         [JsonPropertyName("outputs")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.Output> Outputs { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class GetOutputInfo : RequestReplyBase

OBSWebSocketLibrary/Models/RequestReplies/Profiles.cs

@@ -19,6 +19,8 @@ public class GetCurrentProfile : RequestReplyBase
     public class ListProfiles : RequestReplyBase
     {
         [JsonPropertyName("profiles")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<OBSWebSocketLibrary.Models.TypeDefs.ObsProfile> Profiles { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 }

OBSWebSocketLibrary/Models/RequestReplies/SceneCollections.cs

@@ -18,6 +18,8 @@ public class GetCurrentSceneCollection : RequestReplyBase
     public class ListSceneCollections : RequestReplyBase
     {
         [JsonPropertyName("scene-collections")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<string> SceneCollections { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 }

OBSWebSocketLibrary/Models/RequestReplies/SceneItems.cs

@@ -40,7 +40,9 @@ public class GetSceneItemProperties : RequestReplyBase
         [JsonPropertyName("parentGroupName")]
         public string ParentGroupName { get; set; }
         [JsonPropertyName("groupChildren")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.SceneItemTransform> GroupChildren { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class SetSceneItemProperties : RequestReplyBase

OBSWebSocketLibrary/Models/RequestReplies/Scenes.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Runtime.Serialization;
 using System.Text;
 using System.Text.Json.Serialization;
 
@@ -14,15 +15,19 @@ public class GetCurrentScene : RequestReplyBase
         [JsonPropertyName("name")]
         public string Name { get; set; }
         [JsonPropertyName("sources")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.SceneItem> Sources { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class GetSceneList : RequestReplyBase
     {
         [JsonPropertyName("current-scene")]
         public string CurrentScene { get; set; }
         [JsonPropertyName("scenes")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.Scene> Scenes { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class ReorderSceneItems : RequestReplyBase

OBSWebSocketLibrary/Models/RequestReplies/Sources.cs

@@ -9,13 +9,17 @@ namespace OBSWebSocketLibrary.Models.RequestReplies
     public class GetSourcesList : RequestReplyBase
     {
         [JsonPropertyName("sources")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.ObsReplySource> Sources { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class GetSourceTypesList : RequestReplyBase
     {
         [JsonPropertyName("types")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.ObsReplyType> Types { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class GetVolume : RequestReplyBase
@@ -217,7 +221,9 @@ public class GetSpecialSources : RequestReplyBase
     public class GetSourceFilters : RequestReplyBase
     {
         [JsonPropertyName("filters")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.ObsReplyFilter> Filters { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class GetSourceFilterInfo : RequestReplyBase

OBSWebSocketLibrary/Models/RequestReplies/StudioMode.cs

@@ -14,7 +14,9 @@ public class GetPreviewScene : RequestReplyBase
         [JsonPropertyName("name")]
         public string Name { get; set; }
         [JsonPropertyName("sources")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.SceneItem> Sources { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class SetPreviewScene : RequestReplyBase

OBSWebSocketLibrary/Models/RequestReplies/Transitions.cs

@@ -10,7 +10,9 @@ public class GetTransitionList : RequestReplyBase
         [JsonPropertyName("current-transition")]
         public string CurrentTransition { get; set; }
         [JsonPropertyName("transitions")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.ObsTransitionName> Transitions { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class GetCurrentTransition : RequestReplyBase

OBSWebSocketLibrary/Models/Requests/Scenes.cs

@@ -25,7 +25,9 @@ public class ReorderSceneItems : RequestBase
         [JsonPropertyName("scene")]
         public string Scene { get; set; }
         [JsonPropertyName("items")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<TypeDefs.ItemObject> Items { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class SetSceneTransitionOverride : RequestBase

OBSWebSocketLibrary/Models/TypeDefs/Scene.cs

@@ -11,6 +11,8 @@ public class Scene
         [JsonPropertyName("name")]
         public string Name { get; set; }
         [JsonPropertyName("sources")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public ObservableCollection<SceneItem> Sources { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 }

OBSWebSocketLibrary/Models/TypeDefs/SceneItem.cs

@@ -87,7 +87,9 @@ public double Volume
         [JsonPropertyName("parentGroupName")]
         public string ParentGroupName { get; set; }
         [JsonPropertyName("groupChildren")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public ObservableCollection<SceneItem> GroupChildren { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
         [JsonIgnore]
         public SourceTypes.BaseType Source
         {

OBSWebSocketLibrary/Models/TypeDefs/SceneItemTransform.cs

@@ -32,7 +32,9 @@ public class SceneItemTransform
         [JsonPropertyName("parentGroupName")]
         public string ParentGroupName { get; set; }
         [JsonPropertyName("groupChildren")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<SceneItemTransform> GroupChildren { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
 
         public static implicit operator SceneItemTransform(RequestReplies.GetSceneItemProperties v)
         {

OBSWebSocketLibrary/Models/TypeDefs/SourceTypes/BaseType.cs

@@ -78,7 +78,9 @@ public string MonitorType
             }
         }
         [JsonIgnore]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<ObsMixer> Mixers
+#pragma warning restore CA2227 // Collection properties should be read only
         {
             get { return mixers; }
             set
@@ -98,7 +100,9 @@ public string HexMixersValue
             }
         }
         [JsonIgnore]
+#pragma warning disable CA2227 // Collection properties should be read only
         public ObservableCollection<FilterTypes.BaseFilter> Filters { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
 
         [JsonIgnore]
         public TypeDefs.ObsReplyType Type { get; set; }

OBSWebSocketLibrary/Models/TypeDefs/SourceTypes/Composite.cs

@@ -13,7 +13,9 @@ public class Scene : BaseType
         [JsonPropertyName("id_counter")]
         public int IdCounter { get; set; }
         [JsonPropertyName("items")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<ObsSceneItem> Items { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 
     public class Group : BaseType
@@ -27,6 +29,8 @@ public class Group : BaseType
         [JsonPropertyName("id_counter")]
         public int IdCounter { get; set; }
         [JsonPropertyName("items")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<ObsSceneItem> Items { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
     }
 }

OBSWebSocketLibrary/Models/TypeDefs/SourceTypes/DependencyProperties.cs

@@ -89,7 +89,9 @@ public bool HasVideoInterface
             get { return !String.IsNullOrEmpty(VideoDeviceId); }
         }
 
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<string> FilePaths
+#pragma warning restore CA2227 // Collection properties should be read only
         {
             get { return filePaths; }
             set
@@ -103,7 +105,9 @@ public bool HasFiles
             get { return FilePaths != null && FilePaths.Count != 0; }
         }
 
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<string> Uris
+#pragma warning restore CA2227 // Collection properties should be read only
         {
             get { return uris; }
             set

OBSWebSocketLibrary/Models/TypeDefs/SourceTypes/Video.cs

@@ -30,7 +30,9 @@ public class ColorSourceV2 : BaseType
     public class Slideshow : BaseType
     {
         [JsonPropertyName("files")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<ObsFile> Files { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
         [JsonPropertyName("playback_behavior")]
         public string PlaybackBehavior { get; set; }
         [JsonPropertyName("slide_time")]
@@ -172,7 +174,9 @@ public class VlcSource : BaseType
         [JsonPropertyName("playback_behavior")]
         public string PlaybackBehavior { get; set; }
         [JsonPropertyName("playlist")]
+#pragma warning disable CA2227 // Collection properties should be read only
         public IList<VlcPlaylistItem> Playlist { get; set; }
+#pragma warning restore CA2227 // Collection properties should be read only
         [JsonPropertyName("shuffle")]
         public bool Shuffle { get; set; }
         [JsonPropertyName("subtitle")]