Addressed review comments

trolie · Oct 16, 2024 · 2b74e07 · 2b74e07
1 parent e417b19
commit 2b74e07
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/docs/_data/paths/limits_forecast-snapshot.yaml b/docs/_data/paths/limits_forecast-snapshot.yaml
@@ -112,15 +112,22 @@ regional:
     description: |
     
       Similar to [getLimitsForecastSnapshot](#tag/Forecasting/operation/getLimitsForecastSnapshot), 
-      except that it specifically returns only the latest **regionally** limiting ratings
+      except that it specifically returns only the latest **regionally** limiting ratings 
+      ([RLRs](https://trolie.energy/concepts#regionally-limiting-rating))
       used by the Transmission Provider.  
 
       This is explicitly designed to be used when reconciling forecasts between Transmission Providers
-      in order to generate globally limiting ratings for general use.  See the article on 
+      in order to generate globally limiting ratings ([GLRs](https://trolie.energy/concepts#globally-limiting-rating))
+      for general use.  See the article on 
       [RC-to-RC Reconciliation](https://trolie.energy/articles/RC-to-RC-reconciliation.html) for more details.
 
       Outside of this use case, most users should use
       [getLimitsForecastSnapshot](#tag/Forecasting/operation/getLimitsForecastSnapshot) to get globally
       limiting ratings.  
 
+      Clients SHOULD perform Conditional `GET` using the `If-None-Match` header
+      and the `ETag` of a previous `GET` response to poll this endpoint. Rate
+      limiting is done on a per Ratings Provider basis, so requests from
+      independent clients used by the same provider count against the same quota.          
+
     responses: *responses   
diff --git a/docs/_data/paths/limits_realtime-snapshot.yaml b/docs/_data/paths/limits_realtime-snapshot.yaml
@@ -66,16 +66,23 @@ regional:
 
       Similar to [getRealTimeLimits](#tag/Real-Time/operation/getRealTimeLimits), 
       except that it specifically returns only the latest **regionally** limiting ratings
+      ([RLRs](https://trolie.energy/concepts#regionally-limiting-rating))
       used by the Transmission Provider.  
 
       This is explicitly designed to be used when reconciling real-time ratings between Transmission Providers
-      in order to generate globally limiting ratings for general use.  See the article on 
+      in order to generate globally limiting ratings ([GLRs](https://trolie.energy/concepts#globally-limiting-rating)) 
+      for general use.  See the article on 
       [RC-to-RC Reconciliation](https://trolie.energy/articles/RC-to-RC-reconciliation.html) for more details.
 
       Outside of this use case, most users should use
       [getRealTimeLimits](#tag/Real-Time/operation/getRealTimeLimits) to get globally
       limiting ratings.  
 
+      Clients SHOULD perform Conditional `GET` using the `If-None-Match` header
+      and the `ETag` of a previous `GET` response to poll this endpoint. Rate
+      limiting is done on a per Ratings Provider basis, so requests from
+      independent clients used by the same provider count against the same quota.      
+
 
     summary: Regional Limits Real Time Snapshot
     tags: