refactoring: move proposal into max-monitored-elements

trolie · Feb 4, 2024 · f5ff480 · f5ff480
1 parent 8161687
commit f5ff480
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 44 deletions.
diff --git a/docs/_data/components/schemas/array-max-monitored-elements.yaml b/docs/_data/components/schemas/array-max-monitored-elements.yaml
@@ -48,4 +48,30 @@ seasonal-rating-proposal:
         ratings:
           <<: *max
           items:
-            $ref: 'array-max-seasons.yaml#/seasonal-proposals'
+            $ref: 'array-max-seasons.yaml#/seasonal-proposals'
+
+missing-forecast-rating-set:
+  <<: *max
+  description: A set of Missing Forecasted Ratings for a Forecast Window
+  items:
+    $ref: 'array-max-forecast-periods.yaml#/missing-forecast'
+
+realtime-ratings-proposals:
+  <<: *max
+  description: Real-Time Ratings Proposals
+  items:
+    $ref: 'array-max-forecast-periods.yaml#/realtime-rating-proposal'
+
+forecast-rating-proposal:
+  type: object
+  properties:
+    forecast-header:
+      $ref: ./rating-proposal-header.yaml
+    ratings:
+      <<: *max
+      description: Forecasted Ratings
+      items:
+        $ref: 'array-max-forecast-periods.yaml#/forecast-proposal-for-segment'
+  required:
+    - forecast-header
+    - ratings
diff --git a/docs/_data/components/schemas/array-max-monitoring-sets.yaml b/docs/_data/components/schemas/array-max-monitoring-sets.yaml
diff --git a/docs/_data/paths/rating-proposals_forecasts.yaml b/docs/_data/paths/rating-proposals_forecasts.yaml
@@ -34,7 +34,7 @@ get:
       content:
         application/vnd.trolie.rating-forecast-proposal.v1+json:
           schema: &forecast-rating-proposal
-            $ref: ../components/schemas/array-max-monitoring-sets.yaml#/forecast-rating-proposal
+            $ref: ../components/schemas/array-max-monitored-elements.yaml#/forecast-rating-proposal
           example:
             forecast-header:
               last-updated: '2023-07-12T15:05:43.044267100-07:00'

diff --git a/docs/_data/paths/rating-proposals_forecasts_{ratings-provider}.yaml b/docs/_data/paths/rating-proposals_forecasts_{ratings-provider}.yaml
@@ -16,7 +16,7 @@ get:
       content:
         application/vnd.trolie.rating-forecast-proposal.v1+json:
           schema: &forecast-rating-proposal
-            $ref: ../components/schemas/array-max-monitoring-sets.yaml#/forecast-rating-proposal
+            $ref: ../components/schemas/array-max-monitored-elements.yaml#/forecast-rating-proposal
           example:
             forecast-header:
               last-updated: '2023-07-12T15:05:43.044267100-07:00'

diff --git a/docs/_data/paths/rating-proposals_missing_forecasts.yaml b/docs/_data/paths/rating-proposals_missing_forecasts.yaml
@@ -34,14 +34,14 @@ get:
       content:
         application/vnd.trolie.missing-forecast-rating-set.v1+json:
           schema:
-            $ref: "../components/schemas/array-max-monitoring-sets.yaml#/missing-forecast-rating-set"
+            $ref: "../components/schemas/array-max-monitored-elements.yaml#/missing-forecast-rating-set"
           example:
             - segment-id: segmentX
               periods:
                 - '2023-07-12T16:00:00-07:00'
         application/json:
           schema:
-            $ref: "../components/schemas/array-max-monitoring-sets.yaml#/missing-forecast-rating-set"
+            $ref: "../components/schemas/array-max-monitored-elements.yaml#/missing-forecast-rating-set"
       headers:
         $ref: '../openapi-split.yaml#/components/responses/200/headers'
 

diff --git a/docs/_data/paths/rating-proposals_missing_forecasts_{ratings-provider}.yaml b/docs/_data/paths/rating-proposals_missing_forecasts_{ratings-provider}.yaml
@@ -35,14 +35,14 @@ get:
       content:
         application/vnd.trolie.missing-forecast-rating-set.v1+json:
           schema:
-            $ref: "../components/schemas/array-max-monitoring-sets.yaml#/missing-forecast-rating-set"
+            $ref: "../components/schemas/array-max-monitored-elements.yaml#/missing-forecast-rating-set"
           example:
             - segment-id: segmentX
               periods:
                 - '2023-07-12T16:00:00-07:00'
         application/json:
           schema:
-            $ref: "../components/schemas/array-max-monitoring-sets.yaml#/missing-forecast-rating-set"
+            $ref: "../components/schemas/array-max-monitored-elements.yaml#/missing-forecast-rating-set"
       headers:
         $ref: '../openapi-split.yaml#/components/responses/200/headers'
 

diff --git a/docs/_data/paths/rating-proposals_realtime.yaml b/docs/_data/paths/rating-proposals_realtime.yaml
@@ -30,11 +30,10 @@ get:
       description: OK
       content:
         application/vnd.trolie.realtime-rating-proposal-set.v1+json:
-          schema:
-            $ref: "../components/schemas/array-max-monitoring-sets.yaml#/realtime-ratings-proposals"
+          schema: &realtime-ratings-proposals
+            $ref: "../components/schemas/array-max-monitored-elements.yaml#/realtime-ratings-proposals"
         application/json:
-          schema:
-            $ref: "../components/schemas/array-max-monitoring-sets.yaml#/realtime-ratings-proposals"
+          schema: *realtime-ratings-proposals
       headers:
         $ref: '../openapi-split.yaml#/components/responses/200/headers'