override-reason -> reason

trolie · Nov 5, 2024 · cd5fa4c · cd5fa4c
1 parent 85e9088
commit cd5fa4c
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 16 deletions.
diff --git a/docs/_data/components/schemas/time-bound-static-ratings.yaml b/docs/_data/components/schemas/time-bound-static-ratings.yaml
@@ -19,7 +19,7 @@ temporary-aar-exception-request: &time-bound-static-rating
       $ref: ./limit.yaml
     emergency-operating-limits:
       $ref: ./array-max-emergency-durations.yaml#/limit-value-set
-    reason:
+    reason: &reason
       description: |
         Free-form text indicating the reason for the exception.
       type: string
@@ -63,20 +63,15 @@ operator-override-limit-provenance:
   <<: *time-bound-static-limit
   properties:
     <<: *time-bound-static-limit-props
-    override-reason:
-      type: string
-      description:
-
-        Indicates that this limit was overridden for some reason, the reason
-        itself.
-
-      format: free-text
-      maxLength: 500
+    reason:
+      <<: *reason
+      description: |
+        The reason given for the limit override.
   required:
     - start-time
     - continuous-operating-limit
     - emergency-operating-limits
-    - override-reason
+    - reason
 
 seasonal-override-request:
   <<: *time-bound-static-rating

diff --git a/docs/articles/limit-provenance.md b/docs/articles/limit-provenance.md
@@ -244,7 +244,7 @@ an override was in place for the given period.
         "mva": 160
       },
       "emergency-operating-limits": [ /* elided for clarity */ ],
-      "override-reason": "TOI 20250701-01",
+      "reason": "TOI 20250701-01",
       "start-time": "2025-07-12T16:00:00-07:00",
       "end-time":   "2025-09-12T16:00:00-07:00", // optional
       "id": "ems-operator-override-id-1", // optional

diff --git a/docs/example-narratives/examples/forecast-limits-detailed-elide-names-header.json b/docs/example-narratives/examples/forecast-limits-detailed-elide-names-header.json
@@ -128,7 +128,7 @@
                             "limit": { "mva": 165 }
                         }
                     ],
-                    "override-reason": "TOI 20250701-01",
+                    "reason": "TOI 20250701-01",
                     "start-time": "2025-07-01T00:00:00-07:00"
                 }
             ]

diff --git a/docs/example-narratives/examples/forecast-limits-detailed.json b/docs/example-narratives/examples/forecast-limits-detailed.json
@@ -144,7 +144,7 @@
                             "limit": { "mva": 165 }
                         }
                     ],
-                    "override-reason": "TOI 20250701-01",
+                    "reason": "TOI 20250701-01",
                     "start-time": "2025-07-01T00:00:00-07:00"
                 }
             ]

diff --git a/docs/example-narratives/examples/realtime-limit-set-detailed-elide-psr.json b/docs/example-narratives/examples/realtime-limit-set-detailed-elide-psr.json
@@ -171,7 +171,7 @@
               }
             }
           ],
-          "override-reason": "TOI 20250701-01",
+          "reason": "TOI 20250701-01",
           "start-time": "2025-07-01T00:00:00-07:00"
         }
       ]

diff --git a/docs/example-narratives/examples/realtime-limit-set-detailed.json b/docs/example-narratives/examples/realtime-limit-set-detailed.json
@@ -187,7 +187,7 @@
               }
             }
           ],
-          "override-reason": "TOI 20250701-01",
+          "reason": "TOI 20250701-01",
           "start-time": "2025-07-01T00:00:00-07:00"
         }
       ]
-Original file line number
+Diff line change
@@ Expand Up / @@ -171,7 +171,7 @@ @@
                   }
                 }
               ],
-              "override-reason": "TOI 20250701-01",
+              "reason": "TOI 20250701-01",
               "start-time": "2025-07-01T00:00:00-07:00"
             }
           ]
@@ Expand Down @@