clarify changelog and api spec

ASFHyP3 · Nov 12, 2024 · 82cc413 · 82cc413
1 parent 3872d8b
commit 82cc413
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,8 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [9.0.0]
 
 ### Changed
-- A job's `processing_times` field is now set to `null` rather than `[]` if there was an error while calculating processing times. As before, an error while calculating processing times causes the job to fail.
-- There is no longer any attempt to calculate `processing_times` for failed jobs. All failed jobs now have a `processing_times` value of `null`.
+- All failed jobs now have a `processing_times` value of `null`.
 - The processing time value for each processing step must now be greater than zero. (Previously, a value of zero indicated that the processing step had no AWS Batch attempts.)
 
 ### Fixed

diff --git a/apps/api/src/hyp3_api/api-spec/openapi-spec.yml.j2 b/apps/api/src/hyp3_api/api-spec/openapi-spec.yml.j2
@@ -409,7 +409,7 @@ components:
     processing_times:
       description: >
         List of run times for the job's processing steps in the order that they were executed.
-        A null value indicates that the job failed.
+        This field is null for failed jobs and non-null for successful jobs.
       type: array
       nullable: true
       items: