Rename Format enum to SerializationFormat

coderpatros · coderpatros · commit 6cac276a1137 · 2022-01-05T22:15:40.000+10:00
Signed-off-by: Patrick Dwyer &lt;patrick.dwyer@owasp.org&gt;
diff --git a/docfx-serve.sh b/docfx-serve.sh
@@ -1,2 +1,4 @@
 #!/usr/bin/env bash
-docfx/docfx.exe docs/docfx.json --serve
+#docfx/docfx.exe docs/docfx.json --serve
+cd docs/_site
+python3 -m http.server 8000
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -1 +1 @@
-# CycloneDX.Core and CycloneDX.Utils libraries API documentation
+# CycloneDX .NET libraries API documentation
diff --git a/src/CycloneDX.Core/MediaTypes.cs b/src/CycloneDX.Core/MediaTypes.cs
@@ -49,7 +49,7 @@ public static class MediaTypes
         /// </summary>
         /// <param name="format">The CycloneDX format. i.e. <c>Format.Xml</c></param>
         /// <param name="specificationVersion">The CycloneDX specification version. i.e. <c>SpecificationVersion.v1_3</c></param>
-        public static string GetMediaType(Format format, SpecificationVersion specificationVersion)
+        public static string GetMediaType(SerializationFormat format, SpecificationVersion specificationVersion)
         {
             var mediaType = GetMediaType(format);
 
@@ -60,31 +60,31 @@ public static string GetMediaType(Format format, SpecificationVersion specificat
             }
             else if (specificationVersion == SpecificationVersion.v1_2)
             {
-                if (format == Format.Protobuf)
+                if (format == SerializationFormat.Protobuf)
                 {
                     throw new UnsupportedFormatSpecificationVersionException("Protocol Buffers format is only supported from v1.3.");
                 }
                 version = "1.2";
             }
             else if (specificationVersion == SpecificationVersion.v1_1)
             {
-                if (format == Format.Json)
+                if (format == SerializationFormat.Json)
                 {
                     throw new UnsupportedFormatSpecificationVersionException("JSON format is only supported from v1.2.");
                 }
-                if (format == Format.Protobuf)
+                if (format == SerializationFormat.Protobuf)
                 {
                     throw new UnsupportedFormatSpecificationVersionException("Protocol Buffers format is only supported from v1.3.");
                 }
                 version = "1.1";
             }
             else if (specificationVersion == SpecificationVersion.v1_0)
             {
-                if (format == Format.Json)
+                if (format == SerializationFormat.Json)
                 {
                     throw new UnsupportedFormatSpecificationVersionException("JSON format is only supported from v1.2.");
                 }
-                if (format == Format.Protobuf)
+                if (format == SerializationFormat.Protobuf)
                 {
                     throw new UnsupportedFormatSpecificationVersionException("Protocol Buffers format is only supported from v1.3.");
                 }
@@ -98,14 +98,14 @@ public static string GetMediaType(Format format, SpecificationVersion specificat
         /// Utility method to return the CycloneDX media type for a supported <c>Format</c>.
         /// </summary>
         /// <param name="format">The CycloneDX format. i.e. <c>Format.Xml</c></param>
-        public static string GetMediaType(Format format)
+        public static string GetMediaType(SerializationFormat format)
         {
             var mediaType = Xml;
-            if (format == Format.Json)
+            if (format == SerializationFormat.Json)
             {
                 mediaType = Json;
             }
-            else if (format == Format.Protobuf)
+            else if (format == SerializationFormat.Protobuf)
             {
                 mediaType = Protobuf;
             }
diff --git a/src/CycloneDX.Core/SerializationFormat.cs b/src/CycloneDX.Core/SerializationFormat.cs
@@ -22,7 +22,7 @@ namespace CycloneDX
     /// <summary>
     /// Enum of all supported CycloneDX serialization formats.
     /// </summary>
-    public enum Format
+    public enum SerializationFormat
     {
         Xml,
         Json,
diff --git a/tests/CycloneDX.Core.Tests/MediaTypeTests.cs b/tests/CycloneDX.Core.Tests/MediaTypeTests.cs
@@ -23,26 +23,26 @@ namespace CycloneDX.Core.Tests
     public class MediaTypeTests
     {
         [Theory]
-        [InlineData(Format.Xml, SpecificationVersion.v1_4, "application/vnd.cyclonedx+xml; version=1.4")]
-        [InlineData(Format.Xml, SpecificationVersion.v1_3, "application/vnd.cyclonedx+xml; version=1.3")]
-        [InlineData(Format.Xml, SpecificationVersion.v1_2, "application/vnd.cyclonedx+xml; version=1.2")]
-        [InlineData(Format.Xml, SpecificationVersion.v1_1, "application/vnd.cyclonedx+xml; version=1.1")]
-        [InlineData(Format.Xml, SpecificationVersion.v1_0, "application/vnd.cyclonedx+xml; version=1.0")]
-        [InlineData(Format.Json, SpecificationVersion.v1_4, "application/vnd.cyclonedx+json; version=1.4")]
-        [InlineData(Format.Json, SpecificationVersion.v1_3, "application/vnd.cyclonedx+json; version=1.3")]
-        [InlineData(Format.Json, SpecificationVersion.v1_2, "application/vnd.cyclonedx+json; version=1.2")]
-        [InlineData(Format.Protobuf, SpecificationVersion.v1_4, "application/x.vnd.cyclonedx+protobuf; version=1.4")]
-        [InlineData(Format.Protobuf, SpecificationVersion.v1_3, "application/x.vnd.cyclonedx+protobuf; version=1.3")]
-        public void MediaTypeAndVersionIsCorrect(Format format, SpecificationVersion schemaVersion, string expected)
+        [InlineData(SerializationFormat.Xml, SpecificationVersion.v1_4, "application/vnd.cyclonedx+xml; version=1.4")]
+        [InlineData(SerializationFormat.Xml, SpecificationVersion.v1_3, "application/vnd.cyclonedx+xml; version=1.3")]
+        [InlineData(SerializationFormat.Xml, SpecificationVersion.v1_2, "application/vnd.cyclonedx+xml; version=1.2")]
+        [InlineData(SerializationFormat.Xml, SpecificationVersion.v1_1, "application/vnd.cyclonedx+xml; version=1.1")]
+        [InlineData(SerializationFormat.Xml, SpecificationVersion.v1_0, "application/vnd.cyclonedx+xml; version=1.0")]
+        [InlineData(SerializationFormat.Json, SpecificationVersion.v1_4, "application/vnd.cyclonedx+json; version=1.4")]
+        [InlineData(SerializationFormat.Json, SpecificationVersion.v1_3, "application/vnd.cyclonedx+json; version=1.3")]
+        [InlineData(SerializationFormat.Json, SpecificationVersion.v1_2, "application/vnd.cyclonedx+json; version=1.2")]
+        [InlineData(SerializationFormat.Protobuf, SpecificationVersion.v1_4, "application/x.vnd.cyclonedx+protobuf; version=1.4")]
+        [InlineData(SerializationFormat.Protobuf, SpecificationVersion.v1_3, "application/x.vnd.cyclonedx+protobuf; version=1.3")]
+        public void MediaTypeAndVersionIsCorrect(SerializationFormat format, SpecificationVersion schemaVersion, string expected)
         {
             Assert.Equal(expected, MediaTypes.GetMediaType(format, schemaVersion));
         }
 
         [Theory]
-        [InlineData(Format.Xml, "application/vnd.cyclonedx+xml")]
-        [InlineData(Format.Json, "application/vnd.cyclonedx+json")]
-        [InlineData(Format.Protobuf, "application/x.vnd.cyclonedx+protobuf")]
-        public void MediaTypeIsCorrect(Format format, string expected)
+        [InlineData(SerializationFormat.Xml, "application/vnd.cyclonedx+xml")]
+        [InlineData(SerializationFormat.Json, "application/vnd.cyclonedx+json")]
+        [InlineData(SerializationFormat.Protobuf, "application/x.vnd.cyclonedx+protobuf")]
+        public void MediaTypeIsCorrect(SerializationFormat format, string expected)
         {
             Assert.Equal(expected, MediaTypes.GetMediaType(format));
         }
diff --git a/tests/CycloneDX.Core.Tests/Xml/v1.3/__snapshots__/SerializationTests.XmlRoundTripTest_valid-evidence-1.3.xml.snap b/tests/CycloneDX.Core.Tests/Xml/v1.3/__snapshots__/SerializationTests.XmlRoundTripTest_valid-evidence-1.3.xml.snap

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-# CycloneDX.Core and CycloneDX.Utils libraries API documentation`
	`1`	`+# CycloneDX .NET libraries API documentation`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public static class MediaTypes`
`49`	`49`	`/// </summary>`
`50`	`50`	`/// <param name="format">The CycloneDX format. i.e. <c>Format.Xml</c></param>`
`51`	`51`	`/// <param name="specificationVersion">The CycloneDX specification version. i.e. <c>SpecificationVersion.v1_3</c></param>`
`52`		`- public static string GetMediaType(Format format, SpecificationVersion specificationVersion)`
	`52`	`+ public static string GetMediaType(SerializationFormat format, SpecificationVersion specificationVersion)`
`53`	`53`	`{`
`54`	`54`	`var mediaType = GetMediaType(format);`
`55`	`55`
`@@ -60,31 +60,31 @@ public static string GetMediaType(Format format, SpecificationVersion specificat`
`60`	`60`	`}`
`61`	`61`	`else if (specificationVersion == SpecificationVersion.v1_2)`
`62`	`62`	`{`
`63`		`- if (format == Format.Protobuf)`
	`63`	`+ if (format == SerializationFormat.Protobuf)`
`64`	`64`	`{`
`65`	`65`	`throw new UnsupportedFormatSpecificationVersionException("Protocol Buffers format is only supported from v1.3.");`
`66`	`66`	`}`
`67`	`67`	`version = "1.2";`
`68`	`68`	`}`
`69`	`69`	`else if (specificationVersion == SpecificationVersion.v1_1)`
`70`	`70`	`{`
`71`		`- if (format == Format.Json)`
	`71`	`+ if (format == SerializationFormat.Json)`
`72`	`72`	`{`
`73`	`73`	`throw new UnsupportedFormatSpecificationVersionException("JSON format is only supported from v1.2.");`
`74`	`74`	`}`
`75`		`- if (format == Format.Protobuf)`
	`75`	`+ if (format == SerializationFormat.Protobuf)`
`76`	`76`	`{`
`77`	`77`	`throw new UnsupportedFormatSpecificationVersionException("Protocol Buffers format is only supported from v1.3.");`
`78`	`78`	`}`
`79`	`79`	`version = "1.1";`
`80`	`80`	`}`
`81`	`81`	`else if (specificationVersion == SpecificationVersion.v1_0)`
`82`	`82`	`{`
`83`		`- if (format == Format.Json)`
	`83`	`+ if (format == SerializationFormat.Json)`
`84`	`84`	`{`
`85`	`85`	`throw new UnsupportedFormatSpecificationVersionException("JSON format is only supported from v1.2.");`
`86`	`86`	`}`
`87`		`- if (format == Format.Protobuf)`
	`87`	`+ if (format == SerializationFormat.Protobuf)`
`88`	`88`	`{`
`89`	`89`	`throw new UnsupportedFormatSpecificationVersionException("Protocol Buffers format is only supported from v1.3.");`
`90`	`90`	`}`
`@@ -98,14 +98,14 @@ public static string GetMediaType(Format format, SpecificationVersion specificat`
`98`	`98`	`/// Utility method to return the CycloneDX media type for a supported <c>Format</c>.`
`99`	`99`	`/// </summary>`
`100`	`100`	`/// <param name="format">The CycloneDX format. i.e. <c>Format.Xml</c></param>`
`101`		`- public static string GetMediaType(Format format)`
	`101`	`+ public static string GetMediaType(SerializationFormat format)`
`102`	`102`	`{`
`103`	`103`	`var mediaType = Xml;`
`104`		`- if (format == Format.Json)`
	`104`	`+ if (format == SerializationFormat.Json)`
`105`	`105`	`{`
`106`	`106`	`mediaType = Json;`
`107`	`107`	`}`
`108`		`- else if (format == Format.Protobuf)`
	`108`	`+ else if (format == SerializationFormat.Protobuf)`
`109`	`109`	`{`
`110`	`110`	`mediaType = Protobuf;`
`111`	`111`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ namespace CycloneDX`
`22`	`22`	`/// <summary>`
`23`	`23`	`/// Enum of all supported CycloneDX serialization formats.`
`24`	`24`	`/// </summary>`
`25`		`- public enum Format`
	`25`	`+ public enum SerializationFormat`
`26`	`26`	`{`
`27`	`27`	`Xml,`
`28`	`28`	`Json,`