added description to the endpoints in the openapi.json

.gitignore

@@ -5,3 +5,5 @@ TestResults/
 .vscode/launch.json
 .env
 venv
+public/
+/tmp/

README.md

@@ -141,23 +141,31 @@ var response = await pvClient.GetPvPowerSite("ba75-e17a-7374-95ed");
 ## API Methods
 ### LiveClient
 - `GetRadiationAndWeather`: Retrieves live solar radiation and weather data.
+- `GetAdvancedPvPower`: Retrieves advanced PV power live data.
+- `GetRooftopPvPower`: Retrieves live rooftop PV power data based on location and other parameters.
 ### ForecastClient
 - `GetForecast`: Retrieves forecast solar radiation and weather data for up to 14 days ahead.
+- `GetRadiationAndWeather`: Retrieves forecast radiation and weather data for a specified location.
+- `GetAdvancedPvPower`: Retrieves advanced PV power forecasts with customizable options.
+- `GetRooftopPvPower`: Retrieves rooftop PV power forecast data based on location and other parameters.
 ### HistoricClient
-- `GetRadiationAndWeather`: Retrieves historic solar radiation and weather data.
+- `GetRadiationAndWeather`: Retrieves historic solar radiation and weather data for a specified time range.
+- `GetAdvancedPvPower`: Retrieves advanced PV power historical data.
+- `GetRooftopPvPower`: Retrieves rooftop PV power historical data.
 ### TmyClient
-- `GetRadiationAndWeather`: Retrieves TMY (Typical Meteorological Year) irradiance and weather data.
-- `GetRooftopPvPower`: Retrieves TMY rooftop PV power estimated actuals.
+- `GetRadiationAndWeather`: Retrieves TMY irradiance and weather data for a specified location.
+- `GetAdvancedPvPower`: Retrieves advanced PV power TMY data.
+- `GetRooftopPvPower`: Retrieves TMY rooftop PV power data.
 ### AggregationClient
 - `GetLiveAggregation`: Retrieves live grid aggregation data for up to 7 days.
 - `GetForecastAggregation`: Retrieves forecast grid aggregation data for up to 7 days.
 ### PvPowerSitesClient
-- `ListPvPowerSites`: Retrieves a list of available PV Power Sites.
-- `GetPvPowerSite`: Retrieves metadata for a specific PV Power Site.
-- `CreatePvPowerSite`: Creates a new PV Power Site for use with advanced solar power modeling.
-- `PatchPvPowerSite`: Partially updates the metadata for an existing PV Power Site.
-- `UpdatePvPowerSite`: Overwrites the metadata for an existing PV Power Site.
-- `DeletePvPowerSite`: Deletes an existing PV Power Site.
+- `GetPvPowerSites`: Retrieves a list of all available PV power sites.
+- `GetPvPowerSite`: Retrieves metadata for a specific PV power site by its resource ID.
+- `PostPvPowerSite`: Creates a new PV Power Site for use with advanced PV power model.
+- `PatchPvPowerSite`: Partially updates the specifications of an existing PV power site.
+- `PutPvPowerSite`: Overwrites an existing PV power site specifications.
+- `DeletePvPowerSite`: Deletes an existing PV power site.
 
 
 ## Contributing
@@ -168,6 +176,11 @@ To generate the sdk from the openapi specs run:
 python3 generate_sdk_csharp.py
 ```
 
+To generate the documentation run:
+```bash
+python3 generate_sdk_docs.py [--use-cache]
+```
+
 ## Running Tests
 To run the tests, use the following command:
 ```bash

docs/index.md

@@ -1,6 +1,6 @@
 # Welcome to Solcast
 
-A simple C# SDK that wraps [Solcast's API](https://docs.solcast.com.au/).
+C# SDK that wraps [Solcast's API](https://docs.solcast.com.au/).
 
 ## Install
 
@@ -55,14 +55,14 @@ For more detailed documentation, visit the following pages:
 
 | Module           | API Docs                                 |
 |------------------|------------------------------------------|
-| `live`           | [Solcast.Clients.LiveClient](live.md) |
-| `historic`       | [Solcast.Clients.HistoricClient](historic.md) |
-| `forecast`       | [Solcast.Clients.ForecastClient](forecast.md) |
-| `tmy`            | [Solcast.Clients.TmyClient](tmy.md) |
-| `pv_power_sites` | [Solcast.Clients.PvPowerSitesClient](pv_power_sites.md) |
-| `aggregations`   | [Solcast.Clients.AggregationClient](aggregations.md) |
+| `Live`           | [Solcast.Clients.LiveClient](live.md) |
+| `Historic`       | [Solcast.Clients.HistoricClient](historic.md) |
+| `Forecast`       | [Solcast.Clients.ForecastClient](forecast.md) |
+| `TMY`            | [Solcast.Clients.TmyClient](tmy.md) |
+| `PV Power Sites` | [Solcast.Clients.PvPowerSiteClient](pvpowersite.md) |
+| `Aggregations`   | [Solcast.Clients.AggregationClient](aggregation.md) |
 
 
 ## API Documentation
-For more detailed information about the Solcast API, please visit the official API documentation.
+For more detailed information about the Solcast API, please visit the official [API documentation](http://docs.solcast.com.au).
 

generate_sdk_csharp.py

@@ -250,7 +250,7 @@ def generate_csharp_method_with_usings(endpoint, method, parameters, spec, respo
     # Generate XML comments for the method
     method_description = spec.get('paths', {}).get(endpoint, {}).get(method, {}).get('description', "")
     xml_comment = generate_xml_comment(method_description)
-    param_comments = "\n\n"
+    param_comments = "\n"
     for param in parameters:
         param_name = to_camel_case(param['name'])
         param_description = param.get('description', "")
@@ -406,10 +406,12 @@ def generate_solcast_urls_class_from_spec(endpoint_details):
 
 
 def generate_xml_comment(description):
-    """Generate an XML comment from a description string."""
+    """Generate an XML comment from a multi-line description string with each line prefixed by ///."""
     if description:
-        return f"\n    /// <summary>\n    /// {description}\n    /// </summary>\n"
-    return ""
+        # Split the description into lines and prefix each with "///"
+        comment_lines = "\n".join(f"        /// {line}" for line in description.splitlines())
+        return f"\n\n        /// <summary>\n{comment_lines}\n        /// </summary>"
+    return "\n"
 
 
 # Generate Models for Requests and Responses