CASMCMS-8186: Corrected description of disable_components_on_completi…

…on in API spec.
Cray-HPE · Apr 19, 2024 · eb6269f · eb6269f
1 parent 9ab3f51
commit eb6269f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- Corrected description of `disable_components_on_completion` in API spec.
 
 ## [2.17.5] - 2024-04-19
 ### Changed

diff --git a/api/openapi.yaml.in b/api/openapi.yaml.in
@@ -1006,8 +1006,8 @@ components:
         disable_components_on_completion:
           type: boolean
           description: |
-            Allows for BOS Components to be marked as disabled after a Session has been completed. If false, BOS will continue to maintain the state
-            of the nodes declaratively, even after a Session finishes.
+            If true, when a Session has brought a Component to its desired state, that Component will be marked as disabled in BOS.
+            If false, BOS will continue to maintain the state of the nodes declaratively, even after a Session finishes.
         discovery_frequency:
           type: integer
           description: How frequently the BOS discovery agent syncs new Components from HSM. (in seconds)