From eb6269f493e2ee8b779921be847e202ec99d993c Mon Sep 17 00:00:00 2001 From: "Mitch Harding (the weird one)" Date: Fri, 19 Apr 2024 14:19:13 -0400 Subject: [PATCH] CASMCMS-8186: Corrected description of disable_components_on_completion in API spec. --- CHANGELOG.md | 2 ++ api/openapi.yaml.in | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 15c066be..02f6e21a 100644 --- 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 index f0b1ca98..c913df56 100644 --- 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)