[Feature Contribution]: Remove JSON examples from WebAPI container

[YaSuenag]

What happened?

I'd like to propose to remove following JSON files from WebAPI container:

• /app/data-sources/json/test-data-azure-emissions.json
• /app/data-sources/json/test-data-aws-emissions.json
• /app/location-sources/json/azure-regions.json
• /app/appsettings.json

They are example files to try WebAPI easily, I think. But they are not necessary in the container use case because container user should set their account for backend services (e.g. Electricity Maps, WattTime) and location config. If they exist in container, the user might not be aware soon their wrong when some configurations are missed.

Code of Conduct

• I agree to follow this project's Code of Conduct

Feature Commitment

• I commit to contributing this feature as a PR and working with the GSF to merge this feature into the Carbon Aware SDK.

[jacksorjacksor]

As a user who's experimenting with implementing POC instances of Carbon Aware SDK I feel the sample data should be there to confirm first-instance usage (i.e. I want to focus on deploying and ensuring I can get a result, once I've done that I can change the data source to be WattTime/Electricity Maps).

So I personally wouldn't want the sample data to be removed.

[YaSuenag]

AFAIK RDBMS container (e.g. PostgreSQL) does not contain sample data. So it is nature not to contain them in WebAPI container IMHO.

If you want to confirm your deployment status, you can use healthcheck endpoint (/health).
If you want to try to use the SDK, you should configure with sample data, and it should be documented (maybe it is better to be described into quickstart.md, but it has been not yet.

I agree that sample data is useful to try to the SDK, so they should keep in the repo. I just want to say they should be removed from WebAPI container.

[jacksorjacksor]

@YaSuenag fair enough! Thanks for the clarification.

[YaSuenag]

Further investigation, I think it is better to do following things rather than just remove JSON files from WebAPI container. I will send PR if we can make agreement.

About appsettings.json, we need to remove following lines:

carbon-aware-sdk/src/CarbonAware.WebApi/src/appsettings.json

Lines 2 to 11 in d8247a2

	"DataSources": {
	"EmissionsDataSource": "test-json",
	"ForecastDataSource": "", // We don't currently publish a sample test data source for forecasts.
	"Configurations": {
	"test-json": {
	"Type": "JSON",
	"DataFileLocation": "test-data-azure-emissions.json"
	}
	}
	},

In addirtion, it might be better to remove both location JSON and emission data JSON from packaging item:

carbon-aware-sdk/src/GSF.CarbonAware/src/GSF.CarbonAware.csproj

Lines 52 to 53 in d8247a2

	<Content Include="$(TargetDir)/data-sources/**/*.json" Pack="true" PackagePath="data-sources/" />
	<Content Include="$(TargetDir)/location-sources/**/*.json" Pack="true"

However some files depend on test-data-azure-emissions.json - I think we should remove these dependencies.

carbon-aware-sdk/src/CarbonAware.DataSources/CarbonAware.DataSources.Json/src/Configuration/JsonDataSourceConfiguration.cs

Line 12 in d8247a2

private const string DefaultDataFile = "test-data-azure-emissions.json";

carbon-aware-sdk/src/CarbonAware.WebApi/src/carbon-aware.json

Lines 14 to 16 in d8247a2

	"CarbonAwareStaticJsonDataService": {
	"data-file": "data-files/test-data-azure-emissions.json"
	},

[github-actions]

This issue has not had any activity in 120 days. Please review this issue and ensure it is still relevant. If no more activity is detected on this issue for the next 20 days, it will be closed automatically.

[YaSuenag]

Wait! I've sent PR for this issue: #450

[github-actions]

This issue has not had any activity in 120 days. Please review this issue and ensure it is still relevant. If no more activity is detected on this issue for the next 20 days, it will be closed automatically.