Update cgmanifest to align with the JSON schema

[jeffhandley]

With dotnet/machinelearning#7283, we realized that the cgmanifest.json file was not aligned with the JSON schema. It is using Title case property names but it should be using camelCase property names. We also need to add a version property to the manifest.

See this comment for more detail: dotnet/machinelearning#7283 (comment)

Here's the console app I used to confirm the existing manifest isn't valid against its schema, and the updated one in this PR is valid:

usingSystem;usingSystem.Net.Http;usingSystem.Text.Json.Nodes;usingSystem.Threading.Tasks;usingJson.Schema;HttpClienthttpClient=new();stringschemaUrl="https://json.schemastore.org/component-detection-manifest.json";HttpResponseMessageschemaResponse=awaithttpClient.GetAsync(schemaUrl);schemaResponse.EnsureSuccessStatusCode();stringschemaJson=(awaitschemaResponse.Content.ReadAsStringAsync()).Replace("/draft-04/","/draft-06/");JsonSchemaschema=JsonSchema.FromText(schemaJson);string[]manifestUrls=["https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json","https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json"];foreach(varmanifestUrlinmanifestUrls){HttpResponseMessagemanifestResponse=awaithttpClient.GetAsync(manifestUrl);manifestResponse.EnsureSuccessStatusCode();stringmanifestJson=awaitmanifestResponse.Content.ReadAsStringAsync();JsonNodemanifest=JsonNode.Parse(manifestJson);varresult=schema.Evaluate(manifest);Console.WriteLine(manifestUrl);Console.WriteLine($"Valid: {result.IsValid}");}

Here's the output:

https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json
Valid: False
https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json
Valid: True

The format of the file now matches what is shown in https://docs.opensource.microsoft.com/tools/cg/component-detection/cgmanifest/.

[tarekgh]

Thanks for helping to fix it!

[jeffhandley]

/ba-g Failures are known and unrelated

[jeffhandley]

@tarekgh I dug in to understand why/how the component governance integration was still working despite the JSON document not adhering to the schema, and I was able to confirm that it was working before, and it's still working after this change. The reason it worked is that the component detection that processes these files has the JSON deserialization set up where it is recognizing either TitleCase or properCase property names.

So while it was working before, we're now adhering to the schema correctly and we won't get tripped up if the component detection ever applies stricter validation of the documents.

[jeffhandley]

With dotnet/machinelearning#7283, we realized that the cgmanifest.json file was not aligned with the JSON schema. It is using Title case property names but it should be using camelCase property names. We also need to add a version property to the manifest.

See this comment for more detail: dotnet/machinelearning#7283 (comment)

Here's the console app I used to confirm the existing manifest isn't valid against its schema, and the updated one in this PR is valid:

usingSystem;usingSystem.Net.Http;usingSystem.Text.Json.Nodes;usingSystem.Threading.Tasks;usingJson.Schema;HttpClienthttpClient=new();stringschemaUrl="https://json.schemastore.org/component-detection-manifest.json";HttpResponseMessageschemaResponse=awaithttpClient.GetAsync(schemaUrl);schemaResponse.EnsureSuccessStatusCode();stringschemaJson=(awaitschemaResponse.Content.ReadAsStringAsync()).Replace("/draft-04/","/draft-06/");JsonSchemaschema=JsonSchema.FromText(schemaJson);string[]manifestUrls=["https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json","https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json"];foreach(varmanifestUrlinmanifestUrls){HttpResponseMessagemanifestResponse=awaithttpClient.GetAsync(manifestUrl);manifestResponse.EnsureSuccessStatusCode();stringmanifestJson=awaitmanifestResponse.Content.ReadAsStringAsync();JsonNodemanifest=JsonNode.Parse(manifestJson);varresult=schema.Evaluate(manifest);Console.WriteLine(manifestUrl);Console.WriteLine($"Valid: {result.IsValid}");}

Here's the output:

https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json
Valid: False
https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json
Valid: True

The format of the file now matches what is shown in https://docs.opensource.microsoft.com/tools/cg/component-detection/cgmanifest/.

[tarekgh]

Thanks for helping to fix it!

[jeffhandley]

/ba-g Failures are known and unrelated

[jeffhandley]

@tarekgh I dug in to understand why/how the component governance integration was still working despite the JSON document not adhering to the schema, and I was able to confirm that it was working before, and it's still working after this change. The reason it worked is that the component detection that processes these files has the JSON deserialization set up where it is recognizing either TitleCase or properCase property names.

So while it was working before, we're now adhering to the schema correctly and we won't get tripped up if the component detection ever applies stricter validation of the documents.

[jeffhandley]

With dotnet/machinelearning#7283, we realized that the cgmanifest.json file was not aligned with the JSON schema. It is using Title case property names but it should be using camelCase property names. We also need to add a version property to the manifest.

See this comment for more detail: dotnet/machinelearning#7283 (comment)

Here's the console app I used to confirm the existing manifest isn't valid against its schema, and the updated one in this PR is valid:

usingSystem;usingSystem.Net.Http;usingSystem.Text.Json.Nodes;usingSystem.Threading.Tasks;usingJson.Schema;HttpClienthttpClient=new();stringschemaUrl="https://json.schemastore.org/component-detection-manifest.json";HttpResponseMessageschemaResponse=awaithttpClient.GetAsync(schemaUrl);schemaResponse.EnsureSuccessStatusCode();stringschemaJson=(awaitschemaResponse.Content.ReadAsStringAsync()).Replace("/draft-04/","/draft-06/");JsonSchemaschema=JsonSchema.FromText(schemaJson);string[]manifestUrls=["https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json","https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json"];foreach(varmanifestUrlinmanifestUrls){HttpResponseMessagemanifestResponse=awaithttpClient.GetAsync(manifestUrl);manifestResponse.EnsureSuccessStatusCode();stringmanifestJson=awaitmanifestResponse.Content.ReadAsStringAsync();JsonNodemanifest=JsonNode.Parse(manifestJson);varresult=schema.Evaluate(manifest);Console.WriteLine(manifestUrl);Console.WriteLine($"Valid: {result.IsValid}");}

Here's the output:

https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json
Valid: False
https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json
Valid: True

The format of the file now matches what is shown in https://docs.opensource.microsoft.com/tools/cg/component-detection/cgmanifest/.

[tarekgh]

Thanks for helping to fix it!

[jeffhandley]

/ba-g Failures are known and unrelated

[jeffhandley]

@tarekgh I dug in to understand why/how the component governance integration was still working despite the JSON document not adhering to the schema, and I was able to confirm that it was working before, and it's still working after this change. The reason it worked is that the component detection that processes these files has the JSON deserialization set up where it is recognizing either TitleCase or properCase property names.

So while it was working before, we're now adhering to the schema correctly and we won't get tripped up if the component detection ever applies stricter validation of the documents.

[jeffhandley]

With dotnet/machinelearning#7283, we realized that the cgmanifest.json file was not aligned with the JSON schema. It is using Title case property names but it should be using camelCase property names. We also need to add a version property to the manifest.

See this comment for more detail: dotnet/machinelearning#7283 (comment)

Here's the console app I used to confirm the existing manifest isn't valid against its schema, and the updated one in this PR is valid:

usingSystem;usingSystem.Net.Http;usingSystem.Text.Json.Nodes;usingSystem.Threading.Tasks;usingJson.Schema;HttpClienthttpClient=new();stringschemaUrl="https://json.schemastore.org/component-detection-manifest.json";HttpResponseMessageschemaResponse=awaithttpClient.GetAsync(schemaUrl);schemaResponse.EnsureSuccessStatusCode();stringschemaJson=(awaitschemaResponse.Content.ReadAsStringAsync()).Replace("/draft-04/","/draft-06/");JsonSchemaschema=JsonSchema.FromText(schemaJson);string[]manifestUrls=["https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json","https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json"];foreach(varmanifestUrlinmanifestUrls){HttpResponseMessagemanifestResponse=awaithttpClient.GetAsync(manifestUrl);manifestResponse.EnsureSuccessStatusCode();stringmanifestJson=awaitmanifestResponse.Content.ReadAsStringAsync();JsonNodemanifest=JsonNode.Parse(manifestJson);varresult=schema.Evaluate(manifest);Console.WriteLine(manifestUrl);Console.WriteLine($"Valid: {result.IsValid}");}

Here's the output:

https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json
Valid: False
https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json
Valid: True

The format of the file now matches what is shown in https://docs.opensource.microsoft.com/tools/cg/component-detection/cgmanifest/.

[tarekgh]

Thanks for helping to fix it!

[jeffhandley]

/ba-g Failures are known and unrelated

[jeffhandley]

@tarekgh I dug in to understand why/how the component governance integration was still working despite the JSON document not adhering to the schema, and I was able to confirm that it was working before, and it's still working after this change. The reason it worked is that the component detection that processes these files has the JSON deserialization set up where it is recognizing either TitleCase or properCase property names.

So while it was working before, we're now adhering to the schema correctly and we won't get tripped up if the component detection ever applies stricter validation of the documents.

[jeffhandley]

With dotnet/machinelearning#7283, we realized that the cgmanifest.json file was not aligned with the JSON schema. It is using Title case property names but it should be using camelCase property names. We also need to add a version property to the manifest.

See this comment for more detail: dotnet/machinelearning#7283 (comment)

Here's the console app I used to confirm the existing manifest isn't valid against its schema, and the updated one in this PR is valid:

usingSystem;usingSystem.Net.Http;usingSystem.Text.Json.Nodes;usingSystem.Threading.Tasks;usingJson.Schema;HttpClienthttpClient=new();stringschemaUrl="https://json.schemastore.org/component-detection-manifest.json";HttpResponseMessageschemaResponse=awaithttpClient.GetAsync(schemaUrl);schemaResponse.EnsureSuccessStatusCode();stringschemaJson=(awaitschemaResponse.Content.ReadAsStringAsync()).Replace("/draft-04/","/draft-06/");JsonSchemaschema=JsonSchema.FromText(schemaJson);string[]manifestUrls=["https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json","https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json"];foreach(varmanifestUrlinmanifestUrls){HttpResponseMessagemanifestResponse=awaithttpClient.GetAsync(manifestUrl);manifestResponse.EnsureSuccessStatusCode();stringmanifestJson=awaitmanifestResponse.Content.ReadAsStringAsync();JsonNodemanifest=JsonNode.Parse(manifestJson);varresult=schema.Evaluate(manifest);Console.WriteLine(manifestUrl);Console.WriteLine($"Valid: {result.IsValid}");}

Here's the output:

https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json
Valid: False
https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json
Valid: True

The format of the file now matches what is shown in https://docs.opensource.microsoft.com/tools/cg/component-detection/cgmanifest/.

[tarekgh]

Thanks for helping to fix it!

[jeffhandley]

/ba-g Failures are known and unrelated

[jeffhandley]

@tarekgh I dug in to understand why/how the component governance integration was still working despite the JSON document not adhering to the schema, and I was able to confirm that it was working before, and it's still working after this change. The reason it worked is that the component detection that processes these files has the JSON deserialization set up where it is recognizing either TitleCase or properCase property names.

So while it was working before, we're now adhering to the schema correctly and we won't get tripped up if the component detection ever applies stricter validation of the documents.

[jeffhandley]

With dotnet/machinelearning#7283, we realized that the cgmanifest.json file was not aligned with the JSON schema. It is using Title case property names but it should be using camelCase property names. We also need to add a version property to the manifest.

See this comment for more detail: dotnet/machinelearning#7283 (comment)

Here's the console app I used to confirm the existing manifest isn't valid against its schema, and the updated one in this PR is valid:

usingSystem;usingSystem.Net.Http;usingSystem.Text.Json.Nodes;usingSystem.Threading.Tasks;usingJson.Schema;HttpClienthttpClient=new();stringschemaUrl="https://json.schemastore.org/component-detection-manifest.json";HttpResponseMessageschemaResponse=awaithttpClient.GetAsync(schemaUrl);schemaResponse.EnsureSuccessStatusCode();stringschemaJson=(awaitschemaResponse.Content.ReadAsStringAsync()).Replace("/draft-04/","/draft-06/");JsonSchemaschema=JsonSchema.FromText(schemaJson);string[]manifestUrls=["https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json","https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json"];foreach(varmanifestUrlinmanifestUrls){HttpResponseMessagemanifestResponse=awaithttpClient.GetAsync(manifestUrl);manifestResponse.EnsureSuccessStatusCode();stringmanifestJson=awaitmanifestResponse.Content.ReadAsStringAsync();JsonNodemanifest=JsonNode.Parse(manifestJson);varresult=schema.Evaluate(manifest);Console.WriteLine(manifestUrl);Console.WriteLine($"Valid: {result.IsValid}");}

Here's the output:

https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json
Valid: False
https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json
Valid: True

The format of the file now matches what is shown in https://docs.opensource.microsoft.com/tools/cg/component-detection/cgmanifest/.

[tarekgh]

Thanks for helping to fix it!

[jeffhandley]

/ba-g Failures are known and unrelated

[jeffhandley]

@tarekgh I dug in to understand why/how the component governance integration was still working despite the JSON document not adhering to the schema, and I was able to confirm that it was working before, and it's still working after this change. The reason it worked is that the component detection that processes these files has the JSON deserialization set up where it is recognizing either TitleCase or properCase property names.

So while it was working before, we're now adhering to the schema correctly and we won't get tripped up if the component detection ever applies stricter validation of the documents.

[jeffhandley]

With dotnet/machinelearning#7283, we realized that the cgmanifest.json file was not aligned with the JSON schema. It is using Title case property names but it should be using camelCase property names. We also need to add a version property to the manifest.

See this comment for more detail: dotnet/machinelearning#7283 (comment)

Here's the console app I used to confirm the existing manifest isn't valid against its schema, and the updated one in this PR is valid:

usingSystem;usingSystem.Net.Http;usingSystem.Text.Json.Nodes;usingSystem.Threading.Tasks;usingJson.Schema;HttpClienthttpClient=new();stringschemaUrl="https://json.schemastore.org/component-detection-manifest.json";HttpResponseMessageschemaResponse=awaithttpClient.GetAsync(schemaUrl);schemaResponse.EnsureSuccessStatusCode();stringschemaJson=(awaitschemaResponse.Content.ReadAsStringAsync()).Replace("/draft-04/","/draft-06/");JsonSchemaschema=JsonSchema.FromText(schemaJson);string[]manifestUrls=["https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json","https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json"];foreach(varmanifestUrlinmanifestUrls){HttpResponseMessagemanifestResponse=awaithttpClient.GetAsync(manifestUrl);manifestResponse.EnsureSuccessStatusCode();stringmanifestJson=awaitmanifestResponse.Content.ReadAsStringAsync();JsonNodemanifest=JsonNode.Parse(manifestJson);varresult=schema.Evaluate(manifest);Console.WriteLine(manifestUrl);Console.WriteLine($"Valid: {result.IsValid}");}

Here's the output:

https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json
Valid: False
https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json
Valid: True

The format of the file now matches what is shown in https://docs.opensource.microsoft.com/tools/cg/component-detection/cgmanifest/.

[tarekgh]

Thanks for helping to fix it!

[jeffhandley]

/ba-g Failures are known and unrelated

[jeffhandley]

@tarekgh I dug in to understand why/how the component governance integration was still working despite the JSON document not adhering to the schema, and I was able to confirm that it was working before, and it's still working after this change. The reason it worked is that the component detection that processes these files has the JSON deserialization set up where it is recognizing either TitleCase or properCase property names.

So while it was working before, we're now adhering to the schema correctly and we won't get tripped up if the component detection ever applies stricter validation of the documents.

[jeffhandley]

With dotnet/machinelearning#7283, we realized that the cgmanifest.json file was not aligned with the JSON schema. It is using Title case property names but it should be using camelCase property names. We also need to add a version property to the manifest.

See this comment for more detail: dotnet/machinelearning#7283 (comment)

Here's the console app I used to confirm the existing manifest isn't valid against its schema, and the updated one in this PR is valid:

usingSystem;usingSystem.Net.Http;usingSystem.Text.Json.Nodes;usingSystem.Threading.Tasks;usingJson.Schema;HttpClienthttpClient=new();stringschemaUrl="https://json.schemastore.org/component-detection-manifest.json";HttpResponseMessageschemaResponse=awaithttpClient.GetAsync(schemaUrl);schemaResponse.EnsureSuccessStatusCode();stringschemaJson=(awaitschemaResponse.Content.ReadAsStringAsync()).Replace("/draft-04/","/draft-06/");JsonSchemaschema=JsonSchema.FromText(schemaJson);string[]manifestUrls=["https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json","https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json"];foreach(varmanifestUrlinmanifestUrls){HttpResponseMessagemanifestResponse=awaithttpClient.GetAsync(manifestUrl);manifestResponse.EnsureSuccessStatusCode();stringmanifestJson=awaitmanifestResponse.Content.ReadAsStringAsync();JsonNodemanifest=JsonNode.Parse(manifestJson);varresult=schema.Evaluate(manifest);Console.WriteLine(manifestUrl);Console.WriteLine($"Valid: {result.IsValid}");}

Here's the output:

https://raw.githubusercontent.com/dotnet/runtime/refs/heads/main/src/native/external/cgmanifest.json
Valid: False
https://raw.githubusercontent.com/jeffhandley/runtime/jeffhandley/cgmanifest/src/native/external/cgmanifest.json
Valid: True

The format of the file now matches what is shown in https://docs.opensource.microsoft.com/tools/cg/component-detection/cgmanifest/.

[tarekgh]

Thanks for helping to fix it!

[jeffhandley]

/ba-g Failures are known and unrelated

[jeffhandley]

@tarekgh I dug in to understand why/how the component governance integration was still working despite the JSON document not adhering to the schema, and I was able to confirm that it was working before, and it's still working after this change. The reason it worked is that the component detection that processes these files has the JSON deserialization set up where it is recognizing either TitleCase or properCase property names.

So while it was working before, we're now adhering to the schema correctly and we won't get tripped up if the component detection ever applies stricter validation of the documents.