diff --git a/CHANGES.md b/CHANGES.md index 6f2fb31d..ee8cf8cb 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -2,6 +2,10 @@ This document describes the relevant changes between releases of the API model. +## 0.0.402 Nov 15 2024 +- Add WifConfig status endpoint +- Add `WifConfigStatus` model + ## 0.0.401 Oct 31 2024 - Add settings for HCP Shared VPC to `Cluster` model - Add support for cluster arch to `DNS` model diff --git a/model/clusters_mgmt/v1/wif_config_resource.model b/model/clusters_mgmt/v1/wif_config_resource.model index a00712bb..3698ed8c 100644 --- a/model/clusters_mgmt/v1/wif_config_resource.model +++ b/model/clusters_mgmt/v1/wif_config_resource.model @@ -26,4 +26,8 @@ resource WifConfig { // Dry run flag is used to check if the operation can be completed, but won't delete. in DryRun Boolean = false } + + locator Status { + target WifConfigStatus + } } diff --git a/model/clusters_mgmt/v1/wif_config_status_resource.model b/model/clusters_mgmt/v1/wif_config_status_resource.model new file mode 100644 index 00000000..2d265908 --- /dev/null +++ b/model/clusters_mgmt/v1/wif_config_status_resource.model @@ -0,0 +1,22 @@ +/* +Copyright (c) 2024 Red Hat, Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Retrieves the details of the WifConfig status. +resource WifConfigStatus { + method Get { + out Body WifConfigStatus + } +} diff --git a/model/clusters_mgmt/v1/wif_config_status_type.model b/model/clusters_mgmt/v1/wif_config_status_type.model new file mode 100644 index 00000000..909bf6b3 --- /dev/null +++ b/model/clusters_mgmt/v1/wif_config_status_type.model @@ -0,0 +1,27 @@ +/* +Copyright (c) 2024 Red Hat, Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Configuration status of a WifConfig. +struct WifConfigStatus { + // Indicates the current status of the WifConfig resource configuration. + // - `false`: The WifConfig resource has a user configuration error. + // - `true`: The resources associated with the WifConfig object are properly configured and operational at the time of the check. + Configured Boolean + // Provides additional information about the WifConfig resource status. + // - When `Configured` is `false`, this field contains details about the user configuration error. + // - When `Configured` is `true`, this field may be empty or contain optional notes about the configuration. + Description String +}