Added conditional get disclaimer consistently to snapshot descriptions

trolie · Jun 28, 2024 · 378c14a · 378c14a
1 parent 86edffb
commit 378c14a
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -240,7 +240,7 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rexml (3.3.0)
+    rexml (3.3.1)
       strscan
     rouge (3.26.0)
     rubyzip (2.3.2)

diff --git a/docs/_data/paths/limits_forecast-snapshot.yaml b/docs/_data/paths/limits_forecast-snapshot.yaml
@@ -12,16 +12,21 @@ get:
   description: |
 
     Obtain the Limits Forecast the Transmission Provider is currently using in
-    Operations, relative to the current time. Clients SHOULD perform Conditional
-    `GET` using the `If-None-Match` header and the `ETag` of a previous `GET`
-    response. This operation uses media types to control verbosity of the data
+    Operations, relative to the current time. 
+    
+    This operation uses media types to control verbosity of the data
     fetched. The default media type,
     `application/vnd.trolie.forecast-limits-snapshot.v1+json`, simply includes
     the rating data. For applications that need it, the media type
     `application/vnd.trolie.forecast-limits-detailed-snapshot.v1+json` may be
     requested, which also references the source proposals used to generate the
     snapshot, as well as reporting data from the ratings clearing process.
 
+    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:
     '200':
       description: The requested operating forecast snapshot is returned.

diff --git a/docs/_data/paths/limits_realtime-snapshot.yaml b/docs/_data/paths/limits_realtime-snapshot.yaml
@@ -3,8 +3,11 @@ get:
   description: |
 
     Obtain the System Operating Limits in-use by the Transmission Provider.
+
     Clients SHOULD perform Conditional `GET` using the `If-None-Match` header
-    and the `ETag` of a previous `GET` response.
+    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: Limits Real Time Snapshot
   tags: